xref: /freebsd/sys/conf/NOTES (revision dfdcada31e7924c832024404c6a09a2db04e397e)
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
129272afb65SWojciech A. Koszek# the kernel binary itself. See config(8) for more details.
130827d623eSJordan K. Hubbard#
131827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
132827d623eSJordan K. Hubbard
133069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
134069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
135069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1365d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1377226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1385ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
13922db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1407226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
141f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
142e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1431669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
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
1495aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
1501d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
1516bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
15210020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
153069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
154e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
155560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1567dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
157069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
15875261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
159f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
160069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1611c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1627b03a440SPoul-Henning Kamp
1638b140d57SMike Smith#
1648b140d57SMike Smith# The root device and filesystem type can be compiled in;
1658b140d57SMike Smith# this provides a fallback option if the root device cannot
1663b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1678b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1688b140d57SMike Smith#
1698b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1708b140d57SMike Smith
1716a8d6623SGarrett Wollman
1726a8d6623SGarrett Wollman#####################################################################
173f5d05ac3SJeff Roberson# Scheduler options:
174f5d05ac3SJeff Roberson#
175a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
176f5d05ac3SJeff Roberson# select which scheduler is compiled in.
177f5d05ac3SJeff Roberson#
178f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1791c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
180f5d05ac3SJeff Roberson# good interactivity and priority selection.
181f5d05ac3SJeff Roberson#
182bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
183bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
184bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
185bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
186bd675f58SJeff Roberson# will eventually become the default scheduler.
187f5d05ac3SJeff Roberson#
18875a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
18975a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
19075a66a92SJeff Roberson#
191b998bd92SJeff Robersonoptions 	SCHED_4BSD
19275a66a92SJeff Robersonoptions		SCHED_STATS
193b998bd92SJeff Roberson#options 	SCHED_ULE
194f5d05ac3SJeff Roberson
195f5d05ac3SJeff Roberson#####################################################################
196477a642cSPeter Wemm# SMP OPTIONS:
197477a642cSPeter Wemm#
198477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
199477a642cSPeter Wemm
200477a642cSPeter Wemm# Mandatory:
201477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
202477a642cSPeter Wemm
2032498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2042498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
205701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
206701f1408SScott Long# to disable it.
207701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2082498cf8cSJohn Baldwin
209cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
210cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
211cd6e6e4eSJohn Baldwin# CPU.  This behaviour is enabled by default, so this option can be used
212cd6e6e4eSJohn Baldwin# to disable it.
213cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
214cd6e6e4eSJohn Baldwin
2154e7f640dSJohn Baldwin# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread
2164e7f640dSJohn Baldwin# that currently owns the lock is executing on another CPU.  Note that
2174e7f640dSJohn Baldwin# in addition to enabling this option, individual sx locks must be
2184e7f640dSJohn Baldwin# initialized with the SX_ADAPTIVESPIN flag.
2194e7f640dSJohn Baldwinoptions 	ADAPTIVE_SX
2204e7f640dSJohn Baldwin
221ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
222ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
223ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
224cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
225ad27c4c7SJohn Baldwin# and WITNESS options.
226ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
227ad27c4c7SJohn Baldwin
2281a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2291a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2301a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
231cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2321a5d9b15SJohn Baldwin# and WITNESS options.
2331a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2341a5d9b15SJohn Baldwin
2354e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2364e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2374e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2384e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2394e7f640dSJohn Baldwin# and WITNESS options.
2404e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2414e7f640dSJohn Baldwin
2421fe4c660SJohn Baldwin# SMP Debugging Options:
2431fe4c660SJohn Baldwin#
2449923b511SScott Long# PREEMPTION allows the threads that are in the kernel to be preempted
2459923b511SScott Long#	  by higher priority threads.  It helps with interactivity and
2469923b511SScott Long#	  allows interrupt threads to run sooner rather than waiting.
24767ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2480c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2498c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2500c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2510c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2520c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2539923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
254ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
255ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
25675a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
25775a66a92SJeff Roberson#	  frequency.
258ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
259ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
260aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2611fe4c660SJohn Baldwin#         during locking operations.
262e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2633c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
264660d1e3aSJohn Baldwin#	  sleep.
265660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2669923b511SScott Longoptions 	PREEMPTION
2670c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
268ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2691fe4c660SJohn Baldwinoptions 	WITNESS
270e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
271660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2721fe4c660SJohn Baldwin
273cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
27407dba937SKip Macyoptions 	LOCK_PROFILING
27500096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
27600096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
27700096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
27800096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2794db0d7f1SDag-Erling Smørgrav
280ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
281ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
282ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
283ef0ebfc3SJohn Baldwin
284477a642cSPeter Wemm
285477a642cSPeter Wemm#####################################################################
2866a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
287690f540cSAndrey A. Chernov
2886a8d6623SGarrett Wollman#
2896a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
29056c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2917bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2927bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2937bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2947bbf05a2SJuli Mallett# signal delivery mechanism.
2956a8d6623SGarrett Wollman#
2965895e3c8SPeter Wemmoptions 	COMPAT_43
2976a8d6623SGarrett Wollman
298d3e64681SPoul-Henning Kamp# Old tty interface.
299d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
300d3e64681SPoul-Henning Kamp
301f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
302f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
303f0eb293eSAlfred Perlstein
304a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
305a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
306a01b4125SKen Smith
3076c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3086c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3096c9fdda7SRuslan Ermilov
3105965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3115965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3125965c4b7SJohn Baldwin
3136a8d6623SGarrett Wollman#
3146a8d6623SGarrett Wollman# These three options provide support for System V Interface
3156a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3166a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3176a8d6623SGarrett Wollman#
3186a8d6623SGarrett Wollmanoptions 	SYSVSHM
3196a8d6623SGarrett Wollmanoptions 	SYSVSEM
3206a8d6623SGarrett Wollmanoptions 	SYSVMSG
3216a8d6623SGarrett Wollman
3226a8d6623SGarrett Wollman
3236a8d6623SGarrett Wollman#####################################################################
3246a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3256a8d6623SGarrett Wollman
3266a8d6623SGarrett Wollman#
327e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3286a8d6623SGarrett Wollman#
329e2ee2173SMarcel Moolenaaroptions 	KDB
330b5d89ca8SBruce Evans
331b5d89ca8SBruce Evans#
332e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3337085e708SBruce Evans#
334e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
335e2ee2173SMarcel Moolenaar
336e2ee2173SMarcel Moolenaar#
337e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
338e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
339e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
340e2ee2173SMarcel Moolenaar#
341e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
342e2ee2173SMarcel Moolenaar
343e2ee2173SMarcel Moolenaar#
344e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
345e2ee2173SMarcel Moolenaar#
346e2ee2173SMarcel Moolenaaroptions 	DDB
3477085e708SBruce Evans
3487085e708SBruce Evans#
349bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
350bfdd261eSBruce Evans# representation.
351bfdd261eSBruce Evans#
352bfdd261eSBruce Evansoptions 	DDB_NUMSYM
353bfdd261eSBruce Evans
354bfdd261eSBruce Evans#
355e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3560be15decSJohn Baldwin#
357e2ee2173SMarcel Moolenaaroptions 	GDB
358562d05dfSPaul Traina
359562d05dfSPaul Traina#
360df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
361df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3621c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
363df970488SRobert Watson# interfere with serial console operation.
364df970488SRobert Watson#
365df970488SRobert Watsonoptions 	SYSCTL_DEBUG
366df970488SRobert Watson
367df970488SRobert Watson#
368e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
369e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
370e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
371e4eb384bSBosko Milekic#
372e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
373e4eb384bSBosko Milekic
374e4eb384bSBosko Milekic#
375847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
376847a2a17SPawel Jakub Dawidek# malloc(9).
377847a2a17SPawel Jakub Dawidek#
378847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
379847a2a17SPawel Jakub Dawidek
380847a2a17SPawel Jakub Dawidek#
381ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
382ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
383ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
384ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
385ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
386ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
387ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
3886a8d6623SGarrett Wollman#
3892365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
390ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
39121c64a07SAndrey A. Chernov
3926a8d6623SGarrett Wollman#
393a7bebf90SKris Kennaway# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently
394a7bebf90SKris Kennaway# it has no userland interface aside from a few sysctl's.  It is
395a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
396a7bebf90SKris Kennaway# entries in the circular trace buffer; it must be a power of two.
397a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
398a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
399a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
400a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
4011c9c6382SRuslan Ermilov# events, with bit X corresponding to CPU X.  KTR_VERBOSE enables
402a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
403a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
404a7bebf90SKris Kennaway# if KTR_VERBOSE is not defined.
405c508c1b6SJohn Baldwin#
406c508c1b6SJohn Baldwinoptions 	KTR
407c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
40825388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
409a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
410c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
411d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
412c508c1b6SJohn Baldwin
413c508c1b6SJohn Baldwin#
4141c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
415453ffeefSRobert Watson# to a vnode, and is employed by services such as KTR(4) to produce trace
416453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
417453ffeefSRobert Watson# in a worker thread.
418453ffeefSRobert Watson#
419453ffeefSRobert Watsonoptions 	ALQ
420453ffeefSRobert Watsonoptions 	KTR_ALQ
421453ffeefSRobert Watson
422453ffeefSRobert Watson#
4235526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4246a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4256a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4266a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4276a8d6623SGarrett Wollman# programming errors.
4286a8d6623SGarrett Wollman#
4295526d2d9SEivind Eklundoptions 	INVARIANTS
4305526d2d9SEivind Eklund
4315526d2d9SEivind Eklund#
43234b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
43334b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
43434b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
43534b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
43634b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
43734b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
43834b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
43934b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
44034b15f2aSJohn Baldwin# infrastructure without the added overhead.
44134b15f2aSJohn Baldwin#
44234b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
44334b15f2aSJohn Baldwin
44434b15f2aSJohn Baldwin#
4455526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4465526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4475526d2d9SEivind Eklund# it is disabled by default.
4485526d2d9SEivind Eklund#
4490dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
450da59a31cSDavid Greenman
4510dd1eea1SJordan K. Hubbard#
4520b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4533c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4540b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
4550b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
4560b5438c6SRobert Watson# impossible) scenarios.
4570b5438c6SRobert Watson#
4580b5438c6SRobert Watsonoptions 	REGRESSION
4590b5438c6SRobert Watson
4600b5438c6SRobert Watson#
4611432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
462ef39c05bSAlexander Leidinger# a call to the debugger to continue from a panic as instead.  It is only
4631432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
4641432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
4651432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
4661432aa0cSJohn Baldwin# to "workaround" a panic.
4671432aa0cSJohn Baldwin#
4689d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
4691432aa0cSJohn Baldwin
4701432aa0cSJohn Baldwin#
471346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
472346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
473346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
474346ebe51SEivind Eklund# from.)
475346ebe51SEivind Eklund#
476346ebe51SEivind Eklundoptions 	COMPILING_LINT
477346ebe51SEivind Eklund
4783c90d1eaSRobert Watson#
4793c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
4803c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
4813c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
4823c90d1eaSRobert Watson#
4833c90d1eaSRobert Watsonoptions 	STACK
4843c90d1eaSRobert Watson
4856a8d6623SGarrett Wollman
4866a8d6623SGarrett Wollman#####################################################################
487d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
488d47cce3eSMarcel Moolenaar
489d47cce3eSMarcel Moolenaar#
490d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
491d47cce3eSMarcel Moolenaar# counters for performance monitoring.  The base kernel needs to configured
492d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
493d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
494d47cce3eSMarcel Moolenaar#
495ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
496ad3869b4SJoseph Koshy# please see hwpmc(4).
497ad3869b4SJoseph Koshy
498d47cce3eSMarcel Moolenaardevice  	hwpmc			# Driver (also a loadable module)
499d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
500d47cce3eSMarcel Moolenaar
501d47cce3eSMarcel Moolenaar
502d47cce3eSMarcel Moolenaar#####################################################################
5036a8d6623SGarrett Wollman# NETWORKING OPTIONS
50470c0b54cSAndrey A. Chernov
5056a8d6623SGarrett Wollman#
506a22fb0daSGeorge V. Neville-Neil# Protocol families
5076a8d6623SGarrett Wollman#
5086a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
50951f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
510a22fb0daSGeorge V. Neville-Neil
511a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
512a22fb0daSGeorge V. Neville-Neil# your kernel configuration
513a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5142cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
51514dd6717SSam Leffler#
516cc977adcSBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to force packets coming through a tunnel
517cc977adcSBjoern A. Zeeb# to be processed by any configured packet filtering twice.
518cc977adcSBjoern A. Zeeb# The default is that packets coming out of a tunnel are _not_ processed;
51914dd6717SSam Leffler# they are assumed trusted.
52014dd6717SSam Leffler#
521fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
522fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
52314dd6717SSam Leffler#
524cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
525f73bbaf2SDavid Greenman
526cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
527cc6a66f2SJulian Elischer
5287665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
529e83e2322SBoris Popov
53034b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5318b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
53234b5fca7SJulian Elischer
533daaa73b5SRobert Watson#
534daaa73b5SRobert Watson# SMB/CIFS requester
535daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
536daaa73b5SRobert Watson# options.
537daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
538daaa73b5SRobert Watson
539d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
540d8589bd5SBoris Popovoptions 	LIBMCHAIN
541d8589bd5SBoris Popov
5426cd047a0SGleb Smirnoff# libalias library, performing NAT
5436cd047a0SGleb Smirnoffoptions		LIBALIAS
5446cd047a0SGleb Smirnoff
545f8829a4aSRandall Stewart#
546f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
547f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
548f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
549f8829a4aSRandall Stewart# extensions. This release supports all the extensions
550f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
551f8829a4aSRandall Stewart# It is the premeier SCTP implementation in the NET
552f8829a4aSRandall Stewart# and is quite well tested.
553f8829a4aSRandall Stewart#
554f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
555f8829a4aSRandall Stewart# you don't have to enable V6, but SCTP is
556f8829a4aSRandall Stewart# dual stacked and so far we have not teased apart
557f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
558f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
559f8829a4aSRandall Stewart#
560f8829a4aSRandall Stewartoptions         SCTP
561f8829a4aSRandall Stewart# There are bunches of options:
562f8829a4aSRandall Stewart# this one turns on all sorts of
563f8829a4aSRandall Stewart# nastly printing that you can
564f8829a4aSRandall Stewart# do. Its all controled by a
565f8829a4aSRandall Stewart# bit mask (settable by socket opt and
566f8829a4aSRandall Stewart# by sysctl). Including will not cause
567f8829a4aSRandall Stewart# logging until you set the bits.. but it
568f8829a4aSRandall Stewart# can be quite verbose.. so without this
569f8829a4aSRandall Stewart# option we don't do any of the tests for
570f8829a4aSRandall Stewart# bits and prints.. which makes the code run
571f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
572f8829a4aSRandall Stewartoptions SCTP_DEBUG
573f8829a4aSRandall Stewart#
574f8829a4aSRandall Stewart# This option turns off the CRC32c checksum. Basically
575f8829a4aSRandall Stewart# You will not be able to talk to anyone else that
576f8829a4aSRandall Stewart# has not done this. Its more for expermentation to
577f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
578f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
579f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
580f8829a4aSRandall Stewart# like with such an offload (which only exists in
581f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
582f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
583f8829a4aSRandall Stewart# to be.. but it does speed things up try only
584f8829a4aSRandall Stewart# for in a captured lab environment :-)
585f8829a4aSRandall Stewartoptions SCTP_WITH_NO_CSUM
586f8829a4aSRandall Stewart#
587cb7a4976SRandall Stewart
588f8829a4aSRandall Stewart#
589f8829a4aSRandall Stewart# All that options after that turn on specific types of
590f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
591f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
592f8829a4aSRandall Stewart# see. I have used this to produce interesting
593f8829a4aSRandall Stewart# charts and graphs as well :->
594f8829a4aSRandall Stewart#
595f8829a4aSRandall Stewart# I have not yet commited the tools to get and print
596f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
597f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
598cb7a4976SRandall Stewart# You basically must have KTR enabled for these
599cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
600cb7a4976SRandall Stewart# logging bits. Use ktrdump to pull the log and run
601cb7a4976SRandall Stewart# it through a dispaly program.. and graphs and other
602cb7a4976SRandall Stewart# things too.
603f8829a4aSRandall Stewart#
604f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
605f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
606cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
607cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
608cb7a4976SRandall Stewartoptions		SCTP_LTRACE_CHUNKS
609cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
610cb7a4976SRandall Stewart
611f8829a4aSRandall Stewart
61202b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
61302b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
614cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
615cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
616cceffdeeSAndrew Thompson# option.
61702b199f1SMax Laieroptions 	ALTQ
618755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
619c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
62002b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
62102b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
62202b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6233c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
624cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
62502b199f1SMax Laieroptions 	ALTQ_DEBUG
62602b199f1SMax Laier
6274cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6284cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6294cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6304cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
63192a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
63292a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6334cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
63473e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
63573e87266SGleb Smirnoff					# affects netgraph(4) and nodes
63673e87266SGleb Smirnoff# Node types
6374cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
638bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
639b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
640b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
641b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
64251713b2aSMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
643b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
644b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
645b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
646b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
647b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
64892a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
649901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6507d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
6514cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6529e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
65331578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6544cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6559d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
65646aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
657d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
6584cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
65937379158SBrooks Davisoptions 	NETGRAPH_GIF
66037379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
6614cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
6624cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
66337379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
664f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
66548e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
666901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
6674cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
668a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
669a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
670a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
671cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
6726cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
6737d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
674b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
675b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
676add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
6779e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
6784cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
679b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
6804d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
6810a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
682d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
683e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
6844cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
6854cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
6864cf49a43SJulian Elischeroptions 	NETGRAPH_UI
687b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
688666ea1b6SMaksim Yevmenkin
68902152e8fSHartmut Brandt# NgATM - Netgraph ATM
69002152e8fSHartmut Brandtoptions 	NGATM_ATM
691027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
692027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
693027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
694ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
695a7e22394SHartmut Brandtoptions 	NGATM_CCATM
69602152e8fSHartmut Brandt
697c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
6983cf4d0bfSPoul-Henning Kamp
6996a8d6623SGarrett Wollman#
7006a8d6623SGarrett Wollman# Network interfaces:
701f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
702f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7039d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
704722012ccSJulian Elischer#  configured or token-ring is enabled.
705fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
706fc67901fSYaroslav Tykhiy#  according to IEEE 802.1Q.  It requires `device miibus'.
70757a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
70867e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
70967e4db77SSam Leffler#  ath, and awi drivers and will eventually be required by all 802.11 drivers.
71067e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
71167e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
71267e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
71367e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
71467e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
71534341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
71667e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
71767e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
71867e4db77SSam Leffler#  `wlan' module.
7191a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
720eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
721f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
722e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
723f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
724f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
725f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
726d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
727d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
728991f5121SMurray Stokely#  simultaneous BPF clients programs runnable.  DHCP requires bpf.
729f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
73059d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
73170e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
73263518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
73363518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
7344c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
735f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
736f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
737cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
738cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
739f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
740f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
741f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
742f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
743f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
744cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
745d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
746f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
7475d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
7486a8d6623SGarrett Wollman#
7498d69c48bSMax Laier# The pf packet filter consists of three devices:
7508d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
7518d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
7528d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
7538d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
7548d69c48bSMax Laier#
755829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
756829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
757829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
7586b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
759829b5d55SPeter Wemm# See pppd(8) for more details.
76089327d27SPeter Wemm#
761f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
7621270082cSYaroslav Tykhiydevice		vlan			#VLAN support (needs miibus)
763be7b82cdSSam Lefflerdevice		wlan			#802.11 support
76467e4db77SSam Lefflerdevice		wlan_wep		#802.11 WEP support
76567e4db77SSam Lefflerdevice		wlan_ccmp		#802.11 CCMP support
76667e4db77SSam Lefflerdevice		wlan_tkip		#802.11 TKIP support
76767e4db77SSam Lefflerdevice		wlan_xauth		#802.11 external authenticator support
76867e4db77SSam Lefflerdevice		wlan_acl		#802.11 MAC ACL support
7696ac646b3SKevin Lodevice		wlan_amrr		#AMRR transmit rate control algorithm
77068e8e04eSSam Lefflerdevice		wlan_scan_ap		#802.11 AP mode scanning
77168e8e04eSSam Lefflerdevice		wlan_scan_sta		#802.11 STA mode scanning
772f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
773f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
774eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
775f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
77609d225d8SBrooks Davisdevice		loop			#Network loopback device
777f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
77870e04181SYaroslav Tykhiydevice		disc			#Discard device based on loopback
77963518eccSYaroslav Tykhiydevice		edsc			#Ethernet discard device
7804c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
781f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
782f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
783f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
7847afc53b8SAndrew Thompsondevice		if_bridge		#Bridge interface
7858d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
7868d69c48bSMax Laierdevice		pflog			#logging support interface for PF
7878d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
788c73b559bSGleb Smirnoffdevice		carp			#Common Address Redundancy Protocol
789b2630c29SGeorge V. Neville-Neildevice		enc			#IPsec interface
79005c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
79189327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
79289327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
7936b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
79418242d3bSAndrew Thompsondevice		lagg			#Link aggregation interface
795d29895dcSGarrett Wollman
796f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
7975d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
7985d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
7995d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
8005d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
8015d94d71cSBoris Popov
802cfa1ca9dSYoshinobu Inoue# for IPv6
8039753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
804f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
8052f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
806d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
807cfa1ca9dSYoshinobu Inoue
8086a8d6623SGarrett Wollman#
8096a8d6623SGarrett Wollman# Internet family options:
8106a8d6623SGarrett Wollman#
8116a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8120948f0a2SBruce M Simpson# with mrouted and XORP.
813e0f688baSJeffrey Hsu#
814d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
815ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
816ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
817ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
818ab6e02daSJordan K. Hubbard#
819ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
820ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
821a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
822ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
823ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
824ab6e02daSJordan K. Hubbard# feature works properly.
8258dd4744eSJordan K. Hubbard#
826ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
827ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
828ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
829ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
830ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
831ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
832ffdd472dSPeter Wemm# out of sync.
833d29895dcSGarrett Wollman#
83484bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
83584bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
83693e0e116SJulian Elischer#
83744299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
83844299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
839b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
840b7522c27SJulian Elischer# packets too.  Because of this great care is required when
841b7522c27SJulian Elischer# crafting the ruleset.
842099dd043SAndre Oppermann#
84361c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
844531c890bSPaolo Pisati# LIBALIAS.
84561c0e134SPaolo Pisati#
8461b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
8471c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
8481b968362SDag-Erling Smørgrav# from traceroute and similar tools.
8491b968362SDag-Erling Smørgrav#
8505e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
8515e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
8525e331acdSGarrett Wollman# using the trpt(8) utility.
85365e8111fSBruce Evans#
854e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
855d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
8564479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
8575895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
858e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
85944299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
86061c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
86193e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
8629cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
8639cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
8640c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
8658259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
8661b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
86765e8111fSBruce Evansoptions 	TCPDEBUG
8686a8d6623SGarrett Wollman
86953dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
87053dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
871f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
87253dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
8734a5ccac7SMike Silbersack
874a79b7128SAlfred Perlstein# Statically Link in accept filters
875a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
876a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
877a79b7128SAlfred Perlstein
878b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
879b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
880b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
881b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
882b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
883b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
884b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
885b52f8407SBruce M Simpson
886f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
887f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
888358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
889358f8d82SRobert Watson# a smooth scheduling of the traffic.
89068ec4eb6SLuigi Rizzooptions 	DUMMYNET
89168e9d934SLuigi Rizzo
89298cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
8933c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
89498cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
89598cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
89698cb733cSKenneth D. Merry# zero_copy(9) for more details.
89798cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
89898cb733cSKenneth D. Merry
8993f8c4506SPoul-Henning Kamp#
9003f8c4506SPoul-Henning Kamp# ATM (HARP version) options
9013f8c4506SPoul-Henning Kamp#
9022b851aebSRobert Watson# XXX: These have been disabled in FreeBSD 7.0 as they are not MPSAFE.
9032b851aebSRobert Watson#
9043f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
9053f8c4506SPoul-Henning Kamp#	for ATM support.
9063f8c4506SPoul-Henning Kamp#
9073f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
9083f8c4506SPoul-Henning Kamp#
9093f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
9103f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
9113f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
9123f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
9133f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
9143f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
9153f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
9163f8c4506SPoul-Henning Kamp#
9173f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
9183f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
9193f8c4506SPoul-Henning Kamp#
92058aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
92158aa55efSHartmut Brandt#
9222b851aebSRobert Watson#options 	ATM_CORE		#core ATM protocol family
9232b851aebSRobert Watson#options 	ATM_IP			#IP over ATM support
9242b851aebSRobert Watson#options 	ATM_SIGPVC		#SIGPVC signalling manager
9252b851aebSRobert Watson#options 	ATM_SPANS		#SPANS signalling manager
9262b851aebSRobert Watson#options 	ATM_UNI			#UNI signalling manager
92726837af4SMatthew N. Dodd
9282b851aebSRobert Watson#device		hfa			#FORE PCA-200E ATM PCI
9292b851aebSRobert Watson#device		harp			#Pseudo-interface for NATM
9303f8c4506SPoul-Henning Kamp
9316a8d6623SGarrett Wollman
9326a8d6623SGarrett Wollman#####################################################################
9336a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
934e3178a06SJordan K. Hubbard
9352365e64fSRodney W. Grimes#
9366a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
9376a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
938888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
9396a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
9406a8d6623SGarrett Wollman# compile other filesystems as well.
9416a8d6623SGarrett Wollman#
942534046e3SRong-En Fan# NB: The PORTAL filesystem is known to be buggy, and WILL panic your
943534046e3SRong-En Fan# system if you attempt to do anything with it.  It is included here
944534046e3SRong-En Fan# as an incentive for some enterprising soul to sit down and fix it.
945534046e3SRong-En Fan# The UNION filesystem was known to be buggy in the past.  It is now
946534046e3SRong-En Fan# being actively maintained, although there are still some issues being
947534046e3SRong-En Fan# resolved.
9482365e64fSRodney W. Grimes#
949f1a9c715SDavid Greenman
9506a8d6623SGarrett Wollman# One of these is mandatory:
9516a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
952dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9536a8d6623SGarrett Wollman
9546a8d6623SGarrett Wollman# The rest are optional:
9555895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
95699d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9570adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
958dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
959dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
960dfdcada3SDoug Rabsonoptions		NFSLOCKD		#Network Lock Manager
9613ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
962f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
963dd1c7d13SBruce Evans# Broken (depends on NCP):
964b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
96599d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
9664d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
96752ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
968bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
969daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
970df263cbdSScott Longoptions 	UDF			#Universal Disk Format
97199d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
972bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
973bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
974f1a9c715SDavid Greenman
975d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
976d61e6649SAlexander Langer# making abrupt shutdown less risky.
977f8f8d7afSEivind Eklund#
9783d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
979b1897c19SJulian Elischer
980a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
98151be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
98251be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
98349993db0SRobert Watsonoptions 	UFS_EXTATTR
98449993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
985a64ed089SRobert Watson
98651be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
98751be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
98851be6918SChris D. Faulhaber# for the underlying filesystem.
98951be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
99051be6918SChris D. Faulhaberoptions 	UFS_ACL
99151be6918SChris D. Faulhaber
9929b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
9939b5ad47fSIan Dowse# directories at the expense of some memory.
9949b5ad47fSIan Dowseoptions 	UFS_DIRHASH
9959b5ad47fSIan Dowse
996f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
997f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
998f348204cSPawel Jakub Dawidek
99971e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
100071e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
100171e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
100271e4fff8SPoul-Henning Kamp
100371e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
100471e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
100571e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1006d52d7365SPoul-Henning Kamp
1007495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10082365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10096a8d6623SGarrett Wollman
1010276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1011276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1012276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1013276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1014ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10156110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1016276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1017276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
1018276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
1019276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1020276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1021276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1022cb800e34SJulian Elischer#
1023cb800e34SJulian Elischeroptions 	SUIDDIR
1024cb800e34SJulian Elischer
1025df394affSJohn-Mark Gurney# NFS options:
10265895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10275895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10285895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10295895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10305895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10315895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1032df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1033df394affSJohn-Mark Gurney
10349afcea2fSRobert V. Baron# Coda stuff:
10359afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1036f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1037d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1038d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1039d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1040a1d55890SJordan K. Hubbard
1041053a2b61SEivind Eklund#
1042053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1043053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1044053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1045053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1046053a2b61SEivind Eklund#
10475895e3c8SPeter Wemmoptions 	EXT2FS
1048053a2b61SEivind Eklund
1049fe98fb32SJean-Sébastien Pédron#
1050fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1051fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1052fe98fb32SJean-Sébastien Pédron#
1053fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1054fe98fb32SJean-Sébastien Pédron
10557b30d718SCraig Rodrigues#
10567b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
10577b30d718SCraig Rodrigues# this is limited to read-only access.
10587b30d718SCraig Rodrigues#
10597b30d718SCraig Rodriguesoptions 	XFS
10607b30d718SCraig Rodrigues
1061dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
10620cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
10630cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1064dd85920aSJason Evansoptions 	VFS_AIO
1065053a2b61SEivind Eklund
10668ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1067ac519db0SMark Murraydevice		random
106815bbdecfSMark Murray
10698ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
10708ab2f5ecSMark Murraydevice		mem
10718ab2f5ecSMark Murray
1072c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1073c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1074c4f02a89SMax Khonoptions 	CD9660_ICONV
1075c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1076c4f02a89SMax Khonoptions 	NTFS_ICONV
1077126f0dfaSScott Longoptions 	UDF_ICONV
1078c4f02a89SMax Khon
10796a8d6623SGarrett Wollman
10806a8d6623SGarrett Wollman#####################################################################
1081abc97a06SBruce Evans# POSIX P1003.1B
1082abc97a06SBruce Evans
10831c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1084abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1085abc97a06SBruce Evans
10865895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
10878cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
10888cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
10893ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1090abc97a06SBruce Evans
10915b40ce27SDavid Xu# POSIX message queue
10925b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1093abc97a06SBruce Evans
1094abc97a06SBruce Evans#####################################################################
109512e9f256SRobert Watson# SECURITY POLICY PARAMETERS
109612e9f256SRobert Watson
1097fdcba197SRobert Watson# Support for BSM audit
1098fdcba197SRobert Watsonoptions 	AUDIT
1099fdcba197SRobert Watson
1100cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1101cd6d1d76SBruce Evansoptions 	MAC
1102eae2f20cSRobert Watsonoptions 	MAC_BIBA
1103eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1104eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1105c4725737SRobert Watsonoptions 	MAC_LOMAC
1106eae2f20cSRobert Watsonoptions 	MAC_MLS
1107eae2f20cSRobert Watsonoptions 	MAC_NONE
1108eae2f20cSRobert Watsonoptions 	MAC_PARTITION
110903d03162SRobert Watsonoptions 	MAC_PORTACL
1110eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1111782f7255SRobert Watsonoptions 	MAC_STUB
1112eae2f20cSRobert Watsonoptions 	MAC_TEST
111312e9f256SRobert Watson
111412e9f256SRobert Watson
111512e9f256SRobert Watson#####################################################################
1116000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1117000033d0SJeroen Ruigrok van der Werven
1118000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1119358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1120358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1121358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1122358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1123358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1124358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1125358f8d82SRobert Watson# actually reducing the accuracy of operation.
1126000033d0SJeroen Ruigrok van der Werven
1127000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1128000033d0SJeroen Ruigrok van der Werven
1129f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1130f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1131f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1132f309f881SJohn Baldwin
1133f309f881SJohn Baldwinoptions 	PPS_SYNC
1134f309f881SJohn Baldwin
1135000033d0SJeroen Ruigrok van der Werven
1136000033d0SJeroen Ruigrok van der Werven#####################################################################
1137de6a307eSPeter Dufault# SCSI DEVICES
1138de6a307eSPeter Dufault
11396a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11406a8d6623SGarrett Wollman
11416a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1142ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
11436a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
11446a8d6623SGarrett Wollman# device configuration sections below.
11456a8d6623SGarrett Wollman#
1146e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1147e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1148e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1149e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1150e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1151e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1152e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1153e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1154e14eb5a1SGarrett Wollman# problem.)
1155ebc1a0e2SPeter Dufault
1156ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1157ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1158700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1159700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1160ebc1a0e2SPeter Dufault
1161ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1162ebc1a0e2SPeter Dufault
1163f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1164f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1165f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1166f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1167f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1168f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1169f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1170f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1171f71c01ccSPeter Wemmhint.da.0.target="0"
1172f71c01ccSPeter Wemmhint.da.0.unit="0"
1173f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1174f71c01ccSPeter Wemmhint.da.1.target="1"
1175f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1176f71c01ccSPeter Wemmhint.da.2.target="3"
1177f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1178f71c01ccSPeter Wemmhint.sa.1.target="6"
1179ebc1a0e2SPeter Dufault
1180ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1181ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1182ebc1a0e2SPeter Dufault
1183ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1184ebc1a0e2SPeter Dufault
1185cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1186cf2458c9SMatt Jacob#
1187cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1188cf2458c9SMatt Jacob# ("WORM") devices.
1189cf2458c9SMatt Jacob#
1190cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1191cf2458c9SMatt Jacob#
1192cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1193cf2458c9SMatt Jacob#
11943c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
11953c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1196cf2458c9SMatt Jacob#
1197cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1198cf2458c9SMatt Jacob#
11991eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12001eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12011eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
12021eba4c79SScott Long# source level API compatiblity for porting apps to FreeBSD.
1203cf2458c9SMatt Jacob#
1204cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1205cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1206cf2458c9SMatt Jacob#
1207cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1208cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1209cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1210cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1211cf2458c9SMatt Jacob#
1212cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1213cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1214cf2458c9SMatt Jacob# to them.
1215cf2458c9SMatt Jacob#
1216265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1217cf2458c9SMatt Jacob# configuration as the "pass" driver.
1218ebc1a0e2SPeter Dufault
1219c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1220c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1221c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1222c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1223c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
122464ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1225cf2458c9SMatt Jacobdevice		pt		#SCSI processor
122664ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
122764ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1228cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12291eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
12308909a72bSPeter Dufault
1231700daf5eSJustin T. Gibbs# CAM OPTIONS:
1232700daf5eSJustin T. Gibbs# debugging options:
1233700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1234700daf5eSJustin T. Gibbs#             specify them all!
1235700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1236700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1237700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1238700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1239d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1240d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1241700daf5eSJustin T. Gibbs#
1242700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1243700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1244700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
124556234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
124656234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
12473a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
12483a937198SBrooks Davis#             can be changed at boot and runtime with the
12493a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1250700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
12515895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
12525895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
12535895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
125425388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
12555895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1256700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1257700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
125832672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
12591a7c583cSGarrett Wollman
1260700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1261700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1262700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1263700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1264700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1265700daf5eSJustin T. Gibbs# respectively.
126693063432SJoerg Wunsch#
1267700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1268700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1269700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
127093063432SJoerg Wunsch#
12715895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
12725895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
127393063432SJoerg Wunsch
12749dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1275b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
12769dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
12779dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
12789dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
12799f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
128025388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
128125388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
128225388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
128325388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
12849f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
12859dfb4471SKenneth D. Merry
12863ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
12873ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
128825388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
12893ece1bd2SKenneth D. Merry
12908904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
12918904e70bSMatt Jacob#
12928904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
12938904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
12948904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
12958904e70bSMatt Jacob# are in....
12968904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
12978904e70bSMatt Jacob
12986a8d6623SGarrett Wollman
12996a8d6623SGarrett Wollman#####################################################################
13006a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13016a8d6623SGarrett Wollman
13021160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
13031160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
13041160da92SJoerg Wunsch# `xterm', among others.
13051160da92SJoerg Wunsch
1306f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
13076d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1308f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1309f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1310efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13116aec1278SMax Laierdevice		firmware	#firmware(9) support
1312be174c7eSGreg Lehey
13136f2d8adbSBoris Popov# Kernel side iconv library
13146f2d8adbSBoris Popovoptions 	LIBICONV
13156f2d8adbSBoris Popov
131658067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13175895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
131858067a99SPoul-Henning Kamp
13199c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
13209c62b3eeSDavid Schultzoptions 	TTYHOG=8193
13219c62b3eeSDavid Schultz
13226a8d6623SGarrett Wollman
13236a8d6623SGarrett Wollman#####################################################################
1324d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1325d61e6649SAlexander Langer
1326d61e6649SAlexander Langer# For ISA the required hints are listed.
13275bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13285bcb64f2SWarner Losh# no hints are needed.
1329d61e6649SAlexander Langer
1330d61e6649SAlexander Langer#
1331d61e6649SAlexander Langer# Mandatory devices:
1332d61e6649SAlexander Langer#
1333d61e6649SAlexander Langer
13346e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13356e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13366e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13376e818956SDavid E. O'Brien
13387f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13397f5092f3SJohn Baldwin
1340837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1341837f167eSRuslan Ermilov
1342905e8b43SDag-Erling Smørgrav# Various screen savers.
1343905e8b43SDag-Erling Smørgravdevice		blank_saver
1344905e8b43SDag-Erling Smørgravdevice		daemon_saver
1345905e8b43SDag-Erling Smørgravdevice		dragon_saver
1346905e8b43SDag-Erling Smørgravdevice		fade_saver
1347905e8b43SDag-Erling Smørgravdevice		fire_saver
1348905e8b43SDag-Erling Smørgravdevice		green_saver
1349905e8b43SDag-Erling Smørgravdevice		logo_saver
1350905e8b43SDag-Erling Smørgravdevice		rain_saver
1351905e8b43SDag-Erling Smørgravdevice		snake_saver
1352905e8b43SDag-Erling Smørgravdevice		star_saver
1353905e8b43SDag-Erling Smørgravdevice		warp_saver
1354905e8b43SDag-Erling Smørgrav
13551c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1356f453022cSPeter Wemmdevice		sc
1357f71c01ccSPeter Wemmhint.sc.0.at="isa"
1358683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
13596e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
13606e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1361cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1362e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1363c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
13646e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
13656e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
13666e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
136785e36760SJordan K. Hubbard
13687a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
136925388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
137025388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
137125388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
137225388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
13737a88382dSKazutaka YOKOTA
137478f45204SMaxim Sobolev# The following options will let you change the default behaviour of
137578f45204SMaxim Sobolev# cut-n-paste feature
137678f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
137725388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
137825388b6cSBruce Evans					# (default is single space - \"x20\")
137978f45204SMaxim Sobolev
13807a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
13817a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
13827a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
13837a88382dSKazutaka YOKOTA
13846e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
13856e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
13866e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
13876e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
13886e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
13896e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1390c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
13912ac8be82SAndreas Schulz
13928a28ce0eSJohn Baldwin# `flags' for sc
13938a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
13948a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
13958a28ce0eSJohn Baldwin
13961fe04850SBruce Evans#
1397d61e6649SAlexander Langer# Optional devices:
13986a8d6623SGarrett Wollman#
13996a8d6623SGarrett Wollman
14006a8d6623SGarrett Wollman#
1401d61e6649SAlexander Langer# SCSI host adapters:
14026a8d6623SGarrett Wollman#
14037f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1404859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14056e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14067f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1407d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1408d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1409cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14107f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1411d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1412d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14136e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14146e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14151b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1416d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1417d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1418d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1419e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1420e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1421af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1422ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
142364fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
142464fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1425d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1426fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1427fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1428fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1429fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1430f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14316e818956SDavid E. O'Brien# wds: WD7000
1432d61e6649SAlexander Langer
14336e818956SDavid E. O'Brien#
14346e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14356e818956SDavid E. O'Brien# probed correctly.
14366e818956SDavid E. O'Brien#
14376e818956SDavid E. O'Briendevice		bt
14386e818956SDavid E. O'Brienhint.bt.0.at="isa"
14396e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14407f5092f3SJohn Baldwindevice		adv
14417f5092f3SJohn Baldwinhint.adv.0.at="isa"
1442c9953c3bSPeter Wemmdevice		adw
14436e818956SDavid E. O'Briendevice		aha
14446e818956SDavid E. O'Brienhint.aha.0.at="isa"
14457f5092f3SJohn Baldwindevice		aic
14467f5092f3SJohn Baldwinhint.aic.0.at="isa"
14477f5092f3SJohn Baldwindevice		ahb
1448d61e6649SAlexander Langerdevice		ahc
1449cdd49e97SJustin T. Gibbsdevice		ahd
1450d61e6649SAlexander Langerdevice		amd
14511b946e21SScott Longdevice		esp
1452c5933b20SScott Longdevice		iscsi_initiator
1453d61e6649SAlexander Langerdevice		isp
14540787f2b8SMatt Jacobhint.isp.0.disable="1"
14550787f2b8SMatt Jacobhint.isp.0.role="3"
14560787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
14570787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
14580787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
14590787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
14600787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
14610787f2b8SMatt Jacobhint.isp.0.topology="lport"
14620787f2b8SMatt Jacobhint.isp.0.topology="nport"
14630787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
14640787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
14650787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
14660787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
14670787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
14680787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1469d61e6649SAlexander Langerdevice		ispfw
147064fa5108SMatt Jacobdevice		mpt
1471d61e6649SAlexander Langerdevice		ncr
1472d61e6649SAlexander Langerdevice		sym
1473f3d92b26SOlivier Houcharddevice		trm
14746e818956SDavid E. O'Briendevice		wds
14756e818956SDavid E. O'Brienhint.wds.0.at="isa"
14766e818956SDavid E. O'Brienhint.wds.0.port="0x350"
14776e818956SDavid E. O'Brienhint.wds.0.irq="11"
14786e818956SDavid E. O'Brienhint.wds.0.drq="6"
1479d61e6649SAlexander Langer
1480d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1481d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1482d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1483d61e6649SAlexander Langer# default.
1484d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1485d61e6649SAlexander Langer
1486fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1487fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1488fac70739SJeroen Ruigrok van der Werven
1489fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1490fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1491fac70739SJeroen Ruigrok van der Werven
1492662d3818SScott Long# Compile in Aic7xxx Debugging code.
1493662d3818SScott Longoptions 	AHC_DEBUG
1494662d3818SScott Long
1495662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1496662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1497662d3818SScott Long
1498f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1499f8f8803bSBruce Evans# See ahc(4).
1500662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1501662d3818SScott Long
1502cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1503cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1504cdd49e97SJustin T. Gibbs
1505f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1506cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1507cdd49e97SJustin T. Gibbs
150843e9d8a3SScott Long# Print human-readable register definitions when debugging
150943e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
151043e9d8a3SScott Long
1511662d3818SScott Long# Bitmap of units to enable targetmode operations.
1512662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1513662d3818SScott Long
1514d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1515d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1516d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1517d61e6649SAlexander Langer
1518c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1519c5933b20SScott Long#
1520c5933b20SScott Longoptions		ISCSI_INITIATOR_DEBUG=9
1521c5933b20SScott Long
1522d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1523d61e6649SAlexander Langer#
1524d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1525d61e6649SAlexander Langer#
152664fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1527af606348SMatt Jacob#
15289a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15299a1b0d43SMatt Jacob#		none=0
15309a1b0d43SMatt Jacob#		target=1
15319a1b0d43SMatt Jacob#		initiator=2
15329a1b0d43SMatt Jacob#		both=3			(not supported currently)
1533af606348SMatt Jacob#
15349a1b0d43SMatt Jacoboptions 	ISP_DEFAULT_ROLES=2
1535d61e6649SAlexander Langer
1536d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1537d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1538d61e6649SAlexander Langer					# Allows the ncr to take precedence
1539d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1540d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1541d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1542d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1543d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1544d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1545d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1546d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1547d61e6649SAlexander Langer					# default:8, range:[1..64]
15486a8d6623SGarrett Wollman
15496e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
15506e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
15516e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
15526e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
15536e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
15546e818956SDavid E. O'Brien#
15556e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
15566e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
15576e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
15586e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
15596e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
15606e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
15616e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
15626e818956SDavid E. O'Brien#                           option will create more trouble than solve.
15636e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
15646e818956SDavid E. O'Brien#                           wait when timing out with the above option.
15656e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
15666e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
15676e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
15686e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
15696e818956SDavid E. O'Brien#                           cost, great benefit.
15706e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
15716e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
15726e818956SDavid E. O'Brien#			    are 100% certain you need it.
15736e818956SDavid E. O'Brien
15746e818956SDavid E. O'Briendevice		dpt
15756e818956SDavid E. O'Brien
15766e818956SDavid E. O'Brien# DPT options
15776e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
15786e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
15796e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
15806e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
15816e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
15826e818956SDavid E. O'Brien
15836e818956SDavid E. O'Brien#
15846e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
15856e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
15866e818956SDavid E. O'Brien# CAM infrastructure.
15876e818956SDavid E. O'Brien#
15886e818956SDavid E. O'Briendevice		ciss
15896e818956SDavid E. O'Brien
15906e818956SDavid E. O'Brien#
15916e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
15926e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
15936e818956SDavid E. O'Brien# at Intel for this driver are
15946e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
15956e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
15966e818956SDavid E. O'Brien#
15976e818956SDavid E. O'Briendevice		iir
15986e818956SDavid E. O'Brien
15996e818956SDavid E. O'Brien#
16006e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16016e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16026e818956SDavid E. O'Brien# the CAM infrastructure.
16036e818956SDavid E. O'Brien#
16046e818956SDavid E. O'Briendevice		mly
16056e818956SDavid E. O'Brien
16066e818956SDavid E. O'Brien#
16076e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16086e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16096e818956SDavid E. O'Brien# controllers.
16106e818956SDavid E. O'Brien#
16116e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16126e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16136e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
16147f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1615f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16166b31d3f7SScott Longoptions 	MFI_DEBUG
16176e818956SDavid E. O'Brien
16186e818956SDavid E. O'Brien#
16196e818956SDavid E. O'Brien# 3ware ATA RAID
16206e818956SDavid E. O'Brien#
16216e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16226e818956SDavid E. O'Brien
162390d3341eSPeter Wemm#
16246d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16256d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16266d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1627c9953c3bSPeter Wemmdevice		ata
1628c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1629ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1630c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1631c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1632c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1633c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1634fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
16358b89ef0aSSøren Schmidt#
16366d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
16376d04301dSAlexander Langerhint.ata.0.at="isa"
16386d04301dSAlexander Langerhint.ata.0.port="0x1f0"
16396d04301dSAlexander Langerhint.ata.0.irq="14"
16406d04301dSAlexander Langerhint.ata.1.at="isa"
16416d04301dSAlexander Langerhint.ata.1.port="0x170"
16426d04301dSAlexander Langerhint.ata.1.irq="15"
16436d04301dSAlexander Langer
16446d04301dSAlexander Langer#
1645000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1646000da71aSSøren Schmidt#
1647000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
164874d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
164974d8e840SSøren Schmidt
165074d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
165174d8e840SSøren Schmidt
16528b89ef0aSSøren Schmidt#
16536d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
16546d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
16556a8d6623SGarrett Wollman#
1656f71c01ccSPeter Wemmdevice		fdc
1657f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1658f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1659f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1660f71c01ccSPeter Wemmhint.fdc.0.drq="2"
166185827d9cSJoerg Wunsch#
1662d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1663d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1664d2fb4892SJoerg Wunsch# however.
1665d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1666d2fb4892SJoerg Wunsch#
1667f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1668f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1669f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1670f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
167185827d9cSJoerg Wunsch
1672f71c01ccSPeter Wemm# Specify floppy devices
1673f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1674f71c01ccSPeter Wemmhint.fd.0.drive="0"
1675f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1676f71c01ccSPeter Wemmhint.fd.1.drive="1"
167785827d9cSJoerg Wunsch
16786a8d6623SGarrett Wollman#
1679501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1680501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1681c8956b36SMarcel Moolenaar#
1682501ef98fSMarcel Moolenaardevice		uart
1683501ef98fSMarcel Moolenaar
16848194412bSMarcel Moolenaar# Options for uart(4)
16858194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
16868194412bSMarcel Moolenaar					# instead of DCD.
16878194412bSMarcel Moolenaar
1688501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1689501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1690501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1691501ef98fSMarcel Moolenaar
1692c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1693c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1694c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1695c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1696c8956b36SMarcel Moolenaar# unit number of the probed UART.
1697501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1698501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1699501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1700501ef98fSMarcel Moolenaar
1701501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1702c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1703c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1704c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1705c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1706c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1707c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1708c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1709c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1710c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1711c8956b36SMarcel Moolenaar#		as debug port.
17129546766aSBruce Evans#
17139546766aSBruce Evans
1714501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1715c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1716c8956b36SMarcel Moolenaar					# ddb, if available.
17176a8d6623SGarrett Wollman
171826b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
171926b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
172026b6ea69SPaul Saab# Sun servers by the Remote Console.
172126b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
172226b6ea69SPaul Saab
1723af2e25a6SMarcel Moolenaar# Serial Communications Controller
1724af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1725af2e25a6SMarcel Moolenaar# communications controllers.
1726af2e25a6SMarcel Moolenaardevice		scc
1727af2e25a6SMarcel Moolenaar
17289c564b6cSJohn Hay# PCI Universal Communications driver
172964220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17309c564b6cSJohn Haydevice		puc
17319c564b6cSJohn Hay
17326a8d6623SGarrett Wollman#
1733d61e6649SAlexander Langer# Network interfaces:
17346a8d6623SGarrett Wollman#
1735d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1736d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17373c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1738d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1739d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1740d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1741d61e6649SAlexander Langer# individual driver.
1742d61e6649SAlexander Langerdevice		miibus
1743d61e6649SAlexander Langer
17447f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
17457f5092f3SJohn Baldwin#       PCI and ISA varieties.
17467f5092f3SJohn Baldwin# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
17477f5092f3SJohn Baldwin#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
1748343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1749343ed0a8SJohn Baldwin#       adapters.
1750343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
175195d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1752586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1753586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1754586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
17557f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
17567f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
17577f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
1758d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1759d61e6649SAlexander Langer#       and various workalikes including:
1760d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1761d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1762d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1763d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1764d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1765d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1766d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1767d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1768d61e6649SAlexander Langer#       KNE110TX.
1769d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1770a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
177196a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
17727f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
17737f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
17747f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
17757f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
17767f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
17777f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1778d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1779d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1780cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
17811ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
178252c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
178344ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1784c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1785c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1786c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1787c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1788c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1789c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1790c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
17912bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1792d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1793ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1794ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1795ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1796cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1797cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
179841f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
17990fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
18000fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
18010fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
18020fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
18030fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1804d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1805d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1806d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1807d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1808d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1809d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1810d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1811d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1812d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1813d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1814d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1815d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1816d61e6649SAlexander Langer#       card which is 32-bit.
1817b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1818b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
18197d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1820d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1821d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1822d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1823d61e6649SAlexander Langer#       (also single mode and multimode).
1824d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1825d61e6649SAlexander Langer#       attach each one as a separate network interface.
18267f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
18277f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1828d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1829d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1830d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1831d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1832d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1833d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1834d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1835c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1836c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1837d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1838d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1839d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1840d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1841d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
18423c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1843362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1844d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1845d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1846d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1847d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1848d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1849d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1850d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1851d61e6649SAlexander Langer#       NE2000 clone.
18527f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
18537f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
18547f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
18557f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
18567f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
18577f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1858d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1859d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1860d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1861d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1862d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1863d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1864d61e6649SAlexander Langer
18657f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
18667f5092f3SJohn Baldwin
18677f5092f3SJohn Baldwindevice		cm
18687f5092f3SJohn Baldwinhint.cm.0.at="isa"
18697f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
18707f5092f3SJohn Baldwinhint.cm.0.irq="9"
18717f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
18727f5092f3SJohn Baldwindevice		ep
18737f5092f3SJohn Baldwindevice		ex
1874c06a3350SPeter Wemmdevice		fe
18757f5092f3SJohn Baldwinhint.fe.0.at="isa"
18767f5092f3SJohn Baldwinhint.fe.0.port="0x300"
18777f5092f3SJohn Baldwindevice		fea
18787f5092f3SJohn Baldwindevice		sn
18797f5092f3SJohn Baldwinhint.sn.0.at="isa"
18807f5092f3SJohn Baldwinhint.sn.0.port="0x300"
18817f5092f3SJohn Baldwinhint.sn.0.irq="10"
18827f5092f3SJohn Baldwindevice		an
18837f5092f3SJohn Baldwindevice		awi
18847f5092f3SJohn Baldwindevice		cnw
18857f5092f3SJohn Baldwindevice		wi
18867f5092f3SJohn Baldwindevice		xe
18877f5092f3SJohn Baldwin
1888d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1889343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1890343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1891343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
18928090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
1893404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
1894d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
18954664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
18964664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
18971ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
189852c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
1899343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
1900d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1901343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
1902d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
19032e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1904d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
19057d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1906d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1907343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1908d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1909343ed0a8SJohn Baldwindevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
1910d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1911eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1912d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1913d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1914d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1915d61e6649SAlexander Langer
1916d61e6649SAlexander Langer# PCI Ethernet NICs.
1917d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
1918c6c22d35SJack F Vogel#device		em		# Intel Pro/1000 Gigabit Ethernet
1919c6c22d35SJack F Vogel#device		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
1920c6c22d35SJack F Vogel#device		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
192144ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
1922f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
1923fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
192495d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1925c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1926d61e6649SAlexander Langer
1927343ed0a8SJohn Baldwin# PCI FDDI NICs.
1928c06a3350SPeter Wemmdevice		fpa
1929d61e6649SAlexander Langer
19302bc6081cSScott Long# PCI WAN adapters.
19312bc6081cSScott Longdevice		lmc
19322bc6081cSScott Long
193398cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
193498cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
193598cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
193698cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
193798cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
193898cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
193998cb733cSKenneth D. Merry
19402c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
19412c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
19422c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
19432c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
19442c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
19452c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
19462c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
19472c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
19482c8f5a28SKenneth D. Merry
194968713f97SKenjiro Cho#
195044b5247dSKenjiro Cho# ATM related options (Cranor version)
195144b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
195268713f97SKenjiro Cho#
195368713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
195468713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
195568713f97SKenjiro Cho#
1956c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1957c594298bSHartmut Brandt# ATM PCI cards.
1958c594298bSHartmut Brandt#
1959fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1960fb24f088SHartmut Brandt#
19618dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
19628dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
19638dd4275cSHartmut Brandt#
1964f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
196568713f97SKenjiro Cho# atm devices.
19663cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
196768713f97SKenjiro Cho# bypass TCP/IP.
196868713f97SKenjiro Cho#
1969fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1970fb24f088SHartmut Brandt# hatm and fatm.
19711ba46a03SHartmut Brandt#
197268713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
197368713f97SKenjiro Cho# for more details, please read the original documents at
197498a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
197568713f97SKenjiro Cho#
1976f71c01ccSPeter Wemmdevice		atm
197744b5247dSKenjiro Chodevice		en
1978fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1979c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
19808dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
19811ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
19823cbceb82SKenjiro Chooptions 	NATM			#native ATM
1983f4567b9cSJulian Elischer
19847e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
19857e9024cdSHartmut Brandt
1986c19da41eSPeter Wemm#
19870739ea1dSSeigo Tanimura# Sound drivers
1988c19da41eSPeter Wemm#
19890739ea1dSSeigo Tanimura# sound: The generic sound driver.
1990c7406082SJohn-Mark Gurney#
19910739ea1dSSeigo Tanimura
19920739ea1dSSeigo Tanimuradevice		sound
19930739ea1dSSeigo Tanimura
19940739ea1dSSeigo Tanimura#
19950739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
1996c7406082SJohn-Mark Gurney#
19977f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
19987f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
19997f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
20007f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
20017f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
20027f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
20037f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
20047f5092f3SJohn Baldwin#
2005c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
20060739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2007d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2008903b2fb9SJoel Dahl# snd_au88x0		Aureal Vortex 1/2/Advantage PCI. This driver
2009903b2fb9SJoel Dahl#			lacks support for playback and recording.
2010903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2011903b2fb9SJoel Dahl#			for sparc64.
20120739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
20130739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
20140739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
20150739ea1dSSeigo Tanimura#			4281)
20160739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
20170739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20180fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20199f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20209f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20210739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2022727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2023727ded3aSJoel Dahl#			conjunction with snd_sbc.
20240739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20250739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
20264b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20274b8939a1SAriff Abdullah#			compatible.
20280739ea1dSSeigo Tanimura# snd_ich:		Intel ICH PCI and some more audio controllers
2029903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2030903b2fb9SJoel Dahl#			nForce controllers.
20310739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
20320739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20330739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
20340739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20350739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
20361c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20370739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
20381c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20390739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
20407f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
20419f548240SAlexander Leidinger# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
20420739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2043903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20440739ea1dSSeigo Tanimura#			M5451 PCI.
20450739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20460739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20470739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
20480739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
204981bb901eSPeter Wemm
2050f37a929cSPeter Wemmdevice		snd_ad1816
2051f37a929cSPeter Wemmdevice		snd_als4000
2052d9bde1adSAriff Abdullahdevice		snd_atiixp
2053f37a929cSPeter Wemm#device		snd_au88x0
20547a7386a3SPyun YongHyeon#device		snd_audiocs
20550739ea1dSSeigo Tanimuradevice		snd_cmi
2056f37a929cSPeter Wemmdevice		snd_cs4281
20570739ea1dSSeigo Tanimuradevice		snd_csa
2058f37a929cSPeter Wemmdevice		snd_ds1
2059f37a929cSPeter Wemmdevice		snd_emu10k1
20600fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2061b1ff0220SAlexander Leidingerdevice		snd_envy24
20629f548240SAlexander Leidingerdevice		snd_envy24ht
2063f37a929cSPeter Wemmdevice		snd_es137x
20640739ea1dSSeigo Tanimuradevice		snd_ess
2065f37a929cSPeter Wemmdevice		snd_fm801
20660739ea1dSSeigo Tanimuradevice		snd_gusc
20674b8939a1SAriff Abdullahdevice		snd_hda
20680739ea1dSSeigo Tanimuradevice		snd_ich
20690739ea1dSSeigo Tanimuradevice		snd_maestro
2070f37a929cSPeter Wemmdevice		snd_maestro3
20710739ea1dSSeigo Tanimuradevice		snd_mss
20720739ea1dSSeigo Tanimuradevice		snd_neomagic
2073f37a929cSPeter Wemmdevice		snd_sb16
2074f37a929cSPeter Wemmdevice		snd_sb8
20750739ea1dSSeigo Tanimuradevice		snd_sbc
20760739ea1dSSeigo Tanimuradevice		snd_solo
20779f548240SAlexander Leidingerdevice		snd_spicds
2078f37a929cSPeter Wemmdevice		snd_t4dwave
2079f37a929cSPeter Wemmdevice		snd_via8233
2080f37a929cSPeter Wemmdevice		snd_via82c686
20810739ea1dSSeigo Tanimuradevice		snd_vibes
20820739ea1dSSeigo Tanimuradevice		snd_uaudio
2083c19da41eSPeter Wemm
20841c9c6382SRuslan Ermilov# For non-PnP sound cards:
2085673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2086673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2087673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2088673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2089673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2090673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2091673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2092673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2093673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2094673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2095673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2096673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2097673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2098673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
20997f5092f3SJohn Baldwin
21006a8d6623SGarrett Wollman#
210183820457SPoul-Henning Kamp# IEEE-488 hardware:
210283820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2103346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2104346fa631SPoul-Henning Kamp
210583820457SPoul-Henning Kampdevice	pcii
210683820457SPoul-Henning Kamphint.pcii.0.at="isa"
210783820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
210883820457SPoul-Henning Kamphint.pcii.0.irq="5"
210983820457SPoul-Henning Kamphint.pcii.0.drq="1"
211083820457SPoul-Henning Kamp
2111346fa631SPoul-Henning Kampdevice	tnt4882
2112346fa631SPoul-Henning Kamp
211383820457SPoul-Henning Kamp#
2114567e21c2SBruce Evans# Miscellaneous hardware:
21156a8d6623SGarrett Wollman#
21166fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
21173ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
21181c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
21192849b131SBruce Evans# cy: Cyclades serial driver
21207f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2121787f1498SJohn Baldwin# rc: RISCom/8 multiport card
2122dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
21237f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
2124603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2125657e73c4SPeter Dufault
21263b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
21273b577e1fSJordan K. Hubbard#
21283b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
21293b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
21303b577e1fSJordan K. Hubbard#
2131f71c01ccSPeter Wemm#               device  rp	# core driver support
2132f71c01ccSPeter Wemm#
21333b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
2134b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2135b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
21363b577e1fSJordan K. Hubbard#
21373b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
21383b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
2139f71c01ccSPeter Wemm#   your kernel probe hints:
2140b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2141b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
2142b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2143b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
21443b577e1fSJordan K. Hubbard#
21453b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
2146b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2147b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
2148b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2149b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
2150b147fcf9SBruce Evans#		hint.rp.2.at="isa"
2151b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
2152b147fcf9SBruce Evans#		hint.rp.3.at="isa"
2153b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
21543b577e1fSJordan K. Hubbard#
2155dd267672SJohn Baldwin#   For PCI cards, you need no hints.
21563b577e1fSJordan K. Hubbard
21573ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
21583ae5b532SMatthew N. Dodddevice		mcd
21593ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
21603ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
21616fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
21626fe8789dSMatthew N. Dodddevice		scd
21636fe8789dSMatthew N. Doddhint.scd.0.at="isa"
21646fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
21651c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
21667f5092f3SJohn Baldwinhint.joy.0.at="isa"
21677f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2168787f1498SJohn Baldwindevice		rc
2169787f1498SJohn Baldwinhint.rc.0.at="isa"
2170787f1498SJohn Baldwinhint.rc.0.port="0x220"
2171787f1498SJohn Baldwinhint.rc.0.irq="12"
2172f71c01ccSPeter Wemmdevice		rp
21737f5092f3SJohn Baldwinhint.rp.0.at="isa"
21747f5092f3SJohn Baldwinhint.rp.0.port="0x280"
21757f5092f3SJohn Baldwindevice		si
21767f5092f3SJohn Baldwinoptions 	SI_DEBUG
21777f5092f3SJohn Baldwinhint.si.0.at="isa"
21787f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
21797f5092f3SJohn Baldwinhint.si.0.irq="12"
2180603d67aeSRink Springerdevice		cmx
2181a800f455SJulian Elischer
2182eeb706c0SJustin T. Gibbs#
2183a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
21841c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2185a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
21861c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
21871c2b5939SRoger Hardiman#
2188a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2189a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2190a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2191a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
21921c2b5939SRoger Hardiman# These options can be used to override the auto detection
219398a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
21941c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
21959ff07e32SAmancio Hasty#
21964f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
21971c2b5939SRoger Hardiman# or
21981c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
21993c7c6c12SMike Pritchard# Specifies the default video capture mode.
2200a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2201a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2202a9c5b8d0SSøren Schmidt#
22034f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2204a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2205a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2206a9c5b8d0SSøren Schmidt#
22071c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
22081c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
22091c2b5939SRoger Hardiman#
22101c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
22111c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
22121c2b5939SRoger Hardiman#
22131c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
22141c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
22151c2b5939SRoger Hardiman#
22161c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
22171c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
22181c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
22191c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
22201c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
22211c2b5939SRoger Hardiman# As a rough guess, old = before 1998
22221c2b5939SRoger Hardiman#
222330e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
222430e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
222530e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
222630e27d96SAlexander Langer# mono sound.
2227017b0edcSMatt Jacob
2228c17d4340SNicolas Souchu#
2229c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2230c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2231c17d4340SNicolas Souchu#
223228ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
22330f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
223437973e86SPeter Wemm#     device smbus
223537973e86SPeter Wemm#     device iicbus
223637973e86SPeter Wemm#     device iicbb
2237c17d4340SNicolas Souchu#     device iicsmb
22380f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
22390f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
224028ebb692SNicolas Souchu#
2241c06a3350SPeter Wemmdevice		bktr
2242446cee6eSJoerg Wunsch
2243dc9deb29SPoul-Henning Kamp#
22446e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
22456e818956SDavid E. O'Brien#
22465bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
22476e818956SDavid E. O'Brien# pccard: pccard slots
22486e818956SDavid E. O'Brien# cardbus: cardbus slots
22496e818956SDavid E. O'Briendevice		cbb
22506e818956SDavid E. O'Briendevice		pccard
22516e818956SDavid E. O'Briendevice		cardbus
22526e818956SDavid E. O'Brien
22536e818956SDavid E. O'Brien#
22545bcb64f2SWarner Losh# MMC/SD
22555bcb64f2SWarner Losh#
22565bcb64f2SWarner Losh# mmc: mmc bus
22575bcb64f2SWarner Losh# mmcsd: mmc memory and sd cards.
22585bcb64f2SWarner Losh#device		mmc
22595bcb64f2SWarner Losh#device		mmcsd
22605bcb64f2SWarner Losh
22615bcb64f2SWarner Losh#
22628afa373cSNicolas Souchu# SMB bus
22638afa373cSNicolas Souchu#
22643c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
22653c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
22663c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
22678afa373cSNicolas Souchu#
22688afa373cSNicolas Souchu# Supported devices:
22694d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
22708afa373cSNicolas Souchu#
22713c5656bfSArchie Cobbs# Supported SMB interfaces:
227228ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
227328ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
22747f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
22757f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
22767f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
22777f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2278b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
22794d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
228044e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
22814d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
22828afa373cSNicolas Souchu#
2283c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
22843c5656bfSArchie Cobbs
22857f5092f3SJohn Baldwindevice		intpm
22867f5092f3SJohn Baldwindevice		alpm
22877f5092f3SJohn Baldwindevice		ichsmb
22887f5092f3SJohn Baldwindevice		viapm
228944e6ce01SNicolas Souchudevice		amdpm
22904d5f30e0SRuslan Ermilovdevice		amdsmb
229144e6ce01SNicolas Souchudevice		nfpm
22924d5f30e0SRuslan Ermilovdevice		nfsmb
22937f5092f3SJohn Baldwin
2294c9953c3bSPeter Wemmdevice		smb
22958afa373cSNicolas Souchu
22968afa373cSNicolas Souchu#
22978afa373cSNicolas Souchu# I2C Bus
22988afa373cSNicolas Souchu#
22998afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
23008afa373cSNicolas Souchu#
23018afa373cSNicolas Souchu# Supported devices:
23028afa373cSNicolas Souchu# ic	i2c network interface
23038afa373cSNicolas Souchu# iic	i2c standard io
2304f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
23058afa373cSNicolas Souchu#
23068afa373cSNicolas Souchu# Supported interfaces:
230728ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
230828ebb692SNicolas Souchu#
230928ebb692SNicolas Souchu# Other:
231028ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
23118afa373cSNicolas Souchu#
2312c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2313c9953c3bSPeter Wemmdevice		iicbb
23148afa373cSNicolas Souchu
2315c9953c3bSPeter Wemmdevice		ic
2316c9953c3bSPeter Wemmdevice		iic
2317c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
23188afa373cSNicolas Souchu
2319ab4c624bSMike Smith# Parallel-Port Bus
2320ab4c624bSMike Smith#
2321ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2322ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2323ab4c624bSMike Smith# are automatically probed and attached when found.
2324ab4c624bSMike Smith#
2325ab4c624bSMike Smith# Supported devices:
2326ab4c624bSMike Smith# vpo	Iomega Zip Drive
2327f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2328f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2329fdf94d1aSNicolas Souchu# lpt	Parallel Printer
233046f3ff79SMike Smith# plip	Parallel network interface
2331fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2332f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
233328ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2334ab4c624bSMike Smith#
2335ab4c624bSMike Smith# Supported interfaces:
2336ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2337ab4c624bSMike Smith#
2338ef8f7626SNicolas Souchu
23390f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
23400f210c92SNicolas Souchu				  # (see flags in ppc(4))
23415895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
23429d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2343ef8f7626SNicolas Souchu				# compliant peripheral
23445895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
23455895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
23465895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
23475895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
23485895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
23493b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
23503b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2351ef8f7626SNicolas Souchu
2352f71c01ccSPeter Wemmdevice		ppc
2353f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2354f71c01ccSPeter Wemmhint.ppc.0.irq="7"
23550d31b179SPeter Wemmdevice		ppbus
23560d31b179SPeter Wemmdevice		vpo
23570d31b179SPeter Wemmdevice		lpt
23580d31b179SPeter Wemmdevice		plip
23590d31b179SPeter Wemmdevice		ppi
23600d31b179SPeter Wemmdevice		pps
23610d31b179SPeter Wemmdevice		lpbb
23620d31b179SPeter Wemmdevice		pcfclock
2363ab4c624bSMike Smith
23640ac40133SBrian Somers# Kernel BOOTP support
23650ac40133SBrian Somers
23660ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
23670ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
23680ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
23690ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
23700ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
23710ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2372432aad0eSTor Egge
2373d94f38acSEivind Eklund#
23744103b765SPoul-Henning Kamp# Add software watchdog routines.
2375370c3cb5SSean Kelly#
23764103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2377370c3cb5SSean Kelly
2378370c3cb5SSean Kelly#
2379b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
23804e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
23814e0ee531SMike Barcroft# it back on at run-time.
2382c796cfa1SAndrzej Bialecki#
2383c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2384c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2385c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2386c796cfa1SAndrzej Bialecki#
238719dde963SPeter Wemm#options 	NO_SWAPPING
2388c796cfa1SAndrzej Bialecki
23899dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
23909dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
23919dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
23929dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
23939dab0776SDavid Greenman#
23945895e3c8SPeter Wemmoptions 	NSFBUFS=1024
23959dab0776SDavid Greenman
239615a1057cSEivind Eklund#
2397053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2398ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2399053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2400053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2401053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2402053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
240315a1057cSEivind Eklund#
240415a1057cSEivind Eklundoptions 	DEBUG_LOCKS
240515a1057cSEivind Eklund
240626086a03SPeter Wemm
240726086a03SPeter Wemm#####################################################################
24081d33cf3dSNick Hibma# USB support
24091d33cf3dSNick Hibma# UHCI controller
2410c9953c3bSPeter Wemmdevice		uhci
24111d33cf3dSNick Hibma# OHCI controller
2412c9953c3bSPeter Wemmdevice		ohci
2413ca3acad1SBernd Walter# EHCI controller
2414ca3acad1SBernd Walterdevice		ehci
241539e5901eSTakanori Watanabe# SL811 Controller
241639e5901eSTakanori Watanabedevice 		slhci
24171d33cf3dSNick Hibma# General USB code (mandatory for USB)
2418c9953c3bSPeter Wemmdevice		usb
24191d33cf3dSNick Hibma#
2420b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2421b5ea1f0cSNick Hibmadevice		udbp
2422d1233ab3SBruce Evans# USB Fm Radio
2423d1233ab3SBruce Evansdevice		ufm
2424f26c33d2SNick Hibma# Generic USB device driver
2425c9953c3bSPeter Wemmdevice		ugen
2426f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2427c9953c3bSPeter Wemmdevice		uhid
24281d33cf3dSNick Hibma# USB keyboard
2429c9953c3bSPeter Wemmdevice		ukbd
24301d33cf3dSNick Hibma# USB printer
2431c9953c3bSPeter Wemmdevice		ulpt
24326521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2433c9953c3bSPeter Wemmdevice		umass
2434ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2435ce17576aSScott Longdevice		umct
2436e9fb12d3SNick Hibma# USB modem support
2437e9fb12d3SNick Hibmadevice		umodem
2438f26c33d2SNick Hibma# USB mouse
2439c9953c3bSPeter Wemmdevice		ums
24401c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2441e2dbd15fSNick Hibmadevice		urio
24422fd84f56SNick Hibma# USB scanners
24432fd84f56SNick Hibmadevice		uscanner
2444d1233ab3SBruce Evans#
2445916e6e02SJosef Karthauser# USB serial support
2446916e6e02SJosef Karthauserdevice		ucom
24479aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
24489aab0d96SMaxim Konovalovdevice		uark
2449d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2450d1233ab3SBruce Evansdevice		ubsa
2451d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2452d1233ab3SBruce Evansdevice		ubser
245348b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
245448b68edfSJosef Karthauserdevice		uftdi
2455c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2456c5286e11STakanori Watanabedevice		uipaq
245748b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2458916e6e02SJosef Karthauserdevice		uplcom
24592e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
24602e7328e7SRink Springerdevice		uslcom
246148b68edfSJosef Karthauser# USB Visor and Palm devices
246248b68edfSJosef Karthauserdevice		uvisor
2463d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2464d1233ab3SBruce Evansdevice		uvscom
2465f26c33d2SNick Hibma#
2466ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2467d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2468d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2469d04bb221SBill Paul# eval board.
2470c9953c3bSPeter Wemmdevice		aue
2471bf029145SRobert Watson
2472bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2473bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2474bf029145SRobert Watson
2475bf029145SRobert Watsondevice		axe
2476bf029145SRobert Watson
2477dfd1e98eSBill Paul#
24786bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
24796bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
24806bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
24816bcf0032SMaxim Sobolevdevice		cdce
24826bcf0032SMaxim Sobolev#
248301779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
248401779872SBill Paul# and Netmate II, and the Belkin F5U111.
2485c9953c3bSPeter Wemmdevice		cue
248601779872SBill Paul#
2487dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2488d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2489d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
249001779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
249101779872SBill Paul# and 2104USB, and the Corega USB-T.
2492c9953c3bSPeter Wemmdevice		kue
249311e04b05SShunsuke Akiyama#
249411e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
249511e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
249611e04b05SShunsuke Akiyamadevice		rue
2497cdd40f3bSMIHIRA Sanpei Yoshiro#
2498cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2499cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2500cdd40f3bSMIHIRA Sanpei Yoshiro
2501f26c33d2SNick Hibma
2502f26c33d2SNick Hibma# debugging options for the USB subsystem
25031d33cf3dSNick Hibma#
25041d33cf3dSNick Hibmaoptions 	USB_DEBUG
2505f26c33d2SNick Hibma
25066e8394b8SKazutaka YOKOTA# options for ukbd:
25076e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2508cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
25096e8394b8SKazutaka YOKOTA
2510565f53bbSShunsuke Akiyama# options for uplcom:
25113c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2512565f53bbSShunsuke Akiyama						# in milliseconds
2513565f53bbSShunsuke Akiyama
251420280807SShunsuke Akiyama# options for uvscom:
251520280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
25163c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2517565f53bbSShunsuke Akiyama						# in milliseconds
251820280807SShunsuke Akiyama
25198b7ce2ffSSam Leffler#####################################################################
2520869093b1SHidetoshi Shimokawa# FireWire support
25217d2ba89bSJohn Baldwin
2522869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
25237d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
252479acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2525869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
25261c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2527869093b1SHidetoshi Shimokawa
2528869093b1SHidetoshi Shimokawa#####################################################################
2529869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2530869093b1SHidetoshi Shimokawa
2531869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2532869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2533869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2534869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2535869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2536869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
25377d2ba89bSJohn Baldwin
25387d2ba89bSJohn Baldwin#####################################################################
25398b7ce2ffSSam Leffler# crypto subsystem
25408b7ce2ffSSam Leffler#
25411c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2542b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
25431c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
25448b7ce2ffSSam Leffler#
25451c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
25461c9c6382SRuslan Ermilov# been fed back to OpenBSD.
25478b7ce2ffSSam Leffler
25488b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
25498b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
25508b7ce2ffSSam Leffler
2551ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
25528b7ce2ffSSam Leffler
2553b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2554b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2555b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2556b7c4858fSSam Leffler
2557b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2558b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2559b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2560b7c4858fSSam Leffler
25618b7ce2ffSSam Leffler#####################################################################
25628b7ce2ffSSam Leffler
25638b7ce2ffSSam Leffler
2564785d2100SJohn Birrell#
2565785d2100SJohn Birrell# Embedded system options:
2566785d2100SJohn Birrell#
2567785d2100SJohn Birrell# An embedded system might want to run something other than init.
256825388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2569bc0e3a03SJeroen Ruigrok van der Werven
2570bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2571bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
25721c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2573395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2574bc0e3a03SJeroen Ruigrok van der Werven
2575e2c1a4e9SBenno Rice#
2576e2c1a4e9SBenno Rice# Verbose SYSINIT
2577e2c1a4e9SBenno Rice#
2578e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2579e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2580e2c1a4e9SBenno Rice# will print function names instead of addresses.
2581e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2582e2c1a4e9SBenno Rice
2583446af86dSJohn Baldwin#####################################################################
2584446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2585446af86dSJohn Baldwin#
2586446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2587446af86dSJohn Baldwinoptions 	SEMMAP=31
2588446af86dSJohn Baldwin
2589446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2590446af86dSJohn Baldwin# one time.
2591446af86dSJohn Baldwinoptions 	SEMMNI=11
2592446af86dSJohn Baldwin
2593446af86dSJohn Baldwin# Total number of semaphores system wide
2594446af86dSJohn Baldwinoptions 	SEMMNS=61
2595446af86dSJohn Baldwin
2596446af86dSJohn Baldwin# Total number of undo structures in system
2597446af86dSJohn Baldwinoptions 	SEMMNU=31
2598446af86dSJohn Baldwin
2599446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2600446af86dSJohn Baldwin# at one time.
2601446af86dSJohn Baldwinoptions 	SEMMSL=61
2602446af86dSJohn Baldwin
2603446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2604446af86dSJohn Baldwin# semaphore at one time.
2605446af86dSJohn Baldwinoptions 	SEMOPM=101
2606446af86dSJohn Baldwin
2607446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2608446af86dSJohn Baldwin# System V semaphore at one time.
2609446af86dSJohn Baldwinoptions 	SEMUME=11
2610446af86dSJohn Baldwin
2611446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2612446af86dSJohn Baldwinoptions 	SHMALL=1025
2613446af86dSJohn Baldwin
2614446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
261525388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2616446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2617446af86dSJohn Baldwin
2618446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2619446af86dSJohn Baldwinoptions 	SHMMIN=2
2620446af86dSJohn Baldwin
2621446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2622446af86dSJohn Baldwin# at one time.
2623446af86dSJohn Baldwinoptions 	SHMMNI=33
2624446af86dSJohn Baldwin
2625446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2626446af86dSJohn Baldwin# a single process at one time.
2627446af86dSJohn Baldwinoptions 	SHMSEG=9
2628446af86dSJohn Baldwin
2629d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2630d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2631d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2632d9282887SDima Dorfman# console.
2633d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2634d9282887SDima Dorfman
26355bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
26365bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
26375bbb8060STor Egge# file.  Both offset and length of the read operation must be
26385bbb8060STor Egge# multiples of the physical media sector size.
26395bbb8060STor Egge#
2640995356dcSDag-Erling Smørgravoptions 	DIRECTIO
26415bbb8060STor Egge
26425bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
26435bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
26445bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
26455bbb8060STor Egge#
2646995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
26475bbb8060STor Egge
2648446af86dSJohn Baldwin#####################################################################
2649446af86dSJohn Baldwin
2650bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2651bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2652bc0e3a03SJeroen Ruigrok van der Werven
2653bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
265428d7984fSJeroen Ruigrok van der Werven
265528d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2656bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
265728d7984fSJeroen Ruigrok van der Werven
2658bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
26598b6f5e65SJeroen Ruigrok van der Werven
266028d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2661bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
266228d7984fSJeroen Ruigrok van der Werven
26638b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
26648b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
26658b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
26668b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
26678b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
26688b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
26698b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
26708b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
26718b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
26728b6f5e65SJeroen Ruigrok van der Werven
26738b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
26748b6f5e65SJeroen Ruigrok van der Werven
2675bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2676bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2677bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2678bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
26798b6f5e65SJeroen Ruigrok van der Werven
26808b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
26818b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
26828b6f5e65SJeroen Ruigrok van der Werven
2683bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2684bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
26858b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
26868b6f5e65SJeroen Ruigrok van der Werven
2687316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2688316ec49aSScott Long
2689662d3818SScott Long# Adaptec Array Controller driver options
2690662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2691662d3818SScott Long				# 0 - quiet, only emit warnings
2692662d3818SScott Long				# 1 - noisy, emit major function
2693662d3818SScott Long				#     points and things done
2694662d3818SScott Long				# 2 - extremely noisy, emit trace
2695662d3818SScott Long				#     items in loops, etc.
2696662d3818SScott Long
26971e9ea774SBruce Evans# Yet more undocumented options for linting.
26981e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
26991e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
27001e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
270125388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
270225388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
27031e9ea774SBruce Evansoptions 	MAXFILES=999
2704