xref: /freebsd/sys/conf/NOTES (revision 3c90d1ea7492e90a0d4d45bbb682a65a55362d78)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9b147fcf9SBruce Evans# Lines that begin with 'hint.' are NOT for config(8), they go into your
10f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
536a8d6623SGarrett Wollman#
547bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
55503e6666SBruce Evans# generated Makefile in the build area.
56503e6666SBruce Evans#
57503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
58503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
591c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
60503e6666SBruce Evans#
61503e6666SBruce Evans# DEBUG happens to be magic.
627bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
637bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
647bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
657bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
667bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
677bf01a14SPeter Wemm#
682c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
692c8635c6SPeter Wemm# kernel.
702c8635c6SPeter Wemm#
710e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
720e3d06b1SWarner Losh#
73503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
745895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
752c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
76f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
77f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
78fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
79fa75a3c2SPoul-Henning Kamp
803236b30eSGreg Lehey#
81480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
82480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
83480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
84480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
85480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
86480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
87480c6b8aSGreg Lehey#
88480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
89480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
90480c6b8aSGreg Lehey#     further by changing the parameters:
913236b30eSGreg Lehey#
92480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
93480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
94480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
95a59d364aSMatthew Dillon#
96480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
97480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
98480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
993236b30eSGreg Lehey#
100480c6b8aSGreg Lehey
1013236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1023236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1033236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1043236b30eSGreg Lehey
1053236b30eSGreg Lehey#
106a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1073c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
108a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1098b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
110a59d364aSMatthew Dillon#
111a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
112a59d364aSMatthew Dillon
113f9fbd1a4SMatt Jacob#
114f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
115f9fbd1a4SMatt Jacob#
116f9fbd1a4SMatt Jacob# These are the max and default 'raw' I/O block device access sizes.
117f9fbd1a4SMatt Jacob# Reads and writes will be split into DFLTPHYS chunks. Some applications
118f9fbd1a4SMatt Jacob# have better performance with larger raw I/O access sizes. Typically
119f9fbd1a4SMatt Jacob# MAXPHYS should be twice the size of DFLTPHYS. Note that certain VM
120f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
121f9fbd1a4SMatt Jacob# can make an an unbootable kernel.
122f9fbd1a4SMatt Jacob#
123f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
124f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
125f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
126f9fbd1a4SMatt Jacob
127f9fbd1a4SMatt Jacob
128827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
129827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
130ffd41c98SDoug Barton#    strings -n 3 /boot/kernel/kernel | sed -n 's/^___//p' > MYKERNEL
131827d623eSJordan K. Hubbard#
132827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
133827d623eSJordan K. Hubbard
134069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
135069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
136069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1375d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1387226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1395ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
14022db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1417226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
142f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
143e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
144069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1458a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
146e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1477dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1481d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1491d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
1506bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
151069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
152e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
153560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1547dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
155069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
15675261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
157f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
158069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1591c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1607b03a440SPoul-Henning Kamp
1618b140d57SMike Smith#
1628b140d57SMike Smith# The root device and filesystem type can be compiled in;
1638b140d57SMike Smith# this provides a fallback option if the root device cannot
1643b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1658b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1668b140d57SMike Smith#
1678b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1688b140d57SMike Smith
1696a8d6623SGarrett Wollman
1706a8d6623SGarrett Wollman#####################################################################
171f5d05ac3SJeff Roberson# Scheduler options:
172f5d05ac3SJeff Roberson#
173a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
174f5d05ac3SJeff Roberson# select which scheduler is compiled in.
175f5d05ac3SJeff Roberson#
176f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1771c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
178f5d05ac3SJeff Roberson# good interactivity and priority selection.
179f5d05ac3SJeff Roberson#
180bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
181bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
182bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
183bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
184bd675f58SJeff Roberson# will eventually become the default scheduler.
185f5d05ac3SJeff Roberson#
186b998bd92SJeff Robersonoptions 	SCHED_4BSD
187b998bd92SJeff Roberson#options 	SCHED_ULE
188f5d05ac3SJeff Roberson
189f5d05ac3SJeff Roberson#####################################################################
190477a642cSPeter Wemm# SMP OPTIONS:
191477a642cSPeter Wemm#
192477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
193477a642cSPeter Wemm
194477a642cSPeter Wemm# Mandatory:
195477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
196477a642cSPeter Wemm
1972498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
1982498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
199701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
200701f1408SScott Long# to disable it.
201701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2022498cf8cSJohn Baldwin
203cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
204cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
205cd6e6e4eSJohn Baldwin# CPU.  This behaviour is enabled by default, so this option can be used
206cd6e6e4eSJohn Baldwin# to disable it.
207cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
208cd6e6e4eSJohn Baldwin
2094e7f640dSJohn Baldwin# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread
2104e7f640dSJohn Baldwin# that currently owns the lock is executing on another CPU.  Note that
2114e7f640dSJohn Baldwin# in addition to enabling this option, individual sx locks must be
2124e7f640dSJohn Baldwin# initialized with the SX_ADAPTIVESPIN flag.
2134e7f640dSJohn Baldwinoptions 	ADAPTIVE_SX
2144e7f640dSJohn Baldwin
215ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
216ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
217ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
218cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
219ad27c4c7SJohn Baldwin# and WITNESS options.
220ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
221ad27c4c7SJohn Baldwin
2221a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2231a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2241a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
225cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2261a5d9b15SJohn Baldwin# and WITNESS options.
2271a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2281a5d9b15SJohn Baldwin
2294e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2304e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2314e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2324e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2334e7f640dSJohn Baldwin# and WITNESS options.
2344e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2354e7f640dSJohn Baldwin
2361fe4c660SJohn Baldwin# SMP Debugging Options:
2371fe4c660SJohn Baldwin#
2389923b511SScott Long# PREEMPTION allows the threads that are in the kernel to be preempted
2399923b511SScott Long#	  by higher priority threads.  It helps with interactivity and
2409923b511SScott Long#	  allows interrupt threads to run sooner rather than waiting.
24167ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2420c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2438c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2440c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2450c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2460c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2479923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
248ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
249ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
250ef0ebfc3SJohn Baldwin#	  used to hold active sleep queues.
251ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
252ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
253aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2541fe4c660SJohn Baldwin#         during locking operations.
255e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2563c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
257660d1e3aSJohn Baldwin#	  sleep.
258660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2599923b511SScott Longoptions 	PREEMPTION
2600c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
261ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2621fe4c660SJohn Baldwinoptions 	WITNESS
263e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
264660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2651fe4c660SJohn Baldwin
266cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
26707dba937SKip Macyoptions 	LOCK_PROFILING
26800096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
26900096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
27000096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
27100096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2724db0d7f1SDag-Erling Smørgrav
273ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
274ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
275ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
276ef0ebfc3SJohn Baldwin
277477a642cSPeter Wemm
278477a642cSPeter Wemm#####################################################################
2796a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
280690f540cSAndrey A. Chernov
2816a8d6623SGarrett Wollman#
2826a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
28356c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2847bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2857bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2867bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2877bbf05a2SJuli Mallett# signal delivery mechanism.
2886a8d6623SGarrett Wollman#
2895895e3c8SPeter Wemmoptions 	COMPAT_43
2906a8d6623SGarrett Wollman
291d3e64681SPoul-Henning Kamp# Old tty interface.
292d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
293d3e64681SPoul-Henning Kamp
294f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
295f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
296f0eb293eSAlfred Perlstein
297a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
298a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
299a01b4125SKen Smith
3006c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3016c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3026c9fdda7SRuslan Ermilov
3036a8d6623SGarrett Wollman#
3046a8d6623SGarrett Wollman# These three options provide support for System V Interface
3056a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3066a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3076a8d6623SGarrett Wollman#
3086a8d6623SGarrett Wollmanoptions 	SYSVSHM
3096a8d6623SGarrett Wollmanoptions 	SYSVSEM
3106a8d6623SGarrett Wollmanoptions 	SYSVMSG
3116a8d6623SGarrett Wollman
3126a8d6623SGarrett Wollman
3136a8d6623SGarrett Wollman#####################################################################
3146a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3156a8d6623SGarrett Wollman
3166a8d6623SGarrett Wollman#
317e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3186a8d6623SGarrett Wollman#
319e2ee2173SMarcel Moolenaaroptions 	KDB
320b5d89ca8SBruce Evans
321b5d89ca8SBruce Evans#
322e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3237085e708SBruce Evans#
324e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
325e2ee2173SMarcel Moolenaar
326e2ee2173SMarcel Moolenaar#
327e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
328e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
329e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
330e2ee2173SMarcel Moolenaar#
331e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
332e2ee2173SMarcel Moolenaar
333e2ee2173SMarcel Moolenaar#
334e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
335e2ee2173SMarcel Moolenaar#
336e2ee2173SMarcel Moolenaaroptions 	DDB
3377085e708SBruce Evans
3387085e708SBruce Evans#
339bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
340bfdd261eSBruce Evans# representation.
341bfdd261eSBruce Evans#
342bfdd261eSBruce Evansoptions 	DDB_NUMSYM
343bfdd261eSBruce Evans
344bfdd261eSBruce Evans#
345e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3460be15decSJohn Baldwin#
347e2ee2173SMarcel Moolenaaroptions 	GDB
348562d05dfSPaul Traina
349562d05dfSPaul Traina#
350df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
351df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3521c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
353df970488SRobert Watson# interfere with serial console operation.
354df970488SRobert Watson#
355df970488SRobert Watsonoptions 	SYSCTL_DEBUG
356df970488SRobert Watson
357df970488SRobert Watson#
358e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
359e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
360e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
361e4eb384bSBosko Milekic#
362e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
363e4eb384bSBosko Milekic
364e4eb384bSBosko Milekic#
365847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
366847a2a17SPawel Jakub Dawidek# malloc(9).
367847a2a17SPawel Jakub Dawidek#
368847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
369847a2a17SPawel Jakub Dawidek
370847a2a17SPawel Jakub Dawidek#
371ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
372ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
373ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
374ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
375ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
376ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
377ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
3786a8d6623SGarrett Wollman#
3792365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
380ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
38121c64a07SAndrey A. Chernov
3826a8d6623SGarrett Wollman#
383a7bebf90SKris Kennaway# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently
384a7bebf90SKris Kennaway# it has no userland interface aside from a few sysctl's.  It is
385a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
386a7bebf90SKris Kennaway# entries in the circular trace buffer; it must be a power of two.
387a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
388a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
389a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
390a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
3911c9c6382SRuslan Ermilov# events, with bit X corresponding to CPU X.  KTR_VERBOSE enables
392a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
393a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
394a7bebf90SKris Kennaway# if KTR_VERBOSE is not defined.
395c508c1b6SJohn Baldwin#
396c508c1b6SJohn Baldwinoptions 	KTR
397c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
39825388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
399a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
400c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
401d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
402c508c1b6SJohn Baldwin
403c508c1b6SJohn Baldwin#
4041c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
405453ffeefSRobert Watson# to a vnode, and is employed by services such as KTR(4) to produce trace
406453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
407453ffeefSRobert Watson# in a worker thread.
408453ffeefSRobert Watson#
409453ffeefSRobert Watsonoptions 	ALQ
410453ffeefSRobert Watsonoptions 	KTR_ALQ
411453ffeefSRobert Watson
412453ffeefSRobert Watson#
4135526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4146a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4156a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4166a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4176a8d6623SGarrett Wollman# programming errors.
4186a8d6623SGarrett Wollman#
4195526d2d9SEivind Eklundoptions 	INVARIANTS
4205526d2d9SEivind Eklund
4215526d2d9SEivind Eklund#
42234b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
42334b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
42434b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
42534b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
42634b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
42734b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
42834b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
42934b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
43034b15f2aSJohn Baldwin# infrastructure without the added overhead.
43134b15f2aSJohn Baldwin#
43234b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
43334b15f2aSJohn Baldwin
43434b15f2aSJohn Baldwin#
4355526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4365526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4375526d2d9SEivind Eklund# it is disabled by default.
4385526d2d9SEivind Eklund#
4390dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
440da59a31cSDavid Greenman
4410dd1eea1SJordan K. Hubbard#
4420b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4433c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4440b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
4450b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
4460b5438c6SRobert Watson# impossible) scenarios.
4470b5438c6SRobert Watson#
4480b5438c6SRobert Watsonoptions 	REGRESSION
4490b5438c6SRobert Watson
4500b5438c6SRobert Watson#
4511432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
452ef39c05bSAlexander Leidinger# a call to the debugger to continue from a panic as instead.  It is only
4531432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
4541432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
4551432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
4561432aa0cSJohn Baldwin# to "workaround" a panic.
4571432aa0cSJohn Baldwin#
4589d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
4591432aa0cSJohn Baldwin
4601432aa0cSJohn Baldwin#
461346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
462346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
463346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
464346ebe51SEivind Eklund# from.)
465346ebe51SEivind Eklund#
466346ebe51SEivind Eklundoptions 	COMPILING_LINT
467346ebe51SEivind Eklund
4683c90d1eaSRobert Watson#
4693c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
4703c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
4713c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
4723c90d1eaSRobert Watson#
4733c90d1eaSRobert Watsonoptions 	STACK
4743c90d1eaSRobert Watson
4756a8d6623SGarrett Wollman
4766a8d6623SGarrett Wollman#####################################################################
477d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
478d47cce3eSMarcel Moolenaar
479d47cce3eSMarcel Moolenaar#
480d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
481d47cce3eSMarcel Moolenaar# counters for performance monitoring.  The base kernel needs to configured
482d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
483d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
484d47cce3eSMarcel Moolenaar#
485ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
486ad3869b4SJoseph Koshy# please see hwpmc(4).
487ad3869b4SJoseph Koshy
488d47cce3eSMarcel Moolenaardevice  	hwpmc			# Driver (also a loadable module)
489d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
490d47cce3eSMarcel Moolenaar
491d47cce3eSMarcel Moolenaar
492d47cce3eSMarcel Moolenaar#####################################################################
4936a8d6623SGarrett Wollman# NETWORKING OPTIONS
49470c0b54cSAndrey A. Chernov
4956a8d6623SGarrett Wollman#
496a22fb0daSGeorge V. Neville-Neil# Protocol families
4976a8d6623SGarrett Wollman#
4986a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
49951f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
500a22fb0daSGeorge V. Neville-Neil
501a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
502a22fb0daSGeorge V. Neville-Neil# your kernel configuration
503a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5042cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
50514dd6717SSam Leffler#
506cc977adcSBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to force packets coming through a tunnel
507cc977adcSBjoern A. Zeeb# to be processed by any configured packet filtering twice.
508cc977adcSBjoern A. Zeeb# The default is that packets coming out of 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#
514cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
515f73bbaf2SDavid Greenman
516cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
517cc6a66f2SJulian Elischer
5187665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
519e83e2322SBoris Popov
52034b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5218b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
52234b5fca7SJulian Elischer
523daaa73b5SRobert Watson#
524daaa73b5SRobert Watson# SMB/CIFS requester
525daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
526daaa73b5SRobert Watson# options.
527daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
528daaa73b5SRobert Watson
529d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
530d8589bd5SBoris Popovoptions 	LIBMCHAIN
531d8589bd5SBoris Popov
5326cd047a0SGleb Smirnoff# libalias library, performing NAT
5336cd047a0SGleb Smirnoffoptions		LIBALIAS
5346cd047a0SGleb Smirnoff
535f8829a4aSRandall Stewart#
536f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
537f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
538f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
539f8829a4aSRandall Stewart# extensions. This release supports all the extensions
540f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
541f8829a4aSRandall Stewart# It is the premeier SCTP implementation in the NET
542f8829a4aSRandall Stewart# and is quite well tested.
543f8829a4aSRandall Stewart#
544f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
545f8829a4aSRandall Stewart# you don't have to enable V6, but SCTP is
546f8829a4aSRandall Stewart# dual stacked and so far we have not teased apart
547f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
548f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
549f8829a4aSRandall Stewart#
550f8829a4aSRandall Stewartoptions         SCTP
551f8829a4aSRandall Stewart# There are bunches of options:
552f8829a4aSRandall Stewart# this one turns on all sorts of
553f8829a4aSRandall Stewart# nastly printing that you can
554f8829a4aSRandall Stewart# do. Its all controled by a
555f8829a4aSRandall Stewart# bit mask (settable by socket opt and
556f8829a4aSRandall Stewart# by sysctl). Including will not cause
557f8829a4aSRandall Stewart# logging until you set the bits.. but it
558f8829a4aSRandall Stewart# can be quite verbose.. so without this
559f8829a4aSRandall Stewart# option we don't do any of the tests for
560f8829a4aSRandall Stewart# bits and prints.. which makes the code run
561f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
562f8829a4aSRandall Stewartoptions SCTP_DEBUG
563f8829a4aSRandall Stewart#
564f8829a4aSRandall Stewart# This option turns off the CRC32c checksum. Basically
565f8829a4aSRandall Stewart# You will not be able to talk to anyone else that
566f8829a4aSRandall Stewart# has not done this. Its more for expermentation to
567f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
568f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
569f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
570f8829a4aSRandall Stewart# like with such an offload (which only exists in
571f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
572f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
573f8829a4aSRandall Stewart# to be.. but it does speed things up try only
574f8829a4aSRandall Stewart# for in a captured lab environment :-)
575f8829a4aSRandall Stewartoptions SCTP_WITH_NO_CSUM
576f8829a4aSRandall Stewart#
577cb7a4976SRandall Stewart
578f8829a4aSRandall Stewart#
579f8829a4aSRandall Stewart# All that options after that turn on specific types of
580f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
581f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
582f8829a4aSRandall Stewart# see. I have used this to produce interesting
583f8829a4aSRandall Stewart# charts and graphs as well :->
584f8829a4aSRandall Stewart#
585f8829a4aSRandall Stewart# I have not yet commited the tools to get and print
586f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
587f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
588cb7a4976SRandall Stewart# You basically must have KTR enabled for these
589cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
590cb7a4976SRandall Stewart# logging bits. Use ktrdump to pull the log and run
591cb7a4976SRandall Stewart# it through a dispaly program.. and graphs and other
592cb7a4976SRandall Stewart# things too.
593f8829a4aSRandall Stewart#
594f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
595f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
596cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
597cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
598cb7a4976SRandall Stewartoptions		SCTP_LTRACE_CHUNKS
599cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
600cb7a4976SRandall Stewart
601f8829a4aSRandall Stewart
60202b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
60302b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
604cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
605cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
606cceffdeeSAndrew Thompson# option.
60702b199f1SMax Laieroptions 	ALTQ
608755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
609c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
61002b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
61102b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
61202b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6133c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
614cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
61502b199f1SMax Laieroptions 	ALTQ_DEBUG
61602b199f1SMax Laier
6174cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6184cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6194cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6204cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
62192a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
62292a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6234cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
62473e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
62573e87266SGleb Smirnoff					# affects netgraph(4) and nodes
62673e87266SGleb Smirnoff# Node types
6274cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
628bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
629b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
630b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
631b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
63251713b2aSMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
633b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
634b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
635b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
636b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
637b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
63892a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
639901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6407d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
6414cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6429e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
64331578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6444cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6459d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
64646aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
647d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
6484cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
64937379158SBrooks Davisoptions 	NETGRAPH_GIF
65037379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
6514cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
6524cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
65337379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
654f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
65548e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
656901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
6574cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
658a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
659a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
660a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
661cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
6626cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
6637d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
664b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
665b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
666add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
6679e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
6684cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
669b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
6704d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
6710a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
672d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
673e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
6744cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
6754cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
6764cf49a43SJulian Elischeroptions 	NETGRAPH_UI
677b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
678666ea1b6SMaksim Yevmenkin
67902152e8fSHartmut Brandt# NgATM - Netgraph ATM
68002152e8fSHartmut Brandtoptions 	NGATM_ATM
681027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
682027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
683027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
684ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
685a7e22394SHartmut Brandtoptions 	NGATM_CCATM
68602152e8fSHartmut Brandt
687c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
6883cf4d0bfSPoul-Henning Kamp
6896a8d6623SGarrett Wollman#
6906a8d6623SGarrett Wollman# Network interfaces:
691f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
692f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
6939d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
694722012ccSJulian Elischer#  configured or token-ring is enabled.
695fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
696fc67901fSYaroslav Tykhiy#  according to IEEE 802.1Q.  It requires `device miibus'.
69757a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
69867e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
69967e4db77SSam Leffler#  ath, and awi drivers and will eventually be required by all 802.11 drivers.
70067e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
70167e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
70267e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
70367e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
70467e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
70534341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
70667e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
70767e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
70867e4db77SSam Leffler#  `wlan' module.
7091a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
710eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
711f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
712e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
713f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
714f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
715f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
716d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
717d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
718991f5121SMurray Stokely#  simultaneous BPF clients programs runnable.  DHCP requires bpf.
719f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
72059d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
72170e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
72263518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
72363518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
7244c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
725f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
726f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
727cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
728cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
729f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
730f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
731f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
732f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
733f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
734cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
735d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
736f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
7375d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
7386a8d6623SGarrett Wollman#
7398d69c48bSMax Laier# The pf packet filter consists of three devices:
7408d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
7418d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
7428d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
7438d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
7448d69c48bSMax Laier#
745829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
746829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
747829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
7486b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
749829b5d55SPeter Wemm# See pppd(8) for more details.
75089327d27SPeter Wemm#
751f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
7521270082cSYaroslav Tykhiydevice		vlan			#VLAN support (needs miibus)
753be7b82cdSSam Lefflerdevice		wlan			#802.11 support
75467e4db77SSam Lefflerdevice		wlan_wep		#802.11 WEP support
75567e4db77SSam Lefflerdevice		wlan_ccmp		#802.11 CCMP support
75667e4db77SSam Lefflerdevice		wlan_tkip		#802.11 TKIP support
75767e4db77SSam Lefflerdevice		wlan_xauth		#802.11 external authenticator support
75867e4db77SSam Lefflerdevice		wlan_acl		#802.11 MAC ACL support
7596ac646b3SKevin Lodevice		wlan_amrr		#AMRR transmit rate control algorithm
76068e8e04eSSam Lefflerdevice		wlan_scan_ap		#802.11 AP mode scanning
76168e8e04eSSam Lefflerdevice		wlan_scan_sta		#802.11 STA mode scanning
762f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
763f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
764eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
765f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
76609d225d8SBrooks Davisdevice		loop			#Network loopback device
767f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
76870e04181SYaroslav Tykhiydevice		disc			#Discard device based on loopback
76963518eccSYaroslav Tykhiydevice		edsc			#Ethernet discard device
7704c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
771f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
772f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
773f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
7747afc53b8SAndrew Thompsondevice		if_bridge		#Bridge interface
7758d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
7768d69c48bSMax Laierdevice		pflog			#logging support interface for PF
7778d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
778c73b559bSGleb Smirnoffdevice		carp			#Common Address Redundancy Protocol
779b2630c29SGeorge V. Neville-Neildevice		enc			#IPsec interface
78005c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
78189327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
78289327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
7836b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
78418242d3bSAndrew Thompsondevice		lagg			#Link aggregation interface
785d29895dcSGarrett Wollman
786f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
7875d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
7885d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
7895d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
7905d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
7915d94d71cSBoris Popov
792cfa1ca9dSYoshinobu Inoue# for IPv6
7939753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
794f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
7952f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
796d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
797cfa1ca9dSYoshinobu Inoue
7986a8d6623SGarrett Wollman#
7996a8d6623SGarrett Wollman# Internet family options:
8006a8d6623SGarrett Wollman#
8016a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8020948f0a2SBruce M Simpson# with mrouted and XORP.
803e0f688baSJeffrey Hsu#
804d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
805ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
806ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
807ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
808ab6e02daSJordan K. Hubbard#
809ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
810ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
811a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
812ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
813ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
814ab6e02daSJordan K. Hubbard# feature works properly.
8158dd4744eSJordan K. Hubbard#
816ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
817ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
818ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
819ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
820ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
821ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
822ffdd472dSPeter Wemm# out of sync.
823d29895dcSGarrett Wollman#
82484bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
82584bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
82693e0e116SJulian Elischer#
82744299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
82844299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
829b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
830b7522c27SJulian Elischer# packets too.  Because of this great care is required when
831b7522c27SJulian Elischer# crafting the ruleset.
832099dd043SAndre Oppermann#
83361c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
83461c0e134SPaolo Pisati# LIBALIAS. To build an ipfw kld with nat support enabled, add
83561c0e134SPaolo Pisati# "CFLAGS+= -DIPFIREWALL_NAT" to your make.conf.
83661c0e134SPaolo Pisati#
8371b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
8381c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
8391b968362SDag-Erling Smørgrav# from traceroute and similar tools.
8401b968362SDag-Erling Smørgrav#
8415e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
8425e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
8435e331acdSGarrett Wollman# using the trpt(8) utility.
84465e8111fSBruce Evans#
845e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
846d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
8474479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
8485895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
849e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
85044299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
85161c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
85293e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
8539cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
8549cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
8550c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
8568259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
8571b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
85865e8111fSBruce Evansoptions 	TCPDEBUG
8596a8d6623SGarrett Wollman
86053dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
86153dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
862f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
86353dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
8644a5ccac7SMike Silbersack
865a79b7128SAlfred Perlstein# Statically Link in accept filters
866a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
867a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
868a79b7128SAlfred Perlstein
869b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
870b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
871b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
872b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
873b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
874b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
875b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
876b52f8407SBruce M Simpson
877f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
878f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
879f8f8803bSBruce Evans# DUMMYNET it is advisable to also have "options HZ=1000" to achieve a
880f8f8803bSBruce Evans# smoother scheduling of the traffic.
88168ec4eb6SLuigi Rizzooptions 	DUMMYNET
88268e9d934SLuigi Rizzo
88398cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
8843c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
88598cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
88698cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
88798cb733cSKenneth D. Merry# zero_copy(9) for more details.
88898cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
88998cb733cSKenneth D. Merry
8903f8c4506SPoul-Henning Kamp#
8913f8c4506SPoul-Henning Kamp# ATM (HARP version) options
8923f8c4506SPoul-Henning Kamp#
8932b851aebSRobert Watson# XXX: These have been disabled in FreeBSD 7.0 as they are not MPSAFE.
8942b851aebSRobert Watson#
8953f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
8963f8c4506SPoul-Henning Kamp#	for ATM support.
8973f8c4506SPoul-Henning Kamp#
8983f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
8993f8c4506SPoul-Henning Kamp#
9003f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
9013f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
9023f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
9033f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
9043f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
9053f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
9063f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
9073f8c4506SPoul-Henning Kamp#
9083f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
9093f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
9103f8c4506SPoul-Henning Kamp#
91158aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
91258aa55efSHartmut Brandt#
9132b851aebSRobert Watson#options 	ATM_CORE		#core ATM protocol family
9142b851aebSRobert Watson#options 	ATM_IP			#IP over ATM support
9152b851aebSRobert Watson#options 	ATM_SIGPVC		#SIGPVC signalling manager
9162b851aebSRobert Watson#options 	ATM_SPANS		#SPANS signalling manager
9172b851aebSRobert Watson#options 	ATM_UNI			#UNI signalling manager
91826837af4SMatthew N. Dodd
9192b851aebSRobert Watson#device		hfa			#FORE PCA-200E ATM PCI
9202b851aebSRobert Watson#device		harp			#Pseudo-interface for NATM
9213f8c4506SPoul-Henning Kamp
9226a8d6623SGarrett Wollman
9236a8d6623SGarrett Wollman#####################################################################
9246a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
925e3178a06SJordan K. Hubbard
9262365e64fSRodney W. Grimes#
9276a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
9286a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
929888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
9306a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
9316a8d6623SGarrett Wollman# compile other filesystems as well.
9326a8d6623SGarrett Wollman#
933534046e3SRong-En Fan# NB: The PORTAL filesystem is known to be buggy, and WILL panic your
934534046e3SRong-En Fan# system if you attempt to do anything with it.  It is included here
935534046e3SRong-En Fan# as an incentive for some enterprising soul to sit down and fix it.
936534046e3SRong-En Fan# The UNION filesystem was known to be buggy in the past.  It is now
937534046e3SRong-En Fan# being actively maintained, although there are still some issues being
938534046e3SRong-En Fan# resolved.
9392365e64fSRodney W. Grimes#
940f1a9c715SDavid Greenman
9416a8d6623SGarrett Wollman# One of these is mandatory:
9426a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
943dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9446a8d6623SGarrett Wollman
9456a8d6623SGarrett Wollman# The rest are optional:
9465895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
94799d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9480adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
949dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
950dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
9513ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
952f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
953dd1c7d13SBruce Evans# Broken (depends on NCP):
954b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
95599d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
9564d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
95752ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
958bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
959daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
960df263cbdSScott Longoptions 	UDF			#Universal Disk Format
96199d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
962bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
963bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
964f1a9c715SDavid Greenman
965d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
966d61e6649SAlexander Langer# making abrupt shutdown less risky.
967f8f8d7afSEivind Eklund#
9683d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
969b1897c19SJulian Elischer
970a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
97151be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
97251be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
97349993db0SRobert Watsonoptions 	UFS_EXTATTR
97449993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
975a64ed089SRobert Watson
97651be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
97751be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
97851be6918SChris D. Faulhaber# for the underlying filesystem.
97951be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
98051be6918SChris D. Faulhaberoptions 	UFS_ACL
98151be6918SChris D. Faulhaber
9829b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
9839b5ad47fSIan Dowse# directories at the expense of some memory.
9849b5ad47fSIan Dowseoptions 	UFS_DIRHASH
9859b5ad47fSIan Dowse
986f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
987f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
988f348204cSPawel Jakub Dawidek
98971e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
99071e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
99171e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
99271e4fff8SPoul-Henning Kamp
99371e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
99471e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
99571e4fff8SPoul-Henning Kampoptions 	MD_ROOT
996d52d7365SPoul-Henning Kamp
997495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
9982365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
9996a8d6623SGarrett Wollman
1000276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1001276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1002276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1003276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1004ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10056110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1006276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1007276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
1008276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
1009276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1010276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1011276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1012cb800e34SJulian Elischer#
1013cb800e34SJulian Elischeroptions 	SUIDDIR
1014cb800e34SJulian Elischer
1015df394affSJohn-Mark Gurney# NFS options:
10165895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10175895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10185895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10195895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10205895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10215895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1022df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1023df394affSJohn-Mark Gurney
10249afcea2fSRobert V. Baron# Coda stuff:
10259afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1026f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1027d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1028d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1029d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1030a1d55890SJordan K. Hubbard
1031053a2b61SEivind Eklund#
1032053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1033053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1034053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1035053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1036053a2b61SEivind Eklund#
10375895e3c8SPeter Wemmoptions 	EXT2FS
1038053a2b61SEivind Eklund
1039fe98fb32SJean-Sébastien Pédron#
1040fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1041fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1042fe98fb32SJean-Sébastien Pédron#
1043fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1044fe98fb32SJean-Sébastien Pédron
10457b30d718SCraig Rodrigues#
10467b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
10477b30d718SCraig Rodrigues# this is limited to read-only access.
10487b30d718SCraig Rodrigues#
10497b30d718SCraig Rodriguesoptions 	XFS
10507b30d718SCraig Rodrigues
1051dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
10520cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
10530cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1054dd85920aSJason Evansoptions 	VFS_AIO
1055053a2b61SEivind Eklund
10568ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1057ac519db0SMark Murraydevice		random
105815bbdecfSMark Murray
10598ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
10608ab2f5ecSMark Murraydevice		mem
10618ab2f5ecSMark Murray
1062c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1063c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1064c4f02a89SMax Khonoptions 	CD9660_ICONV
1065c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1066c4f02a89SMax Khonoptions 	NTFS_ICONV
1067126f0dfaSScott Longoptions 	UDF_ICONV
1068c4f02a89SMax Khon
10696a8d6623SGarrett Wollman
10706a8d6623SGarrett Wollman#####################################################################
1071abc97a06SBruce Evans# POSIX P1003.1B
1072abc97a06SBruce Evans
10731c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1074abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1075abc97a06SBruce Evans
10765895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
10778cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
10788cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
10793ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1080abc97a06SBruce Evans
10815b40ce27SDavid Xu# POSIX message queue
10825b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1083abc97a06SBruce Evans
1084abc97a06SBruce Evans#####################################################################
108512e9f256SRobert Watson# SECURITY POLICY PARAMETERS
108612e9f256SRobert Watson
1087fdcba197SRobert Watson# Support for BSM audit
1088fdcba197SRobert Watsonoptions 	AUDIT
1089fdcba197SRobert Watson
1090cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1091cd6d1d76SBruce Evansoptions 	MAC
1092eae2f20cSRobert Watsonoptions 	MAC_BIBA
1093eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1094eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1095c4725737SRobert Watsonoptions 	MAC_LOMAC
1096eae2f20cSRobert Watsonoptions 	MAC_MLS
1097eae2f20cSRobert Watsonoptions 	MAC_NONE
1098eae2f20cSRobert Watsonoptions 	MAC_PARTITION
109903d03162SRobert Watsonoptions 	MAC_PORTACL
1100eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1101782f7255SRobert Watsonoptions 	MAC_STUB
1102eae2f20cSRobert Watsonoptions 	MAC_TEST
110312e9f256SRobert Watson
110412e9f256SRobert Watson
110512e9f256SRobert Watson#####################################################################
1106000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1107000033d0SJeroen Ruigrok van der Werven
1108000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1109c578eeb3SLuigi Rizzo# default value (100) means a granularity of 10ms (1s/HZ).
1110c578eeb3SLuigi Rizzo# Some subsystems, such as DUMMYNET, might benefit from a smaller
1111c578eeb3SLuigi Rizzo# granularity such as 1ms or less, for a smoother scheduling of packets.
1112c578eeb3SLuigi Rizzo# Consider, however, that reducing the granularity too much might
1113c578eeb3SLuigi Rizzo# cause excessive overhead in clock interrupt processing,
1114c578eeb3SLuigi Rizzo# potentially causing ticks to be missed and thus actually reducing
1115000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
1116000033d0SJeroen Ruigrok van der Werven
1117000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1118000033d0SJeroen Ruigrok van der Werven
1119f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1120f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1121f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1122f309f881SJohn Baldwin
1123f309f881SJohn Baldwinoptions 	PPS_SYNC
1124f309f881SJohn Baldwin
1125000033d0SJeroen Ruigrok van der Werven
1126000033d0SJeroen Ruigrok van der Werven#####################################################################
1127de6a307eSPeter Dufault# SCSI DEVICES
1128de6a307eSPeter Dufault
11296a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11306a8d6623SGarrett Wollman
11316a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1132ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
11336a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
11346a8d6623SGarrett Wollman# device configuration sections below.
11356a8d6623SGarrett Wollman#
1136e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1137e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1138e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1139e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1140e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1141e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1142e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1143e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1144e14eb5a1SGarrett Wollman# problem.)
1145ebc1a0e2SPeter Dufault
1146ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1147ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1148700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1149700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1150ebc1a0e2SPeter Dufault
1151ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1152ebc1a0e2SPeter Dufault
1153f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1154f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1155f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1156f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1157f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1158f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1159f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1160f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1161f71c01ccSPeter Wemmhint.da.0.target="0"
1162f71c01ccSPeter Wemmhint.da.0.unit="0"
1163f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1164f71c01ccSPeter Wemmhint.da.1.target="1"
1165f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1166f71c01ccSPeter Wemmhint.da.2.target="3"
1167f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1168f71c01ccSPeter Wemmhint.sa.1.target="6"
1169ebc1a0e2SPeter Dufault
1170ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1171ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1172ebc1a0e2SPeter Dufault
1173ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1174ebc1a0e2SPeter Dufault
1175cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1176cf2458c9SMatt Jacob#
1177cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1178cf2458c9SMatt Jacob# ("WORM") devices.
1179cf2458c9SMatt Jacob#
1180cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1181cf2458c9SMatt Jacob#
1182cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1183cf2458c9SMatt Jacob#
11843c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
11853c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1186cf2458c9SMatt Jacob#
1187cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1188cf2458c9SMatt Jacob#
11891eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
11901eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
11911eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
11921eba4c79SScott Long# source level API compatiblity for porting apps to FreeBSD.
1193cf2458c9SMatt Jacob#
1194cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1195cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1196cf2458c9SMatt Jacob#
1197cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1198cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1199cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1200cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1201cf2458c9SMatt Jacob#
1202cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1203cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1204cf2458c9SMatt Jacob# to them.
1205cf2458c9SMatt Jacob#
1206265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1207cf2458c9SMatt Jacob# configuration as the "pass" driver.
1208ebc1a0e2SPeter Dufault
1209c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1210c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1211c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1212c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1213c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
121464ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1215cf2458c9SMatt Jacobdevice		pt		#SCSI processor
121664ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
121764ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1218cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12191eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
12208909a72bSPeter Dufault
1221700daf5eSJustin T. Gibbs# CAM OPTIONS:
1222700daf5eSJustin T. Gibbs# debugging options:
1223700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1224700daf5eSJustin T. Gibbs#             specify them all!
1225700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1226700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1227700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1228700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1229d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1230d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1231700daf5eSJustin T. Gibbs#
1232700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1233700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1234700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
123556234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
123656234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
12373a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
12383a937198SBrooks Davis#             can be changed at boot and runtime with the
12393a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1240700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
12415895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
12425895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
12435895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
124425388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
12455895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1246700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1247700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
124832672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
12491a7c583cSGarrett Wollman
1250700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1251700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1252700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1253700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1254700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1255700daf5eSJustin T. Gibbs# respectively.
125693063432SJoerg Wunsch#
1257700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1258700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1259700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
126093063432SJoerg Wunsch#
12615895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
12625895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
126393063432SJoerg Wunsch
12649dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1265b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
12669dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
12679dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
12689dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
12699f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
127025388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
127125388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
127225388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
127325388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
12749f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
12759dfb4471SKenneth D. Merry
12763ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
12773ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
127825388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
12793ece1bd2SKenneth D. Merry
12808904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
12818904e70bSMatt Jacob#
12828904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
12838904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
12848904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
12858904e70bSMatt Jacob# are in....
12868904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
12878904e70bSMatt Jacob
12886a8d6623SGarrett Wollman
12896a8d6623SGarrett Wollman#####################################################################
12906a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
12916a8d6623SGarrett Wollman
12921160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
12931160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
12941160da92SJoerg Wunsch# `xterm', among others.
12951160da92SJoerg Wunsch
1296f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
12976d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1298f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1299f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1300efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13016aec1278SMax Laierdevice		firmware	#firmware(9) support
1302be174c7eSGreg Lehey
13036f2d8adbSBoris Popov# Kernel side iconv library
13046f2d8adbSBoris Popovoptions 	LIBICONV
13056f2d8adbSBoris Popov
130658067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13075895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
130858067a99SPoul-Henning Kamp
13099c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
13109c62b3eeSDavid Schultzoptions 	TTYHOG=8193
13119c62b3eeSDavid Schultz
13126a8d6623SGarrett Wollman
13136a8d6623SGarrett Wollman#####################################################################
1314d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1315d61e6649SAlexander Langer
1316d61e6649SAlexander Langer# For ISA the required hints are listed.
13175bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13185bcb64f2SWarner Losh# no hints are needed.
1319d61e6649SAlexander Langer
1320d61e6649SAlexander Langer#
1321d61e6649SAlexander Langer# Mandatory devices:
1322d61e6649SAlexander Langer#
1323d61e6649SAlexander Langer
13246e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13256e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13266e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13276e818956SDavid E. O'Brien
13287f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13297f5092f3SJohn Baldwin
1330837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1331837f167eSRuslan Ermilov
1332905e8b43SDag-Erling Smørgrav# Various screen savers.
1333905e8b43SDag-Erling Smørgravdevice		blank_saver
1334905e8b43SDag-Erling Smørgravdevice		daemon_saver
1335905e8b43SDag-Erling Smørgravdevice		dragon_saver
1336905e8b43SDag-Erling Smørgravdevice		fade_saver
1337905e8b43SDag-Erling Smørgravdevice		fire_saver
1338905e8b43SDag-Erling Smørgravdevice		green_saver
1339905e8b43SDag-Erling Smørgravdevice		logo_saver
1340905e8b43SDag-Erling Smørgravdevice		rain_saver
1341905e8b43SDag-Erling Smørgravdevice		snake_saver
1342905e8b43SDag-Erling Smørgravdevice		star_saver
1343905e8b43SDag-Erling Smørgravdevice		warp_saver
1344905e8b43SDag-Erling Smørgrav
13451c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1346f453022cSPeter Wemmdevice		sc
1347f71c01ccSPeter Wemmhint.sc.0.at="isa"
1348683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
13496e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
13506e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1351cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1352e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1353c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
13546e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
13556e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
13566e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
135785e36760SJordan K. Hubbard
13587a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
135925388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
136025388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
136125388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
136225388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
13637a88382dSKazutaka YOKOTA
136478f45204SMaxim Sobolev# The following options will let you change the default behaviour of
136578f45204SMaxim Sobolev# cut-n-paste feature
136678f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
136725388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
136825388b6cSBruce Evans					# (default is single space - \"x20\")
136978f45204SMaxim Sobolev
13707a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
13717a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
13727a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
13737a88382dSKazutaka YOKOTA
13746e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
13756e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
13766e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
13776e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
13786e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
13796e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1380c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
13812ac8be82SAndreas Schulz
13828a28ce0eSJohn Baldwin# `flags' for sc
13838a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
13848a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
13858a28ce0eSJohn Baldwin
13861fe04850SBruce Evans#
1387d61e6649SAlexander Langer# Optional devices:
13886a8d6623SGarrett Wollman#
13896a8d6623SGarrett Wollman
13906a8d6623SGarrett Wollman#
1391d61e6649SAlexander Langer# SCSI host adapters:
13926a8d6623SGarrett Wollman#
13937f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1394859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
13956e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
13967f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1397d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1398d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1399cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14007f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1401d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1402d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14036e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14046e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14051b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1406d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1407d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1408d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1409e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1410e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1411af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1412ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
141364fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
141464fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1415d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1416fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1417fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1418fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1419fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1420f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14216e818956SDavid E. O'Brien# wds: WD7000
1422d61e6649SAlexander Langer
14236e818956SDavid E. O'Brien#
14246e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14256e818956SDavid E. O'Brien# probed correctly.
14266e818956SDavid E. O'Brien#
14276e818956SDavid E. O'Briendevice		bt
14286e818956SDavid E. O'Brienhint.bt.0.at="isa"
14296e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14307f5092f3SJohn Baldwindevice		adv
14317f5092f3SJohn Baldwinhint.adv.0.at="isa"
1432c9953c3bSPeter Wemmdevice		adw
14336e818956SDavid E. O'Briendevice		aha
14346e818956SDavid E. O'Brienhint.aha.0.at="isa"
14357f5092f3SJohn Baldwindevice		aic
14367f5092f3SJohn Baldwinhint.aic.0.at="isa"
14377f5092f3SJohn Baldwindevice		ahb
1438d61e6649SAlexander Langerdevice		ahc
1439cdd49e97SJustin T. Gibbsdevice		ahd
1440d61e6649SAlexander Langerdevice		amd
14411b946e21SScott Longdevice		esp
1442c5933b20SScott Longdevice		iscsi_initiator
1443d61e6649SAlexander Langerdevice		isp
14440787f2b8SMatt Jacobhint.isp.0.disable="1"
14450787f2b8SMatt Jacobhint.isp.0.role="3"
14460787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
14470787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
14480787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
14490787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
14500787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
14510787f2b8SMatt Jacobhint.isp.0.topology="lport"
14520787f2b8SMatt Jacobhint.isp.0.topology="nport"
14530787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
14540787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
14550787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
14560787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
14570787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
14580787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1459d61e6649SAlexander Langerdevice		ispfw
146064fa5108SMatt Jacobdevice		mpt
1461d61e6649SAlexander Langerdevice		ncr
1462d61e6649SAlexander Langerdevice		sym
1463f3d92b26SOlivier Houcharddevice		trm
14646e818956SDavid E. O'Briendevice		wds
14656e818956SDavid E. O'Brienhint.wds.0.at="isa"
14666e818956SDavid E. O'Brienhint.wds.0.port="0x350"
14676e818956SDavid E. O'Brienhint.wds.0.irq="11"
14686e818956SDavid E. O'Brienhint.wds.0.drq="6"
1469d61e6649SAlexander Langer
1470d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1471d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1472d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1473d61e6649SAlexander Langer# default.
1474d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1475d61e6649SAlexander Langer
1476fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1477fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1478fac70739SJeroen Ruigrok van der Werven
1479fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1480fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1481fac70739SJeroen Ruigrok van der Werven
1482662d3818SScott Long# Compile in Aic7xxx Debugging code.
1483662d3818SScott Longoptions 	AHC_DEBUG
1484662d3818SScott Long
1485662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1486662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1487662d3818SScott Long
1488f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1489f8f8803bSBruce Evans# See ahc(4).
1490662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1491662d3818SScott Long
1492cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1493cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1494cdd49e97SJustin T. Gibbs
1495f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1496cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1497cdd49e97SJustin T. Gibbs
149843e9d8a3SScott Long# Print human-readable register definitions when debugging
149943e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
150043e9d8a3SScott Long
1501662d3818SScott Long# Bitmap of units to enable targetmode operations.
1502662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1503662d3818SScott Long
1504d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1505d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1506d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1507d61e6649SAlexander Langer
1508c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1509c5933b20SScott Long#
1510c5933b20SScott Longoptions		ISCSI_INITIATOR_DEBUG=9
1511c5933b20SScott Long
1512d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1513d61e6649SAlexander Langer#
1514d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1515d61e6649SAlexander Langer#
151664fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1517af606348SMatt Jacob#
15189a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15199a1b0d43SMatt Jacob#		none=0
15209a1b0d43SMatt Jacob#		target=1
15219a1b0d43SMatt Jacob#		initiator=2
15229a1b0d43SMatt Jacob#		both=3			(not supported currently)
1523af606348SMatt Jacob#
15249a1b0d43SMatt Jacoboptions 	ISP_DEFAULT_ROLES=2
1525d61e6649SAlexander Langer
1526d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1527d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1528d61e6649SAlexander Langer					# Allows the ncr to take precedence
1529d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1530d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1531d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1532d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1533d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1534d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1535d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1536d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1537d61e6649SAlexander Langer					# default:8, range:[1..64]
15386a8d6623SGarrett Wollman
15396e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
15406e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
15416e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
15426e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
15436e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
15446e818956SDavid E. O'Brien#
15456e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
15466e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
15476e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
15486e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
15496e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
15506e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
15516e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
15526e818956SDavid E. O'Brien#                           option will create more trouble than solve.
15536e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
15546e818956SDavid E. O'Brien#                           wait when timing out with the above option.
15556e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
15566e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
15576e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
15586e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
15596e818956SDavid E. O'Brien#                           cost, great benefit.
15606e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
15616e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
15626e818956SDavid E. O'Brien#			    are 100% certain you need it.
15636e818956SDavid E. O'Brien
15646e818956SDavid E. O'Briendevice		dpt
15656e818956SDavid E. O'Brien
15666e818956SDavid E. O'Brien# DPT options
15676e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
15686e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
15696e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
15706e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
15716e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
15726e818956SDavid E. O'Brien
15736e818956SDavid E. O'Brien#
15746e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
15756e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
15766e818956SDavid E. O'Brien# CAM infrastructure.
15776e818956SDavid E. O'Brien#
15786e818956SDavid E. O'Briendevice		ciss
15796e818956SDavid E. O'Brien
15806e818956SDavid E. O'Brien#
15816e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
15826e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
15836e818956SDavid E. O'Brien# at Intel for this driver are
15846e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
15856e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
15866e818956SDavid E. O'Brien#
15876e818956SDavid E. O'Briendevice		iir
15886e818956SDavid E. O'Brien
15896e818956SDavid E. O'Brien#
15906e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
15916e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
15926e818956SDavid E. O'Brien# the CAM infrastructure.
15936e818956SDavid E. O'Brien#
15946e818956SDavid E. O'Briendevice		mly
15956e818956SDavid E. O'Brien
15966e818956SDavid E. O'Brien#
15976e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
15986e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
15996e818956SDavid E. O'Brien# controllers.
16006e818956SDavid E. O'Brien#
16016e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16026e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16036e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
16047f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1605f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16066b31d3f7SScott Longoptions 	MFI_DEBUG
16076e818956SDavid E. O'Brien
16086e818956SDavid E. O'Brien#
16096e818956SDavid E. O'Brien# 3ware ATA RAID
16106e818956SDavid E. O'Brien#
16116e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16126e818956SDavid E. O'Brien
161390d3341eSPeter Wemm#
16146d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16156d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16166d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1617c9953c3bSPeter Wemmdevice		ata
1618c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1619ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1620c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1621c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1622c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1623c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1624fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
16258b89ef0aSSøren Schmidt#
16266d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
16276d04301dSAlexander Langerhint.ata.0.at="isa"
16286d04301dSAlexander Langerhint.ata.0.port="0x1f0"
16296d04301dSAlexander Langerhint.ata.0.irq="14"
16306d04301dSAlexander Langerhint.ata.1.at="isa"
16316d04301dSAlexander Langerhint.ata.1.port="0x170"
16326d04301dSAlexander Langerhint.ata.1.irq="15"
16336d04301dSAlexander Langer
16346d04301dSAlexander Langer#
1635000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1636000da71aSSøren Schmidt#
1637000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
163874d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
163974d8e840SSøren Schmidt
164074d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
164174d8e840SSøren Schmidt
16428b89ef0aSSøren Schmidt#
16436d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
16446d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
16456a8d6623SGarrett Wollman#
1646f71c01ccSPeter Wemmdevice		fdc
1647f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1648f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1649f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1650f71c01ccSPeter Wemmhint.fdc.0.drq="2"
165185827d9cSJoerg Wunsch#
1652d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1653d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1654d2fb4892SJoerg Wunsch# however.
1655d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1656d2fb4892SJoerg Wunsch#
1657f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1658f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1659f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1660f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
166185827d9cSJoerg Wunsch
1662f71c01ccSPeter Wemm# Specify floppy devices
1663f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1664f71c01ccSPeter Wemmhint.fd.0.drive="0"
1665f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1666f71c01ccSPeter Wemmhint.fd.1.drive="1"
166785827d9cSJoerg Wunsch
16686a8d6623SGarrett Wollman#
1669501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1670501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1671c8956b36SMarcel Moolenaar#
1672501ef98fSMarcel Moolenaardevice		uart
1673501ef98fSMarcel Moolenaar
16748194412bSMarcel Moolenaar# Options for uart(4)
16758194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
16768194412bSMarcel Moolenaar					# instead of DCD.
16778194412bSMarcel Moolenaar
1678501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1679501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1680501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1681501ef98fSMarcel Moolenaar
1682c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1683c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1684c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1685c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1686c8956b36SMarcel Moolenaar# unit number of the probed UART.
1687501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1688501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1689501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1690501ef98fSMarcel Moolenaar
1691501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1692c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1693c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1694c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1695c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1696c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1697c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1698c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1699c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1700c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1701c8956b36SMarcel Moolenaar#		as debug port.
17029546766aSBruce Evans#
17039546766aSBruce Evans
1704501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1705c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1706c8956b36SMarcel Moolenaar					# ddb, if available.
17076a8d6623SGarrett Wollman
170826b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
170926b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
171026b6ea69SPaul Saab# Sun servers by the Remote Console.
171126b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
171226b6ea69SPaul Saab
1713af2e25a6SMarcel Moolenaar# Serial Communications Controller
1714af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1715af2e25a6SMarcel Moolenaar# communications controllers.
1716af2e25a6SMarcel Moolenaardevice		scc
1717af2e25a6SMarcel Moolenaar
17189c564b6cSJohn Hay# PCI Universal Communications driver
171964220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17209c564b6cSJohn Haydevice		puc
17219c564b6cSJohn Hay
17226a8d6623SGarrett Wollman#
1723d61e6649SAlexander Langer# Network interfaces:
17246a8d6623SGarrett Wollman#
1725d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1726d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17273c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1728d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1729d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1730d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1731d61e6649SAlexander Langer# individual driver.
1732d61e6649SAlexander Langerdevice		miibus
1733d61e6649SAlexander Langer
17347f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
17357f5092f3SJohn Baldwin#       PCI and ISA varieties.
17367f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
17377f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
1738343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1739343ed0a8SJohn Baldwin#       adapters.
1740343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
174195d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1742586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1743586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1744586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
17457f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
17467f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
17477f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
1748d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1749d61e6649SAlexander Langer#       and various workalikes including:
1750d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1751d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1752d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1753d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1754d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1755d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1756d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1757d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1758d61e6649SAlexander Langer#       KNE110TX.
1759d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1760a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
17617f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
17627f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
17637f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
17647f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
17657f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
17667f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1767d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1768d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1769cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
17701ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
177152c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
177244ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1773c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1774c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1775c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1776c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1777c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1778c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1779c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
17802bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1781d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1782ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1783ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1784ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1785cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1786cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
178741f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
17880fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
17890fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
17900fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
17910fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
17920fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1793d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1794d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1795d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1796d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1797d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1798d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1799d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1800d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1801d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1802d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1803d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1804d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1805d61e6649SAlexander Langer#       card which is 32-bit.
1806b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1807b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
18087d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1809d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1810d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1811d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1812d61e6649SAlexander Langer#       (also single mode and multimode).
1813d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1814d61e6649SAlexander Langer#       attach each one as a separate network interface.
18157f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
18167f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1817d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1818d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1819d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1820d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1821d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1822d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1823d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1824c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1825c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1826d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1827d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1828d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1829d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1830d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
18313c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1832362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1833d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1834d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1835d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1836d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1837d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1838d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1839d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1840d61e6649SAlexander Langer#       NE2000 clone.
18417f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
18427f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
18437f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
18447f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
18457f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
18467f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1847d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1848d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1849d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1850d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1851d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1852d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1853d61e6649SAlexander Langer
18547f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
18557f5092f3SJohn Baldwin
18567f5092f3SJohn Baldwindevice		cm
18577f5092f3SJohn Baldwinhint.cm.0.at="isa"
18587f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
18597f5092f3SJohn Baldwinhint.cm.0.irq="9"
18607f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
18617f5092f3SJohn Baldwindevice		ep
18627f5092f3SJohn Baldwindevice		ex
1863c06a3350SPeter Wemmdevice		fe
18647f5092f3SJohn Baldwinhint.fe.0.at="isa"
18657f5092f3SJohn Baldwinhint.fe.0.port="0x300"
18667f5092f3SJohn Baldwindevice		fea
18677f5092f3SJohn Baldwindevice		sn
18687f5092f3SJohn Baldwinhint.sn.0.at="isa"
18697f5092f3SJohn Baldwinhint.sn.0.port="0x300"
18707f5092f3SJohn Baldwinhint.sn.0.irq="10"
18717f5092f3SJohn Baldwindevice		an
18727f5092f3SJohn Baldwindevice		awi
18737f5092f3SJohn Baldwindevice		cnw
18747f5092f3SJohn Baldwindevice		wi
18757f5092f3SJohn Baldwindevice		xe
18767f5092f3SJohn Baldwin
1877d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1878343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1879343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1880343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
18816654fb12SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
1882d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
18834664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
18844664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
18851ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
188652c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
1887343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
1888d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1889343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
1890d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
18912e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1892d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
18937d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1894d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1895343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1896d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1897343ed0a8SJohn Baldwindevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
1898d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1899eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1900d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1901d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1902d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1903d61e6649SAlexander Langer
1904d61e6649SAlexander Langer# PCI Ethernet NICs.
1905d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
190644ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
1907f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
1908fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
190995d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1910c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1911d61e6649SAlexander Langer
1912343ed0a8SJohn Baldwin# PCI FDDI NICs.
1913c06a3350SPeter Wemmdevice		fpa
1914d61e6649SAlexander Langer
19152bc6081cSScott Long# PCI WAN adapters.
19162bc6081cSScott Longdevice		lmc
19172bc6081cSScott Long
191898cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
191998cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
192098cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
192198cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
192298cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
192398cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
192498cb733cSKenneth D. Merry
19252c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
19262c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
19272c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
19282c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
19292c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
19302c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
19312c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
19322c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
19332c8f5a28SKenneth D. Merry
193468713f97SKenjiro Cho#
193544b5247dSKenjiro Cho# ATM related options (Cranor version)
193644b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
193768713f97SKenjiro Cho#
193868713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
193968713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
194068713f97SKenjiro Cho#
1941c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1942c594298bSHartmut Brandt# ATM PCI cards.
1943c594298bSHartmut Brandt#
1944fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1945fb24f088SHartmut Brandt#
19468dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
19478dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
19488dd4275cSHartmut Brandt#
1949f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
195068713f97SKenjiro Cho# atm devices.
19513cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
195268713f97SKenjiro Cho# bypass TCP/IP.
195368713f97SKenjiro Cho#
1954fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1955fb24f088SHartmut Brandt# hatm and fatm.
19561ba46a03SHartmut Brandt#
195768713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
195868713f97SKenjiro Cho# for more details, please read the original documents at
195998a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
196068713f97SKenjiro Cho#
1961f71c01ccSPeter Wemmdevice		atm
196244b5247dSKenjiro Chodevice		en
1963fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1964c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
19658dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
19661ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
19673cbceb82SKenjiro Chooptions 	NATM			#native ATM
1968f4567b9cSJulian Elischer
19697e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
19707e9024cdSHartmut Brandt
1971c19da41eSPeter Wemm#
19720739ea1dSSeigo Tanimura# Sound drivers
1973c19da41eSPeter Wemm#
19740739ea1dSSeigo Tanimura# sound: The generic sound driver.
1975c7406082SJohn-Mark Gurney#
19760739ea1dSSeigo Tanimura
19770739ea1dSSeigo Tanimuradevice		sound
19780739ea1dSSeigo Tanimura
19790739ea1dSSeigo Tanimura#
19800739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
1981c7406082SJohn-Mark Gurney#
19827f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
19837f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
19847f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
19857f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
19867f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
19877f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
19887f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
19897f5092f3SJohn Baldwin#
1990c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
19910739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
1992d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
1993903b2fb9SJoel Dahl# snd_au88x0		Aureal Vortex 1/2/Advantage PCI. This driver
1994903b2fb9SJoel Dahl#			lacks support for playback and recording.
1995903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
1996903b2fb9SJoel Dahl#			for sparc64.
19970739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
19980739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
19990739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
20000739ea1dSSeigo Tanimura#			4281)
20010739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
20020739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20030fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20049f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20059f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20060739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2007727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2008727ded3aSJoel Dahl#			conjunction with snd_sbc.
20090739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20100739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
20114b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20124b8939a1SAriff Abdullah#			compatible.
20130739ea1dSSeigo Tanimura# snd_ich:		Intel ICH PCI and some more audio controllers
2014903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2015903b2fb9SJoel Dahl#			nForce controllers.
20160739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
20170739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20180739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
20190739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20200739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
20211c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20220739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
20231c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20240739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
20257f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
20269f548240SAlexander Leidinger# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
20270739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2028903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20290739ea1dSSeigo Tanimura#			M5451 PCI.
20300739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20310739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20320739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
20330739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
203481bb901eSPeter Wemm
2035f37a929cSPeter Wemmdevice		snd_ad1816
2036f37a929cSPeter Wemmdevice		snd_als4000
2037d9bde1adSAriff Abdullahdevice		snd_atiixp
2038f37a929cSPeter Wemm#device		snd_au88x0
20397a7386a3SPyun YongHyeon#device		snd_audiocs
20400739ea1dSSeigo Tanimuradevice		snd_cmi
2041f37a929cSPeter Wemmdevice		snd_cs4281
20420739ea1dSSeigo Tanimuradevice		snd_csa
2043f37a929cSPeter Wemmdevice		snd_ds1
2044f37a929cSPeter Wemmdevice		snd_emu10k1
20450fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2046b1ff0220SAlexander Leidingerdevice		snd_envy24
20479f548240SAlexander Leidingerdevice		snd_envy24ht
2048f37a929cSPeter Wemmdevice		snd_es137x
20490739ea1dSSeigo Tanimuradevice		snd_ess
2050f37a929cSPeter Wemmdevice		snd_fm801
20510739ea1dSSeigo Tanimuradevice		snd_gusc
20524b8939a1SAriff Abdullahdevice		snd_hda
20530739ea1dSSeigo Tanimuradevice		snd_ich
20540739ea1dSSeigo Tanimuradevice		snd_maestro
2055f37a929cSPeter Wemmdevice		snd_maestro3
20560739ea1dSSeigo Tanimuradevice		snd_mss
20570739ea1dSSeigo Tanimuradevice		snd_neomagic
2058f37a929cSPeter Wemmdevice		snd_sb16
2059f37a929cSPeter Wemmdevice		snd_sb8
20600739ea1dSSeigo Tanimuradevice		snd_sbc
20610739ea1dSSeigo Tanimuradevice		snd_solo
20629f548240SAlexander Leidingerdevice		snd_spicds
2063f37a929cSPeter Wemmdevice		snd_t4dwave
2064f37a929cSPeter Wemmdevice		snd_via8233
2065f37a929cSPeter Wemmdevice		snd_via82c686
20660739ea1dSSeigo Tanimuradevice		snd_vibes
20670739ea1dSSeigo Tanimuradevice		snd_uaudio
2068c19da41eSPeter Wemm
20691c9c6382SRuslan Ermilov# For non-PnP sound cards:
2070673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2071673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2072673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2073673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2074673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2075673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2076673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2077673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2078673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2079673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2080673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2081673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2082673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2083673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
20847f5092f3SJohn Baldwin
20856a8d6623SGarrett Wollman#
208683820457SPoul-Henning Kamp# IEEE-488 hardware:
208783820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2088346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2089346fa631SPoul-Henning Kamp
209083820457SPoul-Henning Kampdevice	pcii
209183820457SPoul-Henning Kamphint.pcii.0.at="isa"
209283820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
209383820457SPoul-Henning Kamphint.pcii.0.irq="5"
209483820457SPoul-Henning Kamphint.pcii.0.drq="1"
209583820457SPoul-Henning Kamp
2096346fa631SPoul-Henning Kampdevice	tnt4882
2097346fa631SPoul-Henning Kamp
209883820457SPoul-Henning Kamp#
2099567e21c2SBruce Evans# Miscellaneous hardware:
21006a8d6623SGarrett Wollman#
21016fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
21023ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
21031c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
21042849b131SBruce Evans# cy: Cyclades serial driver
21057f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2106787f1498SJohn Baldwin# rc: RISCom/8 multiport card
2107dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
21087f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
2109657e73c4SPeter Dufault
21103b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
21113b577e1fSJordan K. Hubbard#
21123b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
21133b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
21143b577e1fSJordan K. Hubbard#
2115f71c01ccSPeter Wemm#               device  rp	# core driver support
2116f71c01ccSPeter Wemm#
21173b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
2118b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2119b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
21203b577e1fSJordan K. Hubbard#
21213b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
21223b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
2123f71c01ccSPeter Wemm#   your kernel probe hints:
2124b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2125b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
2126b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2127b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
21283b577e1fSJordan K. Hubbard#
21293b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
2130b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2131b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
2132b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2133b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
2134b147fcf9SBruce Evans#		hint.rp.2.at="isa"
2135b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
2136b147fcf9SBruce Evans#		hint.rp.3.at="isa"
2137b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
21383b577e1fSJordan K. Hubbard#
2139dd267672SJohn Baldwin#   For PCI cards, you need no hints.
21403b577e1fSJordan K. Hubbard
21413ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
21423ae5b532SMatthew N. Dodddevice		mcd
21433ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
21443ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
21456fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
21466fe8789dSMatthew N. Dodddevice		scd
21476fe8789dSMatthew N. Doddhint.scd.0.at="isa"
21486fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
21491c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
21507f5092f3SJohn Baldwinhint.joy.0.at="isa"
21517f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2152787f1498SJohn Baldwindevice		rc
2153787f1498SJohn Baldwinhint.rc.0.at="isa"
2154787f1498SJohn Baldwinhint.rc.0.port="0x220"
2155787f1498SJohn Baldwinhint.rc.0.irq="12"
2156f71c01ccSPeter Wemmdevice		rp
21577f5092f3SJohn Baldwinhint.rp.0.at="isa"
21587f5092f3SJohn Baldwinhint.rp.0.port="0x280"
21597f5092f3SJohn Baldwindevice		si
21607f5092f3SJohn Baldwinoptions 	SI_DEBUG
21617f5092f3SJohn Baldwinhint.si.0.at="isa"
21627f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
21637f5092f3SJohn Baldwinhint.si.0.irq="12"
2164a800f455SJulian Elischer
2165eeb706c0SJustin T. Gibbs#
2166a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
21671c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2168a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
21691c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
21701c2b5939SRoger Hardiman#
2171a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2172a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2173a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2174a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
21751c2b5939SRoger Hardiman# These options can be used to override the auto detection
217698a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
21771c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
21789ff07e32SAmancio Hasty#
21794f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
21801c2b5939SRoger Hardiman# or
21811c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
21823c7c6c12SMike Pritchard# Specifies the default video capture mode.
2183a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2184a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2185a9c5b8d0SSøren Schmidt#
21864f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2187a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2188a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2189a9c5b8d0SSøren Schmidt#
21901c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
21911c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
21921c2b5939SRoger Hardiman#
21931c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
21941c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
21951c2b5939SRoger Hardiman#
21961c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
21971c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
21981c2b5939SRoger Hardiman#
21991c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
22001c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
22011c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
22021c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
22031c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
22041c2b5939SRoger Hardiman# As a rough guess, old = before 1998
22051c2b5939SRoger Hardiman#
220630e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
220730e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
220830e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
220930e27d96SAlexander Langer# mono sound.
2210017b0edcSMatt Jacob
2211c17d4340SNicolas Souchu#
2212c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2213c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2214c17d4340SNicolas Souchu#
221528ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
22160f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
221737973e86SPeter Wemm#     device smbus
221837973e86SPeter Wemm#     device iicbus
221937973e86SPeter Wemm#     device iicbb
2220c17d4340SNicolas Souchu#     device iicsmb
22210f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
22220f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
222328ebb692SNicolas Souchu#
2224c06a3350SPeter Wemmdevice		bktr
2225446cee6eSJoerg Wunsch
2226dc9deb29SPoul-Henning Kamp#
22276e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
22286e818956SDavid E. O'Brien#
22295bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
22306e818956SDavid E. O'Brien# pccard: pccard slots
22316e818956SDavid E. O'Brien# cardbus: cardbus slots
22326e818956SDavid E. O'Briendevice		cbb
22336e818956SDavid E. O'Briendevice		pccard
22346e818956SDavid E. O'Briendevice		cardbus
22356e818956SDavid E. O'Brien
22366e818956SDavid E. O'Brien#
22375bcb64f2SWarner Losh# MMC/SD
22385bcb64f2SWarner Losh#
22395bcb64f2SWarner Losh# mmc: mmc bus
22405bcb64f2SWarner Losh# mmcsd: mmc memory and sd cards.
22415bcb64f2SWarner Losh#device		mmc
22425bcb64f2SWarner Losh#device		mmcsd
22435bcb64f2SWarner Losh
22445bcb64f2SWarner Losh#
22458afa373cSNicolas Souchu# SMB bus
22468afa373cSNicolas Souchu#
22473c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
22483c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
22493c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
22508afa373cSNicolas Souchu#
22518afa373cSNicolas Souchu# Supported devices:
22524d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
22538afa373cSNicolas Souchu#
22543c5656bfSArchie Cobbs# Supported SMB interfaces:
225528ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
225628ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
22577f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
22587f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
22597f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
22607f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2261b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
22624d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
226344e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
22644d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
22658afa373cSNicolas Souchu#
2266c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
22673c5656bfSArchie Cobbs
22687f5092f3SJohn Baldwindevice		intpm
22697f5092f3SJohn Baldwindevice		alpm
22707f5092f3SJohn Baldwindevice		ichsmb
22717f5092f3SJohn Baldwindevice		viapm
227244e6ce01SNicolas Souchudevice		amdpm
22734d5f30e0SRuslan Ermilovdevice		amdsmb
227444e6ce01SNicolas Souchudevice		nfpm
22754d5f30e0SRuslan Ermilovdevice		nfsmb
22767f5092f3SJohn Baldwin
2277c9953c3bSPeter Wemmdevice		smb
22788afa373cSNicolas Souchu
22798afa373cSNicolas Souchu#
22808afa373cSNicolas Souchu# I2C Bus
22818afa373cSNicolas Souchu#
22828afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
22838afa373cSNicolas Souchu#
22848afa373cSNicolas Souchu# Supported devices:
22858afa373cSNicolas Souchu# ic	i2c network interface
22868afa373cSNicolas Souchu# iic	i2c standard io
2287f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
22888afa373cSNicolas Souchu#
22898afa373cSNicolas Souchu# Supported interfaces:
229028ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
229128ebb692SNicolas Souchu#
229228ebb692SNicolas Souchu# Other:
229328ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
22948afa373cSNicolas Souchu#
2295c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2296c9953c3bSPeter Wemmdevice		iicbb
22978afa373cSNicolas Souchu
2298c9953c3bSPeter Wemmdevice		ic
2299c9953c3bSPeter Wemmdevice		iic
2300c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
23018afa373cSNicolas Souchu
2302ab4c624bSMike Smith# Parallel-Port Bus
2303ab4c624bSMike Smith#
2304ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2305ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2306ab4c624bSMike Smith# are automatically probed and attached when found.
2307ab4c624bSMike Smith#
2308ab4c624bSMike Smith# Supported devices:
2309ab4c624bSMike Smith# vpo	Iomega Zip Drive
2310f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2311f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2312fdf94d1aSNicolas Souchu# lpt	Parallel Printer
231346f3ff79SMike Smith# plip	Parallel network interface
2314fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2315f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
231628ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2317ab4c624bSMike Smith#
2318ab4c624bSMike Smith# Supported interfaces:
2319ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2320ab4c624bSMike Smith#
2321ef8f7626SNicolas Souchu
23220f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
23230f210c92SNicolas Souchu				  # (see flags in ppc(4))
23245895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
23259d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2326ef8f7626SNicolas Souchu				# compliant peripheral
23275895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
23285895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
23295895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
23305895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
23315895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
23323b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
23333b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2334ef8f7626SNicolas Souchu
2335f71c01ccSPeter Wemmdevice		ppc
2336f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2337f71c01ccSPeter Wemmhint.ppc.0.irq="7"
23380d31b179SPeter Wemmdevice		ppbus
23390d31b179SPeter Wemmdevice		vpo
23400d31b179SPeter Wemmdevice		lpt
23410d31b179SPeter Wemmdevice		plip
23420d31b179SPeter Wemmdevice		ppi
23430d31b179SPeter Wemmdevice		pps
23440d31b179SPeter Wemmdevice		lpbb
23450d31b179SPeter Wemmdevice		pcfclock
2346ab4c624bSMike Smith
23470ac40133SBrian Somers# Kernel BOOTP support
23480ac40133SBrian Somers
23490ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
23500ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
23510ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
23520ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
23530ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
23540ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2355432aad0eSTor Egge
2356d94f38acSEivind Eklund#
23574103b765SPoul-Henning Kamp# Add software watchdog routines.
2358370c3cb5SSean Kelly#
23594103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2360370c3cb5SSean Kelly
2361370c3cb5SSean Kelly#
2362b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
23634e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
23644e0ee531SMike Barcroft# it back on at run-time.
2365c796cfa1SAndrzej Bialecki#
2366c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2367c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2368c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2369c796cfa1SAndrzej Bialecki#
237019dde963SPeter Wemm#options 	NO_SWAPPING
2371c796cfa1SAndrzej Bialecki
23729dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
23739dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
23749dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
23759dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
23769dab0776SDavid Greenman#
23775895e3c8SPeter Wemmoptions 	NSFBUFS=1024
23789dab0776SDavid Greenman
237915a1057cSEivind Eklund#
2380053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2381ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2382053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2383053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2384053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2385053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
238615a1057cSEivind Eklund#
238715a1057cSEivind Eklundoptions 	DEBUG_LOCKS
238815a1057cSEivind Eklund
238926086a03SPeter Wemm
239026086a03SPeter Wemm#####################################################################
23911d33cf3dSNick Hibma# USB support
23921d33cf3dSNick Hibma# UHCI controller
2393c9953c3bSPeter Wemmdevice		uhci
23941d33cf3dSNick Hibma# OHCI controller
2395c9953c3bSPeter Wemmdevice		ohci
2396ca3acad1SBernd Walter# EHCI controller
2397ca3acad1SBernd Walterdevice		ehci
239839e5901eSTakanori Watanabe# SL811 Controller
239939e5901eSTakanori Watanabedevice 		slhci
24001d33cf3dSNick Hibma# General USB code (mandatory for USB)
2401c9953c3bSPeter Wemmdevice		usb
24021d33cf3dSNick Hibma#
2403b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2404b5ea1f0cSNick Hibmadevice		udbp
2405d1233ab3SBruce Evans# USB Fm Radio
2406d1233ab3SBruce Evansdevice		ufm
2407f26c33d2SNick Hibma# Generic USB device driver
2408c9953c3bSPeter Wemmdevice		ugen
2409f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2410c9953c3bSPeter Wemmdevice		uhid
24111d33cf3dSNick Hibma# USB keyboard
2412c9953c3bSPeter Wemmdevice		ukbd
24131d33cf3dSNick Hibma# USB printer
2414c9953c3bSPeter Wemmdevice		ulpt
24156521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2416c9953c3bSPeter Wemmdevice		umass
2417ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2418ce17576aSScott Longdevice		umct
2419e9fb12d3SNick Hibma# USB modem support
2420e9fb12d3SNick Hibmadevice		umodem
2421f26c33d2SNick Hibma# USB mouse
2422c9953c3bSPeter Wemmdevice		ums
24231c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2424e2dbd15fSNick Hibmadevice		urio
24252fd84f56SNick Hibma# USB scanners
24262fd84f56SNick Hibmadevice		uscanner
2427d1233ab3SBruce Evans#
2428916e6e02SJosef Karthauser# USB serial support
2429916e6e02SJosef Karthauserdevice		ucom
24309aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
24319aab0d96SMaxim Konovalovdevice		uark
2432d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2433d1233ab3SBruce Evansdevice		ubsa
2434d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2435d1233ab3SBruce Evansdevice		ubser
243648b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
243748b68edfSJosef Karthauserdevice		uftdi
2438c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2439c5286e11STakanori Watanabedevice		uipaq
244048b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2441916e6e02SJosef Karthauserdevice		uplcom
244248b68edfSJosef Karthauser# USB Visor and Palm devices
244348b68edfSJosef Karthauserdevice		uvisor
2444d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2445d1233ab3SBruce Evansdevice		uvscom
2446f26c33d2SNick Hibma#
2447ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2448d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2449d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2450d04bb221SBill Paul# eval board.
2451c9953c3bSPeter Wemmdevice		aue
2452bf029145SRobert Watson
2453bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2454bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2455bf029145SRobert Watson
2456bf029145SRobert Watsondevice		axe
2457bf029145SRobert Watson
2458dfd1e98eSBill Paul#
24596bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
24606bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
24616bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
24626bcf0032SMaxim Sobolevdevice		cdce
24636bcf0032SMaxim Sobolev#
246401779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
246501779872SBill Paul# and Netmate II, and the Belkin F5U111.
2466c9953c3bSPeter Wemmdevice		cue
246701779872SBill Paul#
2468dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2469d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2470d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
247101779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
247201779872SBill Paul# and 2104USB, and the Corega USB-T.
2473c9953c3bSPeter Wemmdevice		kue
247411e04b05SShunsuke Akiyama#
247511e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
247611e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
247711e04b05SShunsuke Akiyamadevice		rue
2478cdd40f3bSMIHIRA Sanpei Yoshiro#
2479cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2480cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2481cdd40f3bSMIHIRA Sanpei Yoshiro
2482f26c33d2SNick Hibma
2483f26c33d2SNick Hibma# debugging options for the USB subsystem
24841d33cf3dSNick Hibma#
24851d33cf3dSNick Hibmaoptions 	USB_DEBUG
2486f26c33d2SNick Hibma
24876e8394b8SKazutaka YOKOTA# options for ukbd:
24886e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2489cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
24906e8394b8SKazutaka YOKOTA
2491565f53bbSShunsuke Akiyama# options for uplcom:
24923c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2493565f53bbSShunsuke Akiyama						# in milliseconds
2494565f53bbSShunsuke Akiyama
249520280807SShunsuke Akiyama# options for uvscom:
249620280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
24973c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2498565f53bbSShunsuke Akiyama						# in milliseconds
249920280807SShunsuke Akiyama
25008b7ce2ffSSam Leffler#####################################################################
2501869093b1SHidetoshi Shimokawa# FireWire support
25027d2ba89bSJohn Baldwin
2503869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
25047d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
250579acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2506869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
25071c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2508869093b1SHidetoshi Shimokawa
2509869093b1SHidetoshi Shimokawa#####################################################################
2510869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2511869093b1SHidetoshi Shimokawa
2512869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2513869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2514869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2515869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2516869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2517869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
25187d2ba89bSJohn Baldwin
25197d2ba89bSJohn Baldwin#####################################################################
25208b7ce2ffSSam Leffler# crypto subsystem
25218b7ce2ffSSam Leffler#
25221c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2523b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
25241c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
25258b7ce2ffSSam Leffler#
25261c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
25271c9c6382SRuslan Ermilov# been fed back to OpenBSD.
25288b7ce2ffSSam Leffler
25298b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
25308b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
25318b7ce2ffSSam Leffler
2532ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
25338b7ce2ffSSam Leffler
2534b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2535b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2536b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2537b7c4858fSSam Leffler
2538b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2539b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2540b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2541b7c4858fSSam Leffler
25428b7ce2ffSSam Leffler#####################################################################
25438b7ce2ffSSam Leffler
25448b7ce2ffSSam Leffler
2545785d2100SJohn Birrell#
2546785d2100SJohn Birrell# Embedded system options:
2547785d2100SJohn Birrell#
2548785d2100SJohn Birrell# An embedded system might want to run something other than init.
254925388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2550bc0e3a03SJeroen Ruigrok van der Werven
2551bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2552bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
25531c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2554395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2555bc0e3a03SJeroen Ruigrok van der Werven
2556e2c1a4e9SBenno Rice#
2557e2c1a4e9SBenno Rice# Verbose SYSINIT
2558e2c1a4e9SBenno Rice#
2559e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2560e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2561e2c1a4e9SBenno Rice# will print function names instead of addresses.
2562e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2563e2c1a4e9SBenno Rice
2564446af86dSJohn Baldwin#####################################################################
2565446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2566446af86dSJohn Baldwin#
2567446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2568446af86dSJohn Baldwinoptions 	SEMMAP=31
2569446af86dSJohn Baldwin
2570446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2571446af86dSJohn Baldwin# one time.
2572446af86dSJohn Baldwinoptions 	SEMMNI=11
2573446af86dSJohn Baldwin
2574446af86dSJohn Baldwin# Total number of semaphores system wide
2575446af86dSJohn Baldwinoptions 	SEMMNS=61
2576446af86dSJohn Baldwin
2577446af86dSJohn Baldwin# Total number of undo structures in system
2578446af86dSJohn Baldwinoptions 	SEMMNU=31
2579446af86dSJohn Baldwin
2580446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2581446af86dSJohn Baldwin# at one time.
2582446af86dSJohn Baldwinoptions 	SEMMSL=61
2583446af86dSJohn Baldwin
2584446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2585446af86dSJohn Baldwin# semaphore at one time.
2586446af86dSJohn Baldwinoptions 	SEMOPM=101
2587446af86dSJohn Baldwin
2588446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2589446af86dSJohn Baldwin# System V semaphore at one time.
2590446af86dSJohn Baldwinoptions 	SEMUME=11
2591446af86dSJohn Baldwin
2592446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2593446af86dSJohn Baldwinoptions 	SHMALL=1025
2594446af86dSJohn Baldwin
2595446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
259625388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2597446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2598446af86dSJohn Baldwin
2599446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2600446af86dSJohn Baldwinoptions 	SHMMIN=2
2601446af86dSJohn Baldwin
2602446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2603446af86dSJohn Baldwin# at one time.
2604446af86dSJohn Baldwinoptions 	SHMMNI=33
2605446af86dSJohn Baldwin
2606446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2607446af86dSJohn Baldwin# a single process at one time.
2608446af86dSJohn Baldwinoptions 	SHMSEG=9
2609446af86dSJohn Baldwin
2610d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2611d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2612d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2613d9282887SDima Dorfman# console.
2614d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2615d9282887SDima Dorfman
26165bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
26175bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
26185bbb8060STor Egge# file.  Both offset and length of the read operation must be
26195bbb8060STor Egge# multiples of the physical media sector size.
26205bbb8060STor Egge#
2621995356dcSDag-Erling Smørgravoptions 	DIRECTIO
26225bbb8060STor Egge
26235bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
26245bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
26255bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
26265bbb8060STor Egge#
2627995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
26285bbb8060STor Egge
2629446af86dSJohn Baldwin#####################################################################
2630446af86dSJohn Baldwin
2631bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2632bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2633bc0e3a03SJeroen Ruigrok van der Werven
2634bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
263528d7984fSJeroen Ruigrok van der Werven
263628d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2637bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
263828d7984fSJeroen Ruigrok van der Werven
2639bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
26408b6f5e65SJeroen Ruigrok van der Werven
264128d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2642bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
264328d7984fSJeroen Ruigrok van der Werven
26448b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
26458b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
26468b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
26478b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
26488b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
26498b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
26508b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
26518b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
26528b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
26538b6f5e65SJeroen Ruigrok van der Werven
26548b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
26558b6f5e65SJeroen Ruigrok van der Werven
2656bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2657bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2658bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2659bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
26608b6f5e65SJeroen Ruigrok van der Werven
26618b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
26628b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
26638b6f5e65SJeroen Ruigrok van der Werven
2664bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2665bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
26668b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
26678b6f5e65SJeroen Ruigrok van der Werven
2668316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2669316ec49aSScott Long
2670662d3818SScott Long# Adaptec Array Controller driver options
2671662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2672662d3818SScott Long				# 0 - quiet, only emit warnings
2673662d3818SScott Long				# 1 - noisy, emit major function
2674662d3818SScott Long				#     points and things done
2675662d3818SScott Long				# 2 - extremely noisy, emit trace
2676662d3818SScott Long				#     items in loops, etc.
2677662d3818SScott Long
26781e9ea774SBruce Evans# Yet more undocumented options for linting.
26791e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
26801e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
26811e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
268225388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
268325388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
26841e9ea774SBruce Evansoptions 	MAXFILES=999
2685