xref: /freebsd/sys/conf/NOTES (revision 6c26723b1936b47354f04012dc801ddd1e87beb6)
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
152b03fab12SMarcel Moolenaaroptions 	GEOM_PART_PC98		# PC-9800 disk partitioning
15310020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
154069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
155e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
156560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1577dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
158069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
15975261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
160f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
161069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1621c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1637b03a440SPoul-Henning Kamp
1648b140d57SMike Smith#
1658b140d57SMike Smith# The root device and filesystem type can be compiled in;
1668b140d57SMike Smith# this provides a fallback option if the root device cannot
1673b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1688b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1698b140d57SMike Smith#
1708b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1718b140d57SMike Smith
1726a8d6623SGarrett Wollman
1736a8d6623SGarrett Wollman#####################################################################
174f5d05ac3SJeff Roberson# Scheduler options:
175f5d05ac3SJeff Roberson#
176a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
177f5d05ac3SJeff Roberson# select which scheduler is compiled in.
178f5d05ac3SJeff Roberson#
179f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
1801c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
181f5d05ac3SJeff Roberson# good interactivity and priority selection.
182f5d05ac3SJeff Roberson#
183bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
184bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
185bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
186bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
187bd675f58SJeff Roberson# will eventually become the default scheduler.
188f5d05ac3SJeff Roberson#
18975a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
19075a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
19175a66a92SJeff Roberson#
192b998bd92SJeff Robersonoptions 	SCHED_4BSD
19375a66a92SJeff Robersonoptions		SCHED_STATS
194b998bd92SJeff Roberson#options 	SCHED_ULE
195f5d05ac3SJeff Roberson
196f5d05ac3SJeff Roberson#####################################################################
197477a642cSPeter Wemm# SMP OPTIONS:
198477a642cSPeter Wemm#
199477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
200477a642cSPeter Wemm
201477a642cSPeter Wemm# Mandatory:
202477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
203477a642cSPeter Wemm
2042498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2052498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
206701f1408SScott Long# CPU.  This behaviour is enabled by default, so this option can be used
207701f1408SScott Long# to disable it.
208701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2092498cf8cSJohn Baldwin
210cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
211cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
212cd6e6e4eSJohn Baldwin# CPU.  This behaviour is enabled by default, so this option can be used
213cd6e6e4eSJohn Baldwin# to disable it.
214cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
215cd6e6e4eSJohn Baldwin
2164e7f640dSJohn Baldwin# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread
2174e7f640dSJohn Baldwin# that currently owns the lock is executing on another CPU.  Note that
2184e7f640dSJohn Baldwin# in addition to enabling this option, individual sx locks must be
2194e7f640dSJohn Baldwin# initialized with the SX_ADAPTIVESPIN flag.
2204e7f640dSJohn Baldwinoptions 	ADAPTIVE_SX
2214e7f640dSJohn Baldwin
222ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
223ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
224ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
225cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
226ad27c4c7SJohn Baldwin# and WITNESS options.
227ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
228ad27c4c7SJohn Baldwin
2291a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2301a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2311a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
232cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2331a5d9b15SJohn Baldwin# and WITNESS options.
2341a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2351a5d9b15SJohn Baldwin
2364e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2374e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2384e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2394e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2404e7f640dSJohn Baldwin# and WITNESS options.
2414e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2424e7f640dSJohn Baldwin
2431fe4c660SJohn Baldwin# SMP Debugging Options:
2441fe4c660SJohn Baldwin#
2459923b511SScott Long# PREEMPTION allows the threads that are in the kernel to be preempted
2469923b511SScott Long#	  by higher priority threads.  It helps with interactivity and
2479923b511SScott Long#	  allows interrupt threads to run sooner rather than waiting.
24867ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2490c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2508c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2510c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2520c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2530c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2549923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
255ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
256ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
25775a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
25875a66a92SJeff Roberson#	  frequency.
259ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
260ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
261aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2621fe4c660SJohn Baldwin#         during locking operations.
263e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2643c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
265660d1e3aSJohn Baldwin#	  sleep.
266660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
2679923b511SScott Longoptions 	PREEMPTION
2680c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
269ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
2701fe4c660SJohn Baldwinoptions 	WITNESS
271e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
272660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
2731fe4c660SJohn Baldwin
274cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
27507dba937SKip Macyoptions 	LOCK_PROFILING
27600096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
27700096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
27800096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
27900096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
2804db0d7f1SDag-Erling Smørgrav
281ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
282ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
283ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
284ef0ebfc3SJohn Baldwin
285477a642cSPeter Wemm
286477a642cSPeter Wemm#####################################################################
2876a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
288690f540cSAndrey A. Chernov
2896a8d6623SGarrett Wollman#
2906a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
29156c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
2927bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
2937bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
2947bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
2957bbf05a2SJuli Mallett# signal delivery mechanism.
2966a8d6623SGarrett Wollman#
2975895e3c8SPeter Wemmoptions 	COMPAT_43
2986a8d6623SGarrett Wollman
299d3e64681SPoul-Henning Kamp# Old tty interface.
300d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
301d3e64681SPoul-Henning Kamp
302f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
303f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
304f0eb293eSAlfred Perlstein
305a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
306a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
307a01b4125SKen Smith
3086c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3096c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3106c9fdda7SRuslan Ermilov
3115965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3125965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3135965c4b7SJohn Baldwin
3146a8d6623SGarrett Wollman#
3156a8d6623SGarrett Wollman# These three options provide support for System V Interface
3166a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3176a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3186a8d6623SGarrett Wollman#
3196a8d6623SGarrett Wollmanoptions 	SYSVSHM
3206a8d6623SGarrett Wollmanoptions 	SYSVSEM
3216a8d6623SGarrett Wollmanoptions 	SYSVMSG
3226a8d6623SGarrett Wollman
3236a8d6623SGarrett Wollman
3246a8d6623SGarrett Wollman#####################################################################
3256a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3266a8d6623SGarrett Wollman
3276a8d6623SGarrett Wollman#
328e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3296a8d6623SGarrett Wollman#
330e2ee2173SMarcel Moolenaaroptions 	KDB
331b5d89ca8SBruce Evans
332b5d89ca8SBruce Evans#
333e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3347085e708SBruce Evans#
335e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
336e2ee2173SMarcel Moolenaar
337e2ee2173SMarcel Moolenaar#
338e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
339e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
340e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
341e2ee2173SMarcel Moolenaar#
342e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
343e2ee2173SMarcel Moolenaar
344e2ee2173SMarcel Moolenaar#
345e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
346e2ee2173SMarcel Moolenaar#
347e2ee2173SMarcel Moolenaaroptions 	DDB
3487085e708SBruce Evans
3497085e708SBruce Evans#
350bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
351bfdd261eSBruce Evans# representation.
352bfdd261eSBruce Evans#
353bfdd261eSBruce Evansoptions 	DDB_NUMSYM
354bfdd261eSBruce Evans
355bfdd261eSBruce Evans#
356e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3570be15decSJohn Baldwin#
358e2ee2173SMarcel Moolenaaroptions 	GDB
359562d05dfSPaul Traina
360562d05dfSPaul Traina#
361df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
362df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
3631c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
364df970488SRobert Watson# interfere with serial console operation.
365df970488SRobert Watson#
366df970488SRobert Watsonoptions 	SYSCTL_DEBUG
367df970488SRobert Watson
368df970488SRobert Watson#
369e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
370e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
371e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
372e4eb384bSBosko Milekic#
373e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
374e4eb384bSBosko Milekic
375e4eb384bSBosko Milekic#
376847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
377847a2a17SPawel Jakub Dawidek# malloc(9).
378847a2a17SPawel Jakub Dawidek#
379847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
380847a2a17SPawel Jakub Dawidek
381847a2a17SPawel Jakub Dawidek#
382ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
383ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
384ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
385ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
386ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
387ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
388ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
3896a8d6623SGarrett Wollman#
3902365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
391ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
39221c64a07SAndrey A. Chernov
3936a8d6623SGarrett Wollman#
394a7bebf90SKris Kennaway# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently
395a7bebf90SKris Kennaway# it has no userland interface aside from a few sysctl's.  It is
396a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
397a7bebf90SKris Kennaway# entries in the circular trace buffer; it must be a power of two.
398a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
399a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
400a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
401a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
4021c9c6382SRuslan Ermilov# events, with bit X corresponding to CPU X.  KTR_VERBOSE enables
403a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
404a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
405a7bebf90SKris Kennaway# if KTR_VERBOSE is not defined.
406c508c1b6SJohn Baldwin#
407c508c1b6SJohn Baldwinoptions 	KTR
408c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
40925388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
410a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
411c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
412d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
413c508c1b6SJohn Baldwin
414c508c1b6SJohn Baldwin#
4151c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
416453ffeefSRobert Watson# to a vnode, and is employed by services such as KTR(4) to produce trace
417453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
418453ffeefSRobert Watson# in a worker thread.
419453ffeefSRobert Watson#
420453ffeefSRobert Watsonoptions 	ALQ
421453ffeefSRobert Watsonoptions 	KTR_ALQ
422453ffeefSRobert Watson
423453ffeefSRobert Watson#
4245526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
4256a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
4266a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
4276a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
4286a8d6623SGarrett Wollman# programming errors.
4296a8d6623SGarrett Wollman#
4305526d2d9SEivind Eklundoptions 	INVARIANTS
4315526d2d9SEivind Eklund
4325526d2d9SEivind Eklund#
43334b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
43434b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
43534b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
43634b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
43734b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
43834b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
43934b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
44034b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
44134b15f2aSJohn Baldwin# infrastructure without the added overhead.
44234b15f2aSJohn Baldwin#
44334b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
44434b15f2aSJohn Baldwin
44534b15f2aSJohn Baldwin#
4465526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
4475526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
4485526d2d9SEivind Eklund# it is disabled by default.
4495526d2d9SEivind Eklund#
4500dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
451da59a31cSDavid Greenman
4520dd1eea1SJordan K. Hubbard#
4530b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
4543c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
4550b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
4560b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
4570b5438c6SRobert Watson# impossible) scenarios.
4580b5438c6SRobert Watson#
4590b5438c6SRobert Watsonoptions 	REGRESSION
4600b5438c6SRobert Watson
4610b5438c6SRobert Watson#
4621432aa0cSJohn Baldwin# RESTARTABLE_PANICS allows one to continue from a panic as if it were
463ef39c05bSAlexander Leidinger# a call to the debugger to continue from a panic as instead.  It is only
4641432aa0cSJohn Baldwin# useful if a kernel debugger is present.  To restart from a panic, reset
4651432aa0cSJohn Baldwin# the panicstr variable to NULL and continue execution.  This option is
4661432aa0cSJohn Baldwin# for development use only and should NOT be used in production systems
4671432aa0cSJohn Baldwin# to "workaround" a panic.
4681432aa0cSJohn Baldwin#
4699d60f0cbSJohn Baldwin#options 	RESTARTABLE_PANICS
4701432aa0cSJohn Baldwin
4711432aa0cSJohn Baldwin#
472346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
473346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
474346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
475346ebe51SEivind Eklund# from.)
476346ebe51SEivind Eklund#
477346ebe51SEivind Eklundoptions 	COMPILING_LINT
478346ebe51SEivind Eklund
4793c90d1eaSRobert Watson#
4803c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
4813c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
4823c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
4833c90d1eaSRobert Watson#
4843c90d1eaSRobert Watsonoptions 	STACK
4853c90d1eaSRobert Watson
4866a8d6623SGarrett Wollman
4876a8d6623SGarrett Wollman#####################################################################
488d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
489d47cce3eSMarcel Moolenaar
490d47cce3eSMarcel Moolenaar#
491d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
492d47cce3eSMarcel Moolenaar# counters for performance monitoring.  The base kernel needs to configured
493d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
494d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
495d47cce3eSMarcel Moolenaar#
496ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
497ad3869b4SJoseph Koshy# please see hwpmc(4).
498ad3869b4SJoseph Koshy
499d47cce3eSMarcel Moolenaardevice  	hwpmc			# Driver (also a loadable module)
500d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
501d47cce3eSMarcel Moolenaar
502d47cce3eSMarcel Moolenaar
503d47cce3eSMarcel Moolenaar#####################################################################
5046a8d6623SGarrett Wollman# NETWORKING OPTIONS
50570c0b54cSAndrey A. Chernov
5066a8d6623SGarrett Wollman#
507a22fb0daSGeorge V. Neville-Neil# Protocol families
5086a8d6623SGarrett Wollman#
5096a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
51051f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
511a22fb0daSGeorge V. Neville-Neil
512a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
513a22fb0daSGeorge V. Neville-Neil# your kernel configuration
514a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5152cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
51614dd6717SSam Leffler#
517cc977adcSBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to force packets coming through a tunnel
518cc977adcSBjoern A. Zeeb# to be processed by any configured packet filtering twice.
519cc977adcSBjoern A. Zeeb# The default is that packets coming out of a tunnel are _not_ processed;
52014dd6717SSam Leffler# they are assumed trusted.
52114dd6717SSam Leffler#
522fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
523fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
52414dd6717SSam Leffler#
525cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
526f73bbaf2SDavid Greenman
527cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
528cc6a66f2SJulian Elischer
5297665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
530e83e2322SBoris Popov
53134b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5328b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
53334b5fca7SJulian Elischer
534daaa73b5SRobert Watson#
535daaa73b5SRobert Watson# SMB/CIFS requester
536daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
537daaa73b5SRobert Watson# options.
538daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
539daaa73b5SRobert Watson
540d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
541d8589bd5SBoris Popovoptions 	LIBMCHAIN
542d8589bd5SBoris Popov
5436cd047a0SGleb Smirnoff# libalias library, performing NAT
5446cd047a0SGleb Smirnoffoptions		LIBALIAS
5456cd047a0SGleb Smirnoff
546f8829a4aSRandall Stewart#
547f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
548f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
549f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
550f8829a4aSRandall Stewart# extensions. This release supports all the extensions
551f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
552f8829a4aSRandall Stewart# It is the premeier SCTP implementation in the NET
553f8829a4aSRandall Stewart# and is quite well tested.
554f8829a4aSRandall Stewart#
555f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
556f8829a4aSRandall Stewart# you don't have to enable V6, but SCTP is
557f8829a4aSRandall Stewart# dual stacked and so far we have not teased apart
558f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
559f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
560f8829a4aSRandall Stewart#
561f8829a4aSRandall Stewartoptions         SCTP
562f8829a4aSRandall Stewart# There are bunches of options:
563f8829a4aSRandall Stewart# this one turns on all sorts of
564f8829a4aSRandall Stewart# nastly printing that you can
565f8829a4aSRandall Stewart# do. Its all controled by a
566f8829a4aSRandall Stewart# bit mask (settable by socket opt and
567f8829a4aSRandall Stewart# by sysctl). Including will not cause
568f8829a4aSRandall Stewart# logging until you set the bits.. but it
569f8829a4aSRandall Stewart# can be quite verbose.. so without this
570f8829a4aSRandall Stewart# option we don't do any of the tests for
571f8829a4aSRandall Stewart# bits and prints.. which makes the code run
572f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
573f8829a4aSRandall Stewartoptions SCTP_DEBUG
574f8829a4aSRandall Stewart#
575f8829a4aSRandall Stewart# This option turns off the CRC32c checksum. Basically
576f8829a4aSRandall Stewart# You will not be able to talk to anyone else that
577f8829a4aSRandall Stewart# has not done this. Its more for expermentation to
578f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
579f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
580f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
581f8829a4aSRandall Stewart# like with such an offload (which only exists in
582f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
583f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
584f8829a4aSRandall Stewart# to be.. but it does speed things up try only
585f8829a4aSRandall Stewart# for in a captured lab environment :-)
586f8829a4aSRandall Stewartoptions SCTP_WITH_NO_CSUM
587f8829a4aSRandall Stewart#
588cb7a4976SRandall Stewart
589f8829a4aSRandall Stewart#
590f8829a4aSRandall Stewart# All that options after that turn on specific types of
591f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
592f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
593f8829a4aSRandall Stewart# see. I have used this to produce interesting
594f8829a4aSRandall Stewart# charts and graphs as well :->
595f8829a4aSRandall Stewart#
596f8829a4aSRandall Stewart# I have not yet commited the tools to get and print
597f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
598f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
599cb7a4976SRandall Stewart# You basically must have KTR enabled for these
600cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
601cb7a4976SRandall Stewart# logging bits. Use ktrdump to pull the log and run
602cb7a4976SRandall Stewart# it through a dispaly program.. and graphs and other
603cb7a4976SRandall Stewart# things too.
604f8829a4aSRandall Stewart#
605f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
606f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
607cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
608cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
609cb7a4976SRandall Stewartoptions		SCTP_LTRACE_CHUNKS
610cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
611cb7a4976SRandall Stewart
612f8829a4aSRandall Stewart
61302b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
61402b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
615cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
616cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
617cceffdeeSAndrew Thompson# option.
61802b199f1SMax Laieroptions 	ALTQ
619755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
620c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
62102b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
62202b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
62302b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6243c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
625cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
62602b199f1SMax Laieroptions 	ALTQ_DEBUG
62702b199f1SMax Laier
6284cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6294cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6304cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6314cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
63292a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
63392a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6344cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
63573e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
63673e87266SGleb Smirnoff					# affects netgraph(4) and nodes
63773e87266SGleb Smirnoff# Node types
6384cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
639bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
640b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
641b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
642b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
64351713b2aSMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
644b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
645b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
646b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
647b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
648b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
64992a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
650901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6517d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
6524cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6539e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
65431578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6554cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6569d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
65746aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
658d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
6594cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
66037379158SBrooks Davisoptions 	NETGRAPH_GIF
66137379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
6624cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
6634cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
66437379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
665f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
66648e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
667901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
6684cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
669a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
670a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
671a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
672cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
6736cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
6747d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
675b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
676b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
677add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
6789e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
6794cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
680b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
6814d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
6820a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
683d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
684e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
6854cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
6864cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
6874cf49a43SJulian Elischeroptions 	NETGRAPH_UI
688b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
689666ea1b6SMaksim Yevmenkin
69002152e8fSHartmut Brandt# NgATM - Netgraph ATM
69102152e8fSHartmut Brandtoptions 	NGATM_ATM
692027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
693027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
694027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
695ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
696a7e22394SHartmut Brandtoptions 	NGATM_CCATM
69702152e8fSHartmut Brandt
698c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
6993cf4d0bfSPoul-Henning Kamp
7006a8d6623SGarrett Wollman#
7016a8d6623SGarrett Wollman# Network interfaces:
702f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
703f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7049d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
705722012ccSJulian Elischer#  configured or token-ring is enabled.
706fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
707fc67901fSYaroslav Tykhiy#  according to IEEE 802.1Q.  It requires `device miibus'.
70857a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
70967e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
710f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
71167e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
71267e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
71367e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
71467e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
71567e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
71634341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
71767e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
71867e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
71967e4db77SSam Leffler#  `wlan' module.
7201a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
721eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
722f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
723e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
724f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
725f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
726f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
727d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
728d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
729991f5121SMurray Stokely#  simultaneous BPF clients programs runnable.  DHCP requires bpf.
730f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
73159d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
73270e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
73363518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
73463518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
7354c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
736f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
737f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
738cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
739cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
740f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
741f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
742f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
743f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
744f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
745cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
746d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
747f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
7485d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
7496a8d6623SGarrett Wollman#
7508d69c48bSMax Laier# The pf packet filter consists of three devices:
7518d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
7528d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
7538d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
7548d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
7558d69c48bSMax Laier#
756829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
757829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
758829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
7596b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
760829b5d55SPeter Wemm# See pppd(8) for more details.
76189327d27SPeter Wemm#
762f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
7631270082cSYaroslav Tykhiydevice		vlan			#VLAN support (needs miibus)
764be7b82cdSSam Lefflerdevice		wlan			#802.11 support
7656c26723bSSam Leffleroptions		IEEE80211_DEBUG		#enable debugging msgs
7666c26723bSSam Leffleroptions		IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
76767e4db77SSam Lefflerdevice		wlan_wep		#802.11 WEP support
76867e4db77SSam Lefflerdevice		wlan_ccmp		#802.11 CCMP support
76967e4db77SSam Lefflerdevice		wlan_tkip		#802.11 TKIP support
77067e4db77SSam Lefflerdevice		wlan_xauth		#802.11 external authenticator support
77167e4db77SSam Lefflerdevice		wlan_acl		#802.11 MAC ACL support
7726ac646b3SKevin Lodevice		wlan_amrr		#AMRR transmit rate control algorithm
773f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
774f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
775eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
776f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
77709d225d8SBrooks Davisdevice		loop			#Network loopback device
778f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
77970e04181SYaroslav Tykhiydevice		disc			#Discard device based on loopback
78063518eccSYaroslav Tykhiydevice		edsc			#Ethernet discard device
7814c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
782f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
783f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
784f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
7857afc53b8SAndrew Thompsondevice		if_bridge		#Bridge interface
7868d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
7878d69c48bSMax Laierdevice		pflog			#logging support interface for PF
7888d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
789c73b559bSGleb Smirnoffdevice		carp			#Common Address Redundancy Protocol
790b2630c29SGeorge V. Neville-Neildevice		enc			#IPsec interface
79105c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
79289327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
79389327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
7946b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
79518242d3bSAndrew Thompsondevice		lagg			#Link aggregation interface
796d29895dcSGarrett Wollman
797f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
7985d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
7995d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
8005d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
8015d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
8025d94d71cSBoris Popov
803cfa1ca9dSYoshinobu Inoue# for IPv6
8049753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
805f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
8062f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
807d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
808cfa1ca9dSYoshinobu Inoue
8096a8d6623SGarrett Wollman#
8106a8d6623SGarrett Wollman# Internet family options:
8116a8d6623SGarrett Wollman#
8126a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8130948f0a2SBruce M Simpson# with mrouted and XORP.
814e0f688baSJeffrey Hsu#
815d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
816ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
817ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
818ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
819ab6e02daSJordan K. Hubbard#
820ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
821ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
822a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
823ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
824ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
825ab6e02daSJordan K. Hubbard# feature works properly.
8268dd4744eSJordan K. Hubbard#
827ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
828ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
829ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
830ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
831ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
832ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
833ffdd472dSPeter Wemm# out of sync.
834d29895dcSGarrett Wollman#
83584bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
83684bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
83793e0e116SJulian Elischer#
83844299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
83944299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
840b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
841b7522c27SJulian Elischer# packets too.  Because of this great care is required when
842b7522c27SJulian Elischer# crafting the ruleset.
843099dd043SAndre Oppermann#
84461c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
845531c890bSPaolo Pisati# LIBALIAS.
84661c0e134SPaolo Pisati#
8471b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
8481c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
8491b968362SDag-Erling Smørgrav# from traceroute and similar tools.
8501b968362SDag-Erling Smørgrav#
8515e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
8525e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
8535e331acdSGarrett Wollman# using the trpt(8) utility.
85465e8111fSBruce Evans#
855e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
856d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
8574479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
8585895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
859e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
86044299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
86161c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
86293e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
8639cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
8649cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
8650c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
8668259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
8671b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
86865e8111fSBruce Evansoptions 	TCPDEBUG
8696a8d6623SGarrett Wollman
87053dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
87153dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
872f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
8736eeac1d9SJulian Elischer# MBUF_PROFILING enables code to profile teh mbif chains
8746eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
8756eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
8766eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
87753dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
8786eeac1d9SJulian Elischeroptions		MBUF_PROFILING
8794a5ccac7SMike Silbersack
880a79b7128SAlfred Perlstein# Statically Link in accept filters
881a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
882a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
883a79b7128SAlfred Perlstein
884b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
885b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
886b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
887b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
888b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
889b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
890b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
891b52f8407SBruce M Simpson
892f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
893f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
894358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
895358f8d82SRobert Watson# a smooth scheduling of the traffic.
89668ec4eb6SLuigi Rizzooptions 	DUMMYNET
89768e9d934SLuigi Rizzo
89898cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
8993c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
90098cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
90198cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
90298cb733cSKenneth D. Merry# zero_copy(9) for more details.
90398cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
90498cb733cSKenneth D. Merry
9053f8c4506SPoul-Henning Kamp#
9063f8c4506SPoul-Henning Kamp# ATM (HARP version) options
9073f8c4506SPoul-Henning Kamp#
9082b851aebSRobert Watson# XXX: These have been disabled in FreeBSD 7.0 as they are not MPSAFE.
9092b851aebSRobert Watson#
9103f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
9113f8c4506SPoul-Henning Kamp#	for ATM support.
9123f8c4506SPoul-Henning Kamp#
9133f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
9143f8c4506SPoul-Henning Kamp#
9153f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
9163f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
9173f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
9183f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
9193f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
9203f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
9213f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
9223f8c4506SPoul-Henning Kamp#
9233f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
9243f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
9253f8c4506SPoul-Henning Kamp#
92658aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
92758aa55efSHartmut Brandt#
9282b851aebSRobert Watson#options 	ATM_CORE		#core ATM protocol family
9292b851aebSRobert Watson#options 	ATM_IP			#IP over ATM support
9302b851aebSRobert Watson#options 	ATM_SIGPVC		#SIGPVC signalling manager
9312b851aebSRobert Watson#options 	ATM_SPANS		#SPANS signalling manager
9322b851aebSRobert Watson#options 	ATM_UNI			#UNI signalling manager
93326837af4SMatthew N. Dodd
9342b851aebSRobert Watson#device		hfa			#FORE PCA-200E ATM PCI
9352b851aebSRobert Watson#device		harp			#Pseudo-interface for NATM
9363f8c4506SPoul-Henning Kamp
9376a8d6623SGarrett Wollman
9386a8d6623SGarrett Wollman#####################################################################
9396a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
940e3178a06SJordan K. Hubbard
9412365e64fSRodney W. Grimes#
9426a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
9436a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
944888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
9456a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
9466a8d6623SGarrett Wollman# compile other filesystems as well.
9476a8d6623SGarrett Wollman#
948534046e3SRong-En Fan# NB: The PORTAL filesystem is known to be buggy, and WILL panic your
949534046e3SRong-En Fan# system if you attempt to do anything with it.  It is included here
950534046e3SRong-En Fan# as an incentive for some enterprising soul to sit down and fix it.
951534046e3SRong-En Fan# The UNION filesystem was known to be buggy in the past.  It is now
952534046e3SRong-En Fan# being actively maintained, although there are still some issues being
953534046e3SRong-En Fan# resolved.
9542365e64fSRodney W. Grimes#
955f1a9c715SDavid Greenman
9566a8d6623SGarrett Wollman# One of these is mandatory:
9576a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
958dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9596a8d6623SGarrett Wollman
9606a8d6623SGarrett Wollman# The rest are optional:
9615895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
96299d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9630adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
964dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
965dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
966dfdcada3SDoug Rabsonoptions		NFSLOCKD		#Network Lock Manager
9673ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
968f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
969dd1c7d13SBruce Evans# Broken (depends on NCP):
970b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
97199d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
9724d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
97352ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
974bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
975daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
976df263cbdSScott Longoptions 	UDF			#Universal Disk Format
97799d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
978bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
979bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
980f1a9c715SDavid Greenman
981d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
982d61e6649SAlexander Langer# making abrupt shutdown less risky.
983f8f8d7afSEivind Eklund#
9843d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
985b1897c19SJulian Elischer
986a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
98751be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
98851be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
98949993db0SRobert Watsonoptions 	UFS_EXTATTR
99049993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
991a64ed089SRobert Watson
99251be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
99351be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
99451be6918SChris D. Faulhaber# for the underlying filesystem.
99551be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
99651be6918SChris D. Faulhaberoptions 	UFS_ACL
99751be6918SChris D. Faulhaber
9989b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
9999b5ad47fSIan Dowse# directories at the expense of some memory.
10009b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10019b5ad47fSIan Dowse
1002f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1003f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1004f348204cSPawel Jakub Dawidek
100571e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
100671e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
100771e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
100871e4fff8SPoul-Henning Kamp
100971e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
101071e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
101171e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1012d52d7365SPoul-Henning Kamp
1013495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10142365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10156a8d6623SGarrett Wollman
1016276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1017276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1018276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1019276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1020ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10216110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1022276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1023276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
1024276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
1025276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1026276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1027276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1028cb800e34SJulian Elischer#
1029cb800e34SJulian Elischeroptions 	SUIDDIR
1030cb800e34SJulian Elischer
1031df394affSJohn-Mark Gurney# NFS options:
10325895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10335895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10345895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10355895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10365895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10375895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1038df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1039df394affSJohn-Mark Gurney
10409afcea2fSRobert V. Baron# Coda stuff:
10419afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1042f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1043d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1044d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1045d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1046a1d55890SJordan K. Hubbard
1047053a2b61SEivind Eklund#
1048053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1049053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1050053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1051053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1052053a2b61SEivind Eklund#
10535895e3c8SPeter Wemmoptions 	EXT2FS
1054053a2b61SEivind Eklund
1055fe98fb32SJean-Sébastien Pédron#
1056fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1057fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1058fe98fb32SJean-Sébastien Pédron#
1059fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1060fe98fb32SJean-Sébastien Pédron
10617b30d718SCraig Rodrigues#
10627b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
10637b30d718SCraig Rodrigues# this is limited to read-only access.
10647b30d718SCraig Rodrigues#
10657b30d718SCraig Rodriguesoptions 	XFS
10667b30d718SCraig Rodrigues
1067dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
10680cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
10690cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1070dd85920aSJason Evansoptions 	VFS_AIO
1071053a2b61SEivind Eklund
10728ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1073ac519db0SMark Murraydevice		random
107415bbdecfSMark Murray
10758ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
10768ab2f5ecSMark Murraydevice		mem
10778ab2f5ecSMark Murray
1078c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1079c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1080c4f02a89SMax Khonoptions 	CD9660_ICONV
1081c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1082c4f02a89SMax Khonoptions 	NTFS_ICONV
1083126f0dfaSScott Longoptions 	UDF_ICONV
1084c4f02a89SMax Khon
10856a8d6623SGarrett Wollman
10866a8d6623SGarrett Wollman#####################################################################
1087abc97a06SBruce Evans# POSIX P1003.1B
1088abc97a06SBruce Evans
10891c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1090abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1091abc97a06SBruce Evans
10925895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
10938cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
10948cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
10953ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1096abc97a06SBruce Evans
10975b40ce27SDavid Xu# POSIX message queue
10985b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1099abc97a06SBruce Evans
1100abc97a06SBruce Evans#####################################################################
110112e9f256SRobert Watson# SECURITY POLICY PARAMETERS
110212e9f256SRobert Watson
1103fdcba197SRobert Watson# Support for BSM audit
1104fdcba197SRobert Watsonoptions 	AUDIT
1105fdcba197SRobert Watson
1106cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1107cd6d1d76SBruce Evansoptions 	MAC
1108eae2f20cSRobert Watsonoptions 	MAC_BIBA
1109eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1110eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1111c4725737SRobert Watsonoptions 	MAC_LOMAC
1112eae2f20cSRobert Watsonoptions 	MAC_MLS
1113eae2f20cSRobert Watsonoptions 	MAC_NONE
1114eae2f20cSRobert Watsonoptions 	MAC_PARTITION
111503d03162SRobert Watsonoptions 	MAC_PORTACL
1116eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1117782f7255SRobert Watsonoptions 	MAC_STUB
1118eae2f20cSRobert Watsonoptions 	MAC_TEST
111912e9f256SRobert Watson
112012e9f256SRobert Watson
112112e9f256SRobert Watson#####################################################################
1122000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1123000033d0SJeroen Ruigrok van der Werven
1124000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1125358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1126358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1127358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1128358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1129358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1130358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1131358f8d82SRobert Watson# actually reducing the accuracy of operation.
1132000033d0SJeroen Ruigrok van der Werven
1133000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1134000033d0SJeroen Ruigrok van der Werven
1135f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1136f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1137f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1138f309f881SJohn Baldwin
1139f309f881SJohn Baldwinoptions 	PPS_SYNC
1140f309f881SJohn Baldwin
1141000033d0SJeroen Ruigrok van der Werven
1142000033d0SJeroen Ruigrok van der Werven#####################################################################
1143de6a307eSPeter Dufault# SCSI DEVICES
1144de6a307eSPeter Dufault
11456a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11466a8d6623SGarrett Wollman
11476a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1148ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
11496a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
11506a8d6623SGarrett Wollman# device configuration sections below.
11516a8d6623SGarrett Wollman#
1152e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1153e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1154e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1155e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1156e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1157e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1158e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1159e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1160e14eb5a1SGarrett Wollman# problem.)
1161ebc1a0e2SPeter Dufault
1162ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1163ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1164700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1165700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1166ebc1a0e2SPeter Dufault
1167ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1168ebc1a0e2SPeter Dufault
1169f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1170f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1171f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1172f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1173f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1174f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1175f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1176f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1177f71c01ccSPeter Wemmhint.da.0.target="0"
1178f71c01ccSPeter Wemmhint.da.0.unit="0"
1179f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1180f71c01ccSPeter Wemmhint.da.1.target="1"
1181f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1182f71c01ccSPeter Wemmhint.da.2.target="3"
1183f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1184f71c01ccSPeter Wemmhint.sa.1.target="6"
1185ebc1a0e2SPeter Dufault
1186ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1187ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1188ebc1a0e2SPeter Dufault
1189ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1190ebc1a0e2SPeter Dufault
1191cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1192cf2458c9SMatt Jacob#
1193cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1194cf2458c9SMatt Jacob# ("WORM") devices.
1195cf2458c9SMatt Jacob#
1196cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1197cf2458c9SMatt Jacob#
1198cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1199cf2458c9SMatt Jacob#
12003c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12013c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1202cf2458c9SMatt Jacob#
1203cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1204cf2458c9SMatt Jacob#
12051eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12061eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12071eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
12081eba4c79SScott Long# source level API compatiblity for porting apps to FreeBSD.
1209cf2458c9SMatt Jacob#
1210cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1211cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1212cf2458c9SMatt Jacob#
1213cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1214cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1215cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1216cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1217cf2458c9SMatt Jacob#
1218cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1219cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1220cf2458c9SMatt Jacob# to them.
1221cf2458c9SMatt Jacob#
1222265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1223cf2458c9SMatt Jacob# configuration as the "pass" driver.
1224ebc1a0e2SPeter Dufault
1225c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1226c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1227c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1228c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1229c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
123064ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1231cf2458c9SMatt Jacobdevice		pt		#SCSI processor
123264ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
123364ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1234cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12351eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
12368909a72bSPeter Dufault
1237700daf5eSJustin T. Gibbs# CAM OPTIONS:
1238700daf5eSJustin T. Gibbs# debugging options:
1239700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1240700daf5eSJustin T. Gibbs#             specify them all!
1241700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1242700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1243700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1244700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1245d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1246d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1247700daf5eSJustin T. Gibbs#
1248700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1249700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1250700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
125156234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
125256234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
12533a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
12543a937198SBrooks Davis#             can be changed at boot and runtime with the
12553a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1256700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
12575895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
12585895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
12595895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
126025388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
12615895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1262700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1263700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
126432672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
12651a7c583cSGarrett Wollman
1266700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1267700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1268700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1269700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1270700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1271700daf5eSJustin T. Gibbs# respectively.
127293063432SJoerg Wunsch#
1273700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1274700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1275700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
127693063432SJoerg Wunsch#
12775895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
12785895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
127993063432SJoerg Wunsch
12809dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1281b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
12829dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
12839dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
12849dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
12859f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
128625388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
128725388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
128825388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
128925388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
12909f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
12919dfb4471SKenneth D. Merry
12923ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
12933ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
129425388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
12953ece1bd2SKenneth D. Merry
12968904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
12978904e70bSMatt Jacob#
12988904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
12998904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13008904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
13018904e70bSMatt Jacob# are in....
13028904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13038904e70bSMatt Jacob
13046a8d6623SGarrett Wollman
13056a8d6623SGarrett Wollman#####################################################################
13066a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13076a8d6623SGarrett Wollman
13081160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
13091160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
13101160da92SJoerg Wunsch# `xterm', among others.
13111160da92SJoerg Wunsch
1312f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
13136d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1314f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1315f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1316efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13176aec1278SMax Laierdevice		firmware	#firmware(9) support
1318be174c7eSGreg Lehey
13196f2d8adbSBoris Popov# Kernel side iconv library
13206f2d8adbSBoris Popovoptions 	LIBICONV
13216f2d8adbSBoris Popov
132258067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13235895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
132458067a99SPoul-Henning Kamp
13259c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
13269c62b3eeSDavid Schultzoptions 	TTYHOG=8193
13279c62b3eeSDavid Schultz
13286a8d6623SGarrett Wollman
13296a8d6623SGarrett Wollman#####################################################################
1330d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1331d61e6649SAlexander Langer
1332d61e6649SAlexander Langer# For ISA the required hints are listed.
13335bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13345bcb64f2SWarner Losh# no hints are needed.
1335d61e6649SAlexander Langer
1336d61e6649SAlexander Langer#
1337d61e6649SAlexander Langer# Mandatory devices:
1338d61e6649SAlexander Langer#
1339d61e6649SAlexander Langer
13406e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13416e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13426e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13436e818956SDavid E. O'Brien
13447f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13457f5092f3SJohn Baldwin
1346837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1347837f167eSRuslan Ermilov
1348905e8b43SDag-Erling Smørgrav# Various screen savers.
1349905e8b43SDag-Erling Smørgravdevice		blank_saver
1350905e8b43SDag-Erling Smørgravdevice		daemon_saver
1351905e8b43SDag-Erling Smørgravdevice		dragon_saver
1352905e8b43SDag-Erling Smørgravdevice		fade_saver
1353905e8b43SDag-Erling Smørgravdevice		fire_saver
1354905e8b43SDag-Erling Smørgravdevice		green_saver
1355905e8b43SDag-Erling Smørgravdevice		logo_saver
1356905e8b43SDag-Erling Smørgravdevice		rain_saver
1357905e8b43SDag-Erling Smørgravdevice		snake_saver
1358905e8b43SDag-Erling Smørgravdevice		star_saver
1359905e8b43SDag-Erling Smørgravdevice		warp_saver
1360905e8b43SDag-Erling Smørgrav
13611c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1362f453022cSPeter Wemmdevice		sc
1363f71c01ccSPeter Wemmhint.sc.0.at="isa"
1364683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
13656e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
13666e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1367cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1368e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1369c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
13706e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
13716e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
13726e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
137385e36760SJordan K. Hubbard
13747a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
137525388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
137625388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
137725388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
137825388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
13797a88382dSKazutaka YOKOTA
138078f45204SMaxim Sobolev# The following options will let you change the default behaviour of
138178f45204SMaxim Sobolev# cut-n-paste feature
138278f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
138325388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
138425388b6cSBruce Evans					# (default is single space - \"x20\")
138578f45204SMaxim Sobolev
13867a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
13877a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
13887a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
13897a88382dSKazutaka YOKOTA
13906e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
13916e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
13926e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
13936e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
13946e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
13956e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1396c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
13972ac8be82SAndreas Schulz
13988a28ce0eSJohn Baldwin# `flags' for sc
13998a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14008a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14018a28ce0eSJohn Baldwin
14021fe04850SBruce Evans#
1403d61e6649SAlexander Langer# Optional devices:
14046a8d6623SGarrett Wollman#
14056a8d6623SGarrett Wollman
14066a8d6623SGarrett Wollman#
1407d61e6649SAlexander Langer# SCSI host adapters:
14086a8d6623SGarrett Wollman#
14097f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1410859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14116e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14127f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1413d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1414d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1415cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14167f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1417d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1418d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14196e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14206e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14211b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1422d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1423d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1424d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1425e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1426e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1427af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1428ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
142964fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
143064fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1431d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1432fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1433fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1434fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1435fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1436f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14376e818956SDavid E. O'Brien# wds: WD7000
1438d61e6649SAlexander Langer
14396e818956SDavid E. O'Brien#
14406e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14416e818956SDavid E. O'Brien# probed correctly.
14426e818956SDavid E. O'Brien#
14436e818956SDavid E. O'Briendevice		bt
14446e818956SDavid E. O'Brienhint.bt.0.at="isa"
14456e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14467f5092f3SJohn Baldwindevice		adv
14477f5092f3SJohn Baldwinhint.adv.0.at="isa"
1448c9953c3bSPeter Wemmdevice		adw
14496e818956SDavid E. O'Briendevice		aha
14506e818956SDavid E. O'Brienhint.aha.0.at="isa"
14517f5092f3SJohn Baldwindevice		aic
14527f5092f3SJohn Baldwinhint.aic.0.at="isa"
14537f5092f3SJohn Baldwindevice		ahb
1454d61e6649SAlexander Langerdevice		ahc
1455cdd49e97SJustin T. Gibbsdevice		ahd
1456d61e6649SAlexander Langerdevice		amd
14571b946e21SScott Longdevice		esp
1458c5933b20SScott Longdevice		iscsi_initiator
1459d61e6649SAlexander Langerdevice		isp
14600787f2b8SMatt Jacobhint.isp.0.disable="1"
14610787f2b8SMatt Jacobhint.isp.0.role="3"
14620787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
14630787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
14640787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
14650787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
14660787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
14670787f2b8SMatt Jacobhint.isp.0.topology="lport"
14680787f2b8SMatt Jacobhint.isp.0.topology="nport"
14690787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
14700787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
14710787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
14720787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
14730787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
14740787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1475d61e6649SAlexander Langerdevice		ispfw
147664fa5108SMatt Jacobdevice		mpt
1477d61e6649SAlexander Langerdevice		ncr
1478d61e6649SAlexander Langerdevice		sym
1479f3d92b26SOlivier Houcharddevice		trm
14806e818956SDavid E. O'Briendevice		wds
14816e818956SDavid E. O'Brienhint.wds.0.at="isa"
14826e818956SDavid E. O'Brienhint.wds.0.port="0x350"
14836e818956SDavid E. O'Brienhint.wds.0.irq="11"
14846e818956SDavid E. O'Brienhint.wds.0.drq="6"
1485d61e6649SAlexander Langer
1486d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1487d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1488d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1489d61e6649SAlexander Langer# default.
1490d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1491d61e6649SAlexander Langer
1492fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1493fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1494fac70739SJeroen Ruigrok van der Werven
1495fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1496fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1497fac70739SJeroen Ruigrok van der Werven
1498662d3818SScott Long# Compile in Aic7xxx Debugging code.
1499662d3818SScott Longoptions 	AHC_DEBUG
1500662d3818SScott Long
1501662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1502662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1503662d3818SScott Long
1504f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1505f8f8803bSBruce Evans# See ahc(4).
1506662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1507662d3818SScott Long
1508cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1509cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1510cdd49e97SJustin T. Gibbs
1511f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1512cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1513cdd49e97SJustin T. Gibbs
151443e9d8a3SScott Long# Print human-readable register definitions when debugging
151543e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
151643e9d8a3SScott Long
1517662d3818SScott Long# Bitmap of units to enable targetmode operations.
1518662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1519662d3818SScott Long
1520d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1521d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1522d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1523d61e6649SAlexander Langer
1524c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1525c5933b20SScott Long#
1526c5933b20SScott Longoptions		ISCSI_INITIATOR_DEBUG=9
1527c5933b20SScott Long
1528d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1529d61e6649SAlexander Langer#
1530d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1531d61e6649SAlexander Langer#
153264fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1533af606348SMatt Jacob#
15349a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15359a1b0d43SMatt Jacob#		none=0
15369a1b0d43SMatt Jacob#		target=1
15379a1b0d43SMatt Jacob#		initiator=2
15389a1b0d43SMatt Jacob#		both=3			(not supported currently)
1539af606348SMatt Jacob#
15409a1b0d43SMatt Jacoboptions 	ISP_DEFAULT_ROLES=2
1541d61e6649SAlexander Langer
1542d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1543d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1544d61e6649SAlexander Langer					# Allows the ncr to take precedence
1545d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1546d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1547d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1548d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1549d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1550d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1551d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1552d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1553d61e6649SAlexander Langer					# default:8, range:[1..64]
15546a8d6623SGarrett Wollman
15556e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
15566e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
15576e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
15586e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
15596e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
15606e818956SDavid E. O'Brien#
15616e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
15626e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
15636e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
15646e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
15656e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
15666e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
15676e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
15686e818956SDavid E. O'Brien#                           option will create more trouble than solve.
15696e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
15706e818956SDavid E. O'Brien#                           wait when timing out with the above option.
15716e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
15726e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
15736e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
15746e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
15756e818956SDavid E. O'Brien#                           cost, great benefit.
15766e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
15776e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
15786e818956SDavid E. O'Brien#			    are 100% certain you need it.
15796e818956SDavid E. O'Brien
15806e818956SDavid E. O'Briendevice		dpt
15816e818956SDavid E. O'Brien
15826e818956SDavid E. O'Brien# DPT options
15836e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
15846e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
15856e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
15866e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
15876e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
15886e818956SDavid E. O'Brien
15896e818956SDavid E. O'Brien#
15906e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
15916e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
15926e818956SDavid E. O'Brien# CAM infrastructure.
15936e818956SDavid E. O'Brien#
15946e818956SDavid E. O'Briendevice		ciss
15956e818956SDavid E. O'Brien
15966e818956SDavid E. O'Brien#
15976e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
15986e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
15996e818956SDavid E. O'Brien# at Intel for this driver are
16006e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16016e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16026e818956SDavid E. O'Brien#
16036e818956SDavid E. O'Briendevice		iir
16046e818956SDavid E. O'Brien
16056e818956SDavid E. O'Brien#
16066e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16076e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16086e818956SDavid E. O'Brien# the CAM infrastructure.
16096e818956SDavid E. O'Brien#
16106e818956SDavid E. O'Briendevice		mly
16116e818956SDavid E. O'Brien
16126e818956SDavid E. O'Brien#
16136e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16146e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16156e818956SDavid E. O'Brien# controllers.
16166e818956SDavid E. O'Brien#
16176e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16186e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16196e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
16207f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1621f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16226b31d3f7SScott Longoptions 	MFI_DEBUG
16236e818956SDavid E. O'Brien
16246e818956SDavid E. O'Brien#
16256e818956SDavid E. O'Brien# 3ware ATA RAID
16266e818956SDavid E. O'Brien#
16276e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16286e818956SDavid E. O'Brien
162990d3341eSPeter Wemm#
16306d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16316d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16326d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1633c9953c3bSPeter Wemmdevice		ata
1634c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1635ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1636c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1637c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1638c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1639c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1640fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
16418b89ef0aSSøren Schmidt#
16426d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
16436d04301dSAlexander Langerhint.ata.0.at="isa"
16446d04301dSAlexander Langerhint.ata.0.port="0x1f0"
16456d04301dSAlexander Langerhint.ata.0.irq="14"
16466d04301dSAlexander Langerhint.ata.1.at="isa"
16476d04301dSAlexander Langerhint.ata.1.port="0x170"
16486d04301dSAlexander Langerhint.ata.1.irq="15"
16496d04301dSAlexander Langer
16506d04301dSAlexander Langer#
1651000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1652000da71aSSøren Schmidt#
1653000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
165474d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
165574d8e840SSøren Schmidt
165674d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
165774d8e840SSøren Schmidt
16588b89ef0aSSøren Schmidt#
16596d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
16606d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
16616a8d6623SGarrett Wollman#
1662f71c01ccSPeter Wemmdevice		fdc
1663f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1664f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1665f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1666f71c01ccSPeter Wemmhint.fdc.0.drq="2"
166785827d9cSJoerg Wunsch#
1668d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1669d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1670d2fb4892SJoerg Wunsch# however.
1671d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1672d2fb4892SJoerg Wunsch#
1673f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1674f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1675f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1676f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
167785827d9cSJoerg Wunsch
1678f71c01ccSPeter Wemm# Specify floppy devices
1679f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1680f71c01ccSPeter Wemmhint.fd.0.drive="0"
1681f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1682f71c01ccSPeter Wemmhint.fd.1.drive="1"
168385827d9cSJoerg Wunsch
16846a8d6623SGarrett Wollman#
1685501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1686501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1687c8956b36SMarcel Moolenaar#
1688501ef98fSMarcel Moolenaardevice		uart
1689501ef98fSMarcel Moolenaar
16908194412bSMarcel Moolenaar# Options for uart(4)
16918194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
16928194412bSMarcel Moolenaar					# instead of DCD.
16938194412bSMarcel Moolenaar
1694501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1695501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1696501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1697501ef98fSMarcel Moolenaar
1698c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1699c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1700c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1701c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1702c8956b36SMarcel Moolenaar# unit number of the probed UART.
1703501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1704501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1705501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1706501ef98fSMarcel Moolenaar
1707501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1708c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1709c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1710c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1711c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1712c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1713c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1714c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1715c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1716c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1717c8956b36SMarcel Moolenaar#		as debug port.
17189546766aSBruce Evans#
17199546766aSBruce Evans
1720501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1721c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1722c8956b36SMarcel Moolenaar					# ddb, if available.
17236a8d6623SGarrett Wollman
172426b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
172526b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
172626b6ea69SPaul Saab# Sun servers by the Remote Console.
172726b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
172826b6ea69SPaul Saab
1729af2e25a6SMarcel Moolenaar# Serial Communications Controller
1730af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1731af2e25a6SMarcel Moolenaar# communications controllers.
1732af2e25a6SMarcel Moolenaardevice		scc
1733af2e25a6SMarcel Moolenaar
17349c564b6cSJohn Hay# PCI Universal Communications driver
173564220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17369c564b6cSJohn Haydevice		puc
17379c564b6cSJohn Hay
17386a8d6623SGarrett Wollman#
1739d61e6649SAlexander Langer# Network interfaces:
17406a8d6623SGarrett Wollman#
1741d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1742d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17433c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1744d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1745d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1746d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1747d61e6649SAlexander Langer# individual driver.
1748d61e6649SAlexander Langerdevice		miibus
1749d61e6649SAlexander Langer
17507f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
17517f5092f3SJohn Baldwin#       PCI and ISA varieties.
1752343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1753343ed0a8SJohn Baldwin#       adapters.
1754343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
175595d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1756586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1757586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1758586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
17597f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
17607f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
17617f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
1762d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1763d61e6649SAlexander Langer#       and various workalikes including:
1764d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1765d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1766d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1767d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1768d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1769d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1770d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1771d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1772d61e6649SAlexander Langer#       KNE110TX.
1773d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1774a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
177596a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
17767f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
17777f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
17787f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
17797f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
17807f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
17817f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1782d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1783d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1784cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
17851ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
178652c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
178744ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1788c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1789c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1790c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1791c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1792c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1793c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1794c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
17952bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1796d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1797ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1798ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1799ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1800cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1801cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
180241f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
18030fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
18040fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
18050fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
18060fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
18070fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1808d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1809d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1810d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1811d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1812d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1813d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1814d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1815d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1816d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1817d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1818d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1819d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1820d61e6649SAlexander Langer#       card which is 32-bit.
1821b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1822b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
18237d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1824d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1825d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1826d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1827d61e6649SAlexander Langer#       (also single mode and multimode).
1828d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1829d61e6649SAlexander Langer#       attach each one as a separate network interface.
18307f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
18317f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1832d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1833d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1834d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1835d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1836d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1837d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1838d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1839c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1840c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1841d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1842d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1843d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1844d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1845d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
18463c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1847362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1848d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1849d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1850d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1851d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1852d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1853d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1854d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1855d61e6649SAlexander Langer#       NE2000 clone.
18567f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
18577f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
18587f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
18597f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
18607f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
18617f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1862d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1863d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1864d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1865d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1866d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1867d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1868d61e6649SAlexander Langer
18697f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
18707f5092f3SJohn Baldwin
18717f5092f3SJohn Baldwindevice		cm
18727f5092f3SJohn Baldwinhint.cm.0.at="isa"
18737f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
18747f5092f3SJohn Baldwinhint.cm.0.irq="9"
18757f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
18767f5092f3SJohn Baldwindevice		ep
18777f5092f3SJohn Baldwindevice		ex
1878c06a3350SPeter Wemmdevice		fe
18797f5092f3SJohn Baldwinhint.fe.0.at="isa"
18807f5092f3SJohn Baldwinhint.fe.0.port="0x300"
18817f5092f3SJohn Baldwindevice		fea
18827f5092f3SJohn Baldwindevice		sn
18837f5092f3SJohn Baldwinhint.sn.0.at="isa"
18847f5092f3SJohn Baldwinhint.sn.0.port="0x300"
18857f5092f3SJohn Baldwinhint.sn.0.irq="10"
18867f5092f3SJohn Baldwindevice		an
18877f5092f3SJohn Baldwindevice		cnw
18887f5092f3SJohn Baldwindevice		wi
18897f5092f3SJohn Baldwindevice		xe
18907f5092f3SJohn Baldwin
1891d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1892343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1893343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1894343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
18958090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
1896404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
1897d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
18984664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
18994664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
19001ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
190152c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
1902343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
1903d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1904343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
1905d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
19062e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1907d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
19087d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1909d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1910343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1911d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1912343ed0a8SJohn Baldwindevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
1913d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1914eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1915d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1916d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1917d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1918d61e6649SAlexander Langer
1919d61e6649SAlexander Langer# PCI Ethernet NICs.
1920d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
1921c6c22d35SJack F Vogel#device		em		# Intel Pro/1000 Gigabit Ethernet
1922c6c22d35SJack F Vogel#device		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
1923c6c22d35SJack F Vogel#device		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
192444ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
1925f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
1926fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
192795d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1928c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1929d61e6649SAlexander Langer
1930343ed0a8SJohn Baldwin# PCI FDDI NICs.
1931c06a3350SPeter Wemmdevice		fpa
1932d61e6649SAlexander Langer
19332bc6081cSScott Long# PCI WAN adapters.
19342bc6081cSScott Longdevice		lmc
19352bc6081cSScott Long
193698cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
193798cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
193898cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
193998cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
194098cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
194198cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
194298cb733cSKenneth D. Merry
19432c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
19442c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
19452c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
19462c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
19472c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
19482c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
19492c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
19502c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
19512c8f5a28SKenneth D. Merry
195268713f97SKenjiro Cho#
195344b5247dSKenjiro Cho# ATM related options (Cranor version)
195444b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
195568713f97SKenjiro Cho#
195668713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
195768713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
195868713f97SKenjiro Cho#
1959c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1960c594298bSHartmut Brandt# ATM PCI cards.
1961c594298bSHartmut Brandt#
1962fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1963fb24f088SHartmut Brandt#
19648dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
19658dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
19668dd4275cSHartmut Brandt#
1967f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
196868713f97SKenjiro Cho# atm devices.
19693cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
197068713f97SKenjiro Cho# bypass TCP/IP.
197168713f97SKenjiro Cho#
1972fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1973fb24f088SHartmut Brandt# hatm and fatm.
19741ba46a03SHartmut Brandt#
197568713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
197668713f97SKenjiro Cho# for more details, please read the original documents at
197798a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
197868713f97SKenjiro Cho#
1979f71c01ccSPeter Wemmdevice		atm
198044b5247dSKenjiro Chodevice		en
1981fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1982c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
19838dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
19841ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
19853cbceb82SKenjiro Chooptions 	NATM			#native ATM
1986f4567b9cSJulian Elischer
19877e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
19887e9024cdSHartmut Brandt
1989c19da41eSPeter Wemm#
19900739ea1dSSeigo Tanimura# Sound drivers
1991c19da41eSPeter Wemm#
19920739ea1dSSeigo Tanimura# sound: The generic sound driver.
1993c7406082SJohn-Mark Gurney#
19940739ea1dSSeigo Tanimura
19950739ea1dSSeigo Tanimuradevice		sound
19960739ea1dSSeigo Tanimura
19970739ea1dSSeigo Tanimura#
19980739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
1999c7406082SJohn-Mark Gurney#
20007f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
20017f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
20027f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
20037f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
20047f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
20057f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
20067f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
20077f5092f3SJohn Baldwin#
2008c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
20090739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2010d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2011903b2fb9SJoel Dahl# snd_au88x0		Aureal Vortex 1/2/Advantage PCI. This driver
2012903b2fb9SJoel Dahl#			lacks support for playback and recording.
2013903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2014903b2fb9SJoel Dahl#			for sparc64.
20150739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
20160739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
20170739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
20180739ea1dSSeigo Tanimura#			4281)
20190739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
20200739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20210fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20229f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20239f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20240739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2025727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2026727ded3aSJoel Dahl#			conjunction with snd_sbc.
20270739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20280739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
20294b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20304b8939a1SAriff Abdullah#			compatible.
20310739ea1dSSeigo Tanimura# snd_ich:		Intel ICH PCI and some more audio controllers
2032903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2033903b2fb9SJoel Dahl#			nForce controllers.
20340739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
20350739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20360739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
20370739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20380739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
20391c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20400739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
20411c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20420739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
20437f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
20449f548240SAlexander Leidinger# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
20450739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2046903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20470739ea1dSSeigo Tanimura#			M5451 PCI.
20480739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20490739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20500739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
20510739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
205281bb901eSPeter Wemm
2053f37a929cSPeter Wemmdevice		snd_ad1816
2054f37a929cSPeter Wemmdevice		snd_als4000
2055d9bde1adSAriff Abdullahdevice		snd_atiixp
2056f37a929cSPeter Wemm#device		snd_au88x0
20577a7386a3SPyun YongHyeon#device		snd_audiocs
20580739ea1dSSeigo Tanimuradevice		snd_cmi
2059f37a929cSPeter Wemmdevice		snd_cs4281
20600739ea1dSSeigo Tanimuradevice		snd_csa
2061f37a929cSPeter Wemmdevice		snd_ds1
2062f37a929cSPeter Wemmdevice		snd_emu10k1
20630fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2064b1ff0220SAlexander Leidingerdevice		snd_envy24
20659f548240SAlexander Leidingerdevice		snd_envy24ht
2066f37a929cSPeter Wemmdevice		snd_es137x
20670739ea1dSSeigo Tanimuradevice		snd_ess
2068f37a929cSPeter Wemmdevice		snd_fm801
20690739ea1dSSeigo Tanimuradevice		snd_gusc
20704b8939a1SAriff Abdullahdevice		snd_hda
20710739ea1dSSeigo Tanimuradevice		snd_ich
20720739ea1dSSeigo Tanimuradevice		snd_maestro
2073f37a929cSPeter Wemmdevice		snd_maestro3
20740739ea1dSSeigo Tanimuradevice		snd_mss
20750739ea1dSSeigo Tanimuradevice		snd_neomagic
2076f37a929cSPeter Wemmdevice		snd_sb16
2077f37a929cSPeter Wemmdevice		snd_sb8
20780739ea1dSSeigo Tanimuradevice		snd_sbc
20790739ea1dSSeigo Tanimuradevice		snd_solo
20809f548240SAlexander Leidingerdevice		snd_spicds
2081f37a929cSPeter Wemmdevice		snd_t4dwave
2082f37a929cSPeter Wemmdevice		snd_via8233
2083f37a929cSPeter Wemmdevice		snd_via82c686
20840739ea1dSSeigo Tanimuradevice		snd_vibes
20850739ea1dSSeigo Tanimuradevice		snd_uaudio
2086c19da41eSPeter Wemm
20871c9c6382SRuslan Ermilov# For non-PnP sound cards:
2088673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2089673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2090673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2091673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2092673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2093673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2094673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2095673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2096673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2097673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2098673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2099673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2100673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2101673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
21027f5092f3SJohn Baldwin
21036a8d6623SGarrett Wollman#
210483820457SPoul-Henning Kamp# IEEE-488 hardware:
210583820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2106346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2107346fa631SPoul-Henning Kamp
210883820457SPoul-Henning Kampdevice	pcii
210983820457SPoul-Henning Kamphint.pcii.0.at="isa"
211083820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
211183820457SPoul-Henning Kamphint.pcii.0.irq="5"
211283820457SPoul-Henning Kamphint.pcii.0.drq="1"
211383820457SPoul-Henning Kamp
2114346fa631SPoul-Henning Kampdevice	tnt4882
2115346fa631SPoul-Henning Kamp
211683820457SPoul-Henning Kamp#
2117567e21c2SBruce Evans# Miscellaneous hardware:
21186a8d6623SGarrett Wollman#
21196fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
21203ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
21211c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
21222849b131SBruce Evans# cy: Cyclades serial driver
21237f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2124787f1498SJohn Baldwin# rc: RISCom/8 multiport card
2125dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
21267f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
2127603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2128657e73c4SPeter Dufault
21293b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
21303b577e1fSJordan K. Hubbard#
21313b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
21323b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
21333b577e1fSJordan K. Hubbard#
2134f71c01ccSPeter Wemm#               device  rp	# core driver support
2135f71c01ccSPeter Wemm#
21363b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
2137b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2138b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
21393b577e1fSJordan K. Hubbard#
21403b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
21413b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
2142f71c01ccSPeter Wemm#   your kernel probe hints:
2143b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2144b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
2145b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2146b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
21473b577e1fSJordan K. Hubbard#
21483b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
2149b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2150b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
2151b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2152b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
2153b147fcf9SBruce Evans#		hint.rp.2.at="isa"
2154b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
2155b147fcf9SBruce Evans#		hint.rp.3.at="isa"
2156b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
21573b577e1fSJordan K. Hubbard#
2158dd267672SJohn Baldwin#   For PCI cards, you need no hints.
21593b577e1fSJordan K. Hubbard
21603ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
21613ae5b532SMatthew N. Dodddevice		mcd
21623ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
21633ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
21646fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
21656fe8789dSMatthew N. Dodddevice		scd
21666fe8789dSMatthew N. Doddhint.scd.0.at="isa"
21676fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
21681c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
21697f5092f3SJohn Baldwinhint.joy.0.at="isa"
21707f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2171787f1498SJohn Baldwindevice		rc
2172787f1498SJohn Baldwinhint.rc.0.at="isa"
2173787f1498SJohn Baldwinhint.rc.0.port="0x220"
2174787f1498SJohn Baldwinhint.rc.0.irq="12"
2175f71c01ccSPeter Wemmdevice		rp
21767f5092f3SJohn Baldwinhint.rp.0.at="isa"
21777f5092f3SJohn Baldwinhint.rp.0.port="0x280"
21787f5092f3SJohn Baldwindevice		si
21797f5092f3SJohn Baldwinoptions 	SI_DEBUG
21807f5092f3SJohn Baldwinhint.si.0.at="isa"
21817f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
21827f5092f3SJohn Baldwinhint.si.0.irq="12"
2183603d67aeSRink Springerdevice		cmx
2184a800f455SJulian Elischer
2185eeb706c0SJustin T. Gibbs#
2186a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
21871c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2188a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
21891c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
21901c2b5939SRoger Hardiman#
2191a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2192a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2193a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2194a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
21951c2b5939SRoger Hardiman# These options can be used to override the auto detection
219698a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
21971c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
21989ff07e32SAmancio Hasty#
21994f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
22001c2b5939SRoger Hardiman# or
22011c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
22023c7c6c12SMike Pritchard# Specifies the default video capture mode.
2203a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2204a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2205a9c5b8d0SSøren Schmidt#
22064f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2207a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2208a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2209a9c5b8d0SSøren Schmidt#
22101c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
22111c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
22121c2b5939SRoger Hardiman#
22131c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
22141c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
22151c2b5939SRoger Hardiman#
22161c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
22171c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
22181c2b5939SRoger Hardiman#
22191c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
22201c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
22211c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
22221c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
22231c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
22241c2b5939SRoger Hardiman# As a rough guess, old = before 1998
22251c2b5939SRoger Hardiman#
222630e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
222730e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
222830e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
222930e27d96SAlexander Langer# mono sound.
2230017b0edcSMatt Jacob
2231c17d4340SNicolas Souchu#
2232c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2233c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2234c17d4340SNicolas Souchu#
223528ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
22360f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
223737973e86SPeter Wemm#     device smbus
223837973e86SPeter Wemm#     device iicbus
223937973e86SPeter Wemm#     device iicbb
2240c17d4340SNicolas Souchu#     device iicsmb
22410f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
22420f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
224328ebb692SNicolas Souchu#
2244c06a3350SPeter Wemmdevice		bktr
2245446cee6eSJoerg Wunsch
2246dc9deb29SPoul-Henning Kamp#
22476e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
22486e818956SDavid E. O'Brien#
22495bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
22506e818956SDavid E. O'Brien# pccard: pccard slots
22516e818956SDavid E. O'Brien# cardbus: cardbus slots
22526e818956SDavid E. O'Briendevice		cbb
22536e818956SDavid E. O'Briendevice		pccard
22546e818956SDavid E. O'Briendevice		cardbus
22556e818956SDavid E. O'Brien
22566e818956SDavid E. O'Brien#
22575bcb64f2SWarner Losh# MMC/SD
22585bcb64f2SWarner Losh#
22595bcb64f2SWarner Losh# mmc: mmc bus
22605bcb64f2SWarner Losh# mmcsd: mmc memory and sd cards.
22615bcb64f2SWarner Losh#device		mmc
22625bcb64f2SWarner Losh#device		mmcsd
22635bcb64f2SWarner Losh
22645bcb64f2SWarner Losh#
22658afa373cSNicolas Souchu# SMB bus
22668afa373cSNicolas Souchu#
22673c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
22683c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
22693c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
22708afa373cSNicolas Souchu#
22718afa373cSNicolas Souchu# Supported devices:
22724d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
22738afa373cSNicolas Souchu#
22743c5656bfSArchie Cobbs# Supported SMB interfaces:
227528ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
227628ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
22777f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
22787f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
22797f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
22807f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2281b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
22824d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
228344e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
22844d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
22858afa373cSNicolas Souchu#
2286c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
22873c5656bfSArchie Cobbs
22887f5092f3SJohn Baldwindevice		intpm
22897f5092f3SJohn Baldwindevice		alpm
22907f5092f3SJohn Baldwindevice		ichsmb
22917f5092f3SJohn Baldwindevice		viapm
229244e6ce01SNicolas Souchudevice		amdpm
22934d5f30e0SRuslan Ermilovdevice		amdsmb
229444e6ce01SNicolas Souchudevice		nfpm
22954d5f30e0SRuslan Ermilovdevice		nfsmb
22967f5092f3SJohn Baldwin
2297c9953c3bSPeter Wemmdevice		smb
22988afa373cSNicolas Souchu
22998afa373cSNicolas Souchu#
23008afa373cSNicolas Souchu# I2C Bus
23018afa373cSNicolas Souchu#
23028afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
23038afa373cSNicolas Souchu#
23048afa373cSNicolas Souchu# Supported devices:
23058afa373cSNicolas Souchu# ic	i2c network interface
23068afa373cSNicolas Souchu# iic	i2c standard io
2307f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
23088afa373cSNicolas Souchu#
23098afa373cSNicolas Souchu# Supported interfaces:
231028ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
231128ebb692SNicolas Souchu#
231228ebb692SNicolas Souchu# Other:
231328ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
23148afa373cSNicolas Souchu#
2315c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2316c9953c3bSPeter Wemmdevice		iicbb
23178afa373cSNicolas Souchu
2318c9953c3bSPeter Wemmdevice		ic
2319c9953c3bSPeter Wemmdevice		iic
2320c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
23218afa373cSNicolas Souchu
2322ab4c624bSMike Smith# Parallel-Port Bus
2323ab4c624bSMike Smith#
2324ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2325ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2326ab4c624bSMike Smith# are automatically probed and attached when found.
2327ab4c624bSMike Smith#
2328ab4c624bSMike Smith# Supported devices:
2329ab4c624bSMike Smith# vpo	Iomega Zip Drive
2330f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2331f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2332fdf94d1aSNicolas Souchu# lpt	Parallel Printer
233346f3ff79SMike Smith# plip	Parallel network interface
2334fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2335f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
233628ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2337ab4c624bSMike Smith#
2338ab4c624bSMike Smith# Supported interfaces:
2339ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2340ab4c624bSMike Smith#
2341ef8f7626SNicolas Souchu
23420f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
23430f210c92SNicolas Souchu				  # (see flags in ppc(4))
23445895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
23459d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2346ef8f7626SNicolas Souchu				# compliant peripheral
23475895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
23485895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
23495895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
23505895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
23515895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
23523b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
23533b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2354ef8f7626SNicolas Souchu
2355f71c01ccSPeter Wemmdevice		ppc
2356f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2357f71c01ccSPeter Wemmhint.ppc.0.irq="7"
23580d31b179SPeter Wemmdevice		ppbus
23590d31b179SPeter Wemmdevice		vpo
23600d31b179SPeter Wemmdevice		lpt
23610d31b179SPeter Wemmdevice		plip
23620d31b179SPeter Wemmdevice		ppi
23630d31b179SPeter Wemmdevice		pps
23640d31b179SPeter Wemmdevice		lpbb
23650d31b179SPeter Wemmdevice		pcfclock
2366ab4c624bSMike Smith
23670ac40133SBrian Somers# Kernel BOOTP support
23680ac40133SBrian Somers
23690ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
23700ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
23710ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
23720ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
23730ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
23740ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2375432aad0eSTor Egge
2376d94f38acSEivind Eklund#
23774103b765SPoul-Henning Kamp# Add software watchdog routines.
2378370c3cb5SSean Kelly#
23794103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2380370c3cb5SSean Kelly
2381370c3cb5SSean Kelly#
2382b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
23834e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
23844e0ee531SMike Barcroft# it back on at run-time.
2385c796cfa1SAndrzej Bialecki#
2386c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2387c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2388c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2389c796cfa1SAndrzej Bialecki#
239019dde963SPeter Wemm#options 	NO_SWAPPING
2391c796cfa1SAndrzej Bialecki
23929dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
23939dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
23949dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
23959dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
23969dab0776SDavid Greenman#
23975895e3c8SPeter Wemmoptions 	NSFBUFS=1024
23989dab0776SDavid Greenman
239915a1057cSEivind Eklund#
2400053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2401ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2402053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2403053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2404053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2405053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
240615a1057cSEivind Eklund#
240715a1057cSEivind Eklundoptions 	DEBUG_LOCKS
240815a1057cSEivind Eklund
240926086a03SPeter Wemm
241026086a03SPeter Wemm#####################################################################
24111d33cf3dSNick Hibma# USB support
24121d33cf3dSNick Hibma# UHCI controller
2413c9953c3bSPeter Wemmdevice		uhci
24141d33cf3dSNick Hibma# OHCI controller
2415c9953c3bSPeter Wemmdevice		ohci
2416ca3acad1SBernd Walter# EHCI controller
2417ca3acad1SBernd Walterdevice		ehci
241839e5901eSTakanori Watanabe# SL811 Controller
241939e5901eSTakanori Watanabedevice 		slhci
24201d33cf3dSNick Hibma# General USB code (mandatory for USB)
2421c9953c3bSPeter Wemmdevice		usb
24221d33cf3dSNick Hibma#
2423b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2424b5ea1f0cSNick Hibmadevice		udbp
2425d1233ab3SBruce Evans# USB Fm Radio
2426d1233ab3SBruce Evansdevice		ufm
2427f26c33d2SNick Hibma# Generic USB device driver
2428c9953c3bSPeter Wemmdevice		ugen
2429f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2430c9953c3bSPeter Wemmdevice		uhid
24311d33cf3dSNick Hibma# USB keyboard
2432c9953c3bSPeter Wemmdevice		ukbd
24331d33cf3dSNick Hibma# USB printer
2434c9953c3bSPeter Wemmdevice		ulpt
24356521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2436c9953c3bSPeter Wemmdevice		umass
2437ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2438ce17576aSScott Longdevice		umct
2439e9fb12d3SNick Hibma# USB modem support
2440e9fb12d3SNick Hibmadevice		umodem
2441f26c33d2SNick Hibma# USB mouse
2442c9953c3bSPeter Wemmdevice		ums
24431c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2444e2dbd15fSNick Hibmadevice		urio
24452fd84f56SNick Hibma# USB scanners
24462fd84f56SNick Hibmadevice		uscanner
2447d1233ab3SBruce Evans#
2448916e6e02SJosef Karthauser# USB serial support
2449916e6e02SJosef Karthauserdevice		ucom
24509aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
24519aab0d96SMaxim Konovalovdevice		uark
2452d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2453d1233ab3SBruce Evansdevice		ubsa
2454d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2455d1233ab3SBruce Evansdevice		ubser
245648b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
245748b68edfSJosef Karthauserdevice		uftdi
2458c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2459c5286e11STakanori Watanabedevice		uipaq
246048b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2461916e6e02SJosef Karthauserdevice		uplcom
24622e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
24632e7328e7SRink Springerdevice		uslcom
246448b68edfSJosef Karthauser# USB Visor and Palm devices
246548b68edfSJosef Karthauserdevice		uvisor
2466d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2467d1233ab3SBruce Evansdevice		uvscom
2468f26c33d2SNick Hibma#
2469ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2470d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2471d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2472d04bb221SBill Paul# eval board.
2473c9953c3bSPeter Wemmdevice		aue
2474bf029145SRobert Watson
2475bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2476bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2477bf029145SRobert Watson
2478bf029145SRobert Watsondevice		axe
2479bf029145SRobert Watson
2480dfd1e98eSBill Paul#
24816bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
24826bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
24836bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
24846bcf0032SMaxim Sobolevdevice		cdce
24856bcf0032SMaxim Sobolev#
248601779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
248701779872SBill Paul# and Netmate II, and the Belkin F5U111.
2488c9953c3bSPeter Wemmdevice		cue
248901779872SBill Paul#
2490dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2491d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2492d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
249301779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
249401779872SBill Paul# and 2104USB, and the Corega USB-T.
2495c9953c3bSPeter Wemmdevice		kue
249611e04b05SShunsuke Akiyama#
249711e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
249811e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
249911e04b05SShunsuke Akiyamadevice		rue
2500cdd40f3bSMIHIRA Sanpei Yoshiro#
2501cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2502cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2503cdd40f3bSMIHIRA Sanpei Yoshiro
25048a4cd00aSWarner Losh#
25058a4cd00aSWarner Losh# ZyDas ZD1211/ZD1211B wireless ethernet driver
25068a4cd00aSWarner Loshdevice		zyd
25078a4cd00aSWarner Losh#
25088a4cd00aSWarner Losh# Ralink Technology RT2500USB chispet driver
25098a4cd00aSWarner Loshdevice		ural
25108a4cd00aSWarner Losh#
25118a4cd00aSWarner Losh# Ralink Technology RT2501USB/RT2601USB chispet driver
25128a4cd00aSWarner Loshdevice		rum
2513f26c33d2SNick Hibma
25148a4cd00aSWarner Losh#
2515f26c33d2SNick Hibma# debugging options for the USB subsystem
25161d33cf3dSNick Hibma#
25171d33cf3dSNick Hibmaoptions 	USB_DEBUG
2518f26c33d2SNick Hibma
25196e8394b8SKazutaka YOKOTA# options for ukbd:
25206e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2521cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
25226e8394b8SKazutaka YOKOTA
2523565f53bbSShunsuke Akiyama# options for uplcom:
25243c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2525565f53bbSShunsuke Akiyama						# in milliseconds
2526565f53bbSShunsuke Akiyama
252720280807SShunsuke Akiyama# options for uvscom:
252820280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
25293c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2530565f53bbSShunsuke Akiyama						# in milliseconds
253120280807SShunsuke Akiyama
25328b7ce2ffSSam Leffler#####################################################################
2533869093b1SHidetoshi Shimokawa# FireWire support
25347d2ba89bSJohn Baldwin
2535869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
25367d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
253779acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2538869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
25391c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2540869093b1SHidetoshi Shimokawa
2541869093b1SHidetoshi Shimokawa#####################################################################
2542869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2543869093b1SHidetoshi Shimokawa
2544869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2545869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2546869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2547869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2548869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2549869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
25507d2ba89bSJohn Baldwin
25517d2ba89bSJohn Baldwin#####################################################################
25528b7ce2ffSSam Leffler# crypto subsystem
25538b7ce2ffSSam Leffler#
25541c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2555b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
25561c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
25578b7ce2ffSSam Leffler#
25581c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
25591c9c6382SRuslan Ermilov# been fed back to OpenBSD.
25608b7ce2ffSSam Leffler
25618b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
25628b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
25638b7ce2ffSSam Leffler
2564ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
25658b7ce2ffSSam Leffler
2566b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2567b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2568b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2569b7c4858fSSam Leffler
2570b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2571b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2572b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2573b7c4858fSSam Leffler
25748b7ce2ffSSam Leffler#####################################################################
25758b7ce2ffSSam Leffler
25768b7ce2ffSSam Leffler
2577785d2100SJohn Birrell#
2578785d2100SJohn Birrell# Embedded system options:
2579785d2100SJohn Birrell#
2580785d2100SJohn Birrell# An embedded system might want to run something other than init.
258125388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2582bc0e3a03SJeroen Ruigrok van der Werven
2583bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2584bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
25851c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2586395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2587bc0e3a03SJeroen Ruigrok van der Werven
2588e2c1a4e9SBenno Rice#
2589e2c1a4e9SBenno Rice# Verbose SYSINIT
2590e2c1a4e9SBenno Rice#
2591e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2592e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2593e2c1a4e9SBenno Rice# will print function names instead of addresses.
2594e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2595e2c1a4e9SBenno Rice
2596446af86dSJohn Baldwin#####################################################################
2597446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2598446af86dSJohn Baldwin#
2599446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2600446af86dSJohn Baldwinoptions 	SEMMAP=31
2601446af86dSJohn Baldwin
2602446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2603446af86dSJohn Baldwin# one time.
2604446af86dSJohn Baldwinoptions 	SEMMNI=11
2605446af86dSJohn Baldwin
2606446af86dSJohn Baldwin# Total number of semaphores system wide
2607446af86dSJohn Baldwinoptions 	SEMMNS=61
2608446af86dSJohn Baldwin
2609446af86dSJohn Baldwin# Total number of undo structures in system
2610446af86dSJohn Baldwinoptions 	SEMMNU=31
2611446af86dSJohn Baldwin
2612446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2613446af86dSJohn Baldwin# at one time.
2614446af86dSJohn Baldwinoptions 	SEMMSL=61
2615446af86dSJohn Baldwin
2616446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2617446af86dSJohn Baldwin# semaphore at one time.
2618446af86dSJohn Baldwinoptions 	SEMOPM=101
2619446af86dSJohn Baldwin
2620446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2621446af86dSJohn Baldwin# System V semaphore at one time.
2622446af86dSJohn Baldwinoptions 	SEMUME=11
2623446af86dSJohn Baldwin
2624446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2625446af86dSJohn Baldwinoptions 	SHMALL=1025
2626446af86dSJohn Baldwin
2627446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
262825388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2629446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2630446af86dSJohn Baldwin
2631446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2632446af86dSJohn Baldwinoptions 	SHMMIN=2
2633446af86dSJohn Baldwin
2634446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2635446af86dSJohn Baldwin# at one time.
2636446af86dSJohn Baldwinoptions 	SHMMNI=33
2637446af86dSJohn Baldwin
2638446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2639446af86dSJohn Baldwin# a single process at one time.
2640446af86dSJohn Baldwinoptions 	SHMSEG=9
2641446af86dSJohn Baldwin
2642d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2643d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2644d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2645d9282887SDima Dorfman# console.
2646d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2647d9282887SDima Dorfman
26485bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
26495bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
26505bbb8060STor Egge# file.  Both offset and length of the read operation must be
26515bbb8060STor Egge# multiples of the physical media sector size.
26525bbb8060STor Egge#
2653995356dcSDag-Erling Smørgravoptions 	DIRECTIO
26545bbb8060STor Egge
26555bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
26565bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
26575bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
26585bbb8060STor Egge#
2659995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
26605bbb8060STor Egge
2661446af86dSJohn Baldwin#####################################################################
2662446af86dSJohn Baldwin
2663bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2664bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2665bc0e3a03SJeroen Ruigrok van der Werven
2666bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
266728d7984fSJeroen Ruigrok van der Werven
266828d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2669bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
267028d7984fSJeroen Ruigrok van der Werven
2671bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
26728b6f5e65SJeroen Ruigrok van der Werven
267328d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2674bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
267528d7984fSJeroen Ruigrok van der Werven
26768b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
26778b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
26788b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
26798b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
26808b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
26818b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
26828b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
26838b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
26848b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
26858b6f5e65SJeroen Ruigrok van der Werven
26868b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
26878b6f5e65SJeroen Ruigrok van der Werven
2688bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2689bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2690bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2691bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
26928b6f5e65SJeroen Ruigrok van der Werven
26938b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
26948b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
26958b6f5e65SJeroen Ruigrok van der Werven
2696bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2697bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
26988b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
26998b6f5e65SJeroen Ruigrok van der Werven
2700316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2701316ec49aSScott Long
2702662d3818SScott Long# Adaptec Array Controller driver options
2703662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2704662d3818SScott Long				# 0 - quiet, only emit warnings
2705662d3818SScott Long				# 1 - noisy, emit major function
2706662d3818SScott Long				#     points and things done
2707662d3818SScott Long				# 2 - extremely noisy, emit trace
2708662d3818SScott Long				#     items in loops, etc.
2709662d3818SScott Long
27101e9ea774SBruce Evans# Yet more undocumented options for linting.
27111e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
27121e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
27131e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
271425388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
271525388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
27161e9ea774SBruce Evansoptions 	MAXFILES=999
2717