xref: /freebsd/sys/conf/NOTES (revision cfef026a0397bcce846074748e1c339dcc8f5878)
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
5128b07e49aSJulian Elischeroptions		ROUTETABLES=2		# max 16. 1 is back compatible.
5138b07e49aSJulian Elischer
514a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
515a22fb0daSGeorge V. Neville-Neil# your kernel configuration
516a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5172cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
51814dd6717SSam Leffler#
519cc977adcSBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to force packets coming through a tunnel
520cc977adcSBjoern A. Zeeb# to be processed by any configured packet filtering twice.
521cc977adcSBjoern A. Zeeb# The default is that packets coming out of a tunnel are _not_ processed;
52214dd6717SSam Leffler# they are assumed trusted.
52314dd6717SSam Leffler#
524fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
525fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
52614dd6717SSam Leffler#
527cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
528f73bbaf2SDavid Greenman
529cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
530cc6a66f2SJulian Elischer
5317665f445SRobert Watsonoptions 	NCP			#NetWare Core protocol
532e83e2322SBoris Popov
53334b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
5348b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
53534b5fca7SJulian Elischer
536daaa73b5SRobert Watson#
537daaa73b5SRobert Watson# SMB/CIFS requester
538daaa73b5SRobert Watson# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
539daaa73b5SRobert Watson# options.
540daaa73b5SRobert Watsonoptions 	NETSMB			#SMB/CIFS requester
541daaa73b5SRobert Watson
542d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
543d8589bd5SBoris Popovoptions 	LIBMCHAIN
544d8589bd5SBoris Popov
5456cd047a0SGleb Smirnoff# libalias library, performing NAT
5466cd047a0SGleb Smirnoffoptions		LIBALIAS
5476cd047a0SGleb Smirnoff
548f8829a4aSRandall Stewart#
549f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
550f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
551f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
552f8829a4aSRandall Stewart# extensions. This release supports all the extensions
553f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
554f8829a4aSRandall Stewart# It is the premeier SCTP implementation in the NET
555f8829a4aSRandall Stewart# and is quite well tested.
556f8829a4aSRandall Stewart#
557f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
558f8829a4aSRandall Stewart# you don't have to enable V6, but SCTP is
559f8829a4aSRandall Stewart# dual stacked and so far we have not teased apart
560f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
561f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
562f8829a4aSRandall Stewart#
563f8829a4aSRandall Stewartoptions         SCTP
564f8829a4aSRandall Stewart# There are bunches of options:
565f8829a4aSRandall Stewart# this one turns on all sorts of
566f8829a4aSRandall Stewart# nastly printing that you can
567f8829a4aSRandall Stewart# do. Its all controled by a
568f8829a4aSRandall Stewart# bit mask (settable by socket opt and
569f8829a4aSRandall Stewart# by sysctl). Including will not cause
570f8829a4aSRandall Stewart# logging until you set the bits.. but it
571f8829a4aSRandall Stewart# can be quite verbose.. so without this
572f8829a4aSRandall Stewart# option we don't do any of the tests for
573f8829a4aSRandall Stewart# bits and prints.. which makes the code run
574f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
575f8829a4aSRandall Stewartoptions SCTP_DEBUG
576f8829a4aSRandall Stewart#
577f8829a4aSRandall Stewart# This option turns off the CRC32c checksum. Basically
578f8829a4aSRandall Stewart# You will not be able to talk to anyone else that
579f8829a4aSRandall Stewart# has not done this. Its more for expermentation to
580f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
581f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
582f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
583f8829a4aSRandall Stewart# like with such an offload (which only exists in
584f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
585f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
586f8829a4aSRandall Stewart# to be.. but it does speed things up try only
587f8829a4aSRandall Stewart# for in a captured lab environment :-)
588f8829a4aSRandall Stewartoptions SCTP_WITH_NO_CSUM
589f8829a4aSRandall Stewart#
590cb7a4976SRandall Stewart
591f8829a4aSRandall Stewart#
592f8829a4aSRandall Stewart# All that options after that turn on specific types of
593f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
594f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
595f8829a4aSRandall Stewart# see. I have used this to produce interesting
596f8829a4aSRandall Stewart# charts and graphs as well :->
597f8829a4aSRandall Stewart#
598f8829a4aSRandall Stewart# I have not yet commited the tools to get and print
599f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
600f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
601cb7a4976SRandall Stewart# You basically must have KTR enabled for these
602cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
603cb7a4976SRandall Stewart# logging bits. Use ktrdump to pull the log and run
604cb7a4976SRandall Stewart# it through a dispaly program.. and graphs and other
605cb7a4976SRandall Stewart# things too.
606f8829a4aSRandall Stewart#
607f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
608f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
609cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
610cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
611cb7a4976SRandall Stewartoptions		SCTP_LTRACE_CHUNKS
612cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
613cb7a4976SRandall Stewart
614f8829a4aSRandall Stewart
61502b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
61602b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
617cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
618cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
619cceffdeeSAndrew Thompson# option.
62002b199f1SMax Laieroptions 	ALTQ
621755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
622c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
62302b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
62402b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
62502b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
6263c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
627cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
62802b199f1SMax Laieroptions 	ALTQ_DEBUG
62902b199f1SMax Laier
6304cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
6314cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
6324cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
6334cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
63492a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
63592a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
6364cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
63773e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
63873e87266SGleb Smirnoff					# affects netgraph(4) and nodes
63973e87266SGleb Smirnoff# Node types
6404cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
641bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
642b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
643b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
644b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
64551713b2aSMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_H4		# ng_h4(4)
646b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
647b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
648b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
649b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
650b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
65192a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
652901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
6537d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
6544cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
6559e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
65631578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
6574cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
6589d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
65946aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
660d07af9d9SRobert Watsonoptions 	NETGRAPH_FEC
6614cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
66237379158SBrooks Davisoptions 	NETGRAPH_GIF
66337379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
6644cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
6654cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
66637379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
667f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
66848e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
669901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
6704cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
671a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
672a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
673a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
674cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
6756cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
6767d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
677b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
678b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
679add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
6809e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
6814cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
682b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
6834d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
6840a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
685d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
686e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
6874cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
6884cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
6894cf49a43SJulian Elischeroptions 	NETGRAPH_UI
690b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
691666ea1b6SMaksim Yevmenkin
69202152e8fSHartmut Brandt# NgATM - Netgraph ATM
69302152e8fSHartmut Brandtoptions 	NGATM_ATM
694027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
695027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
696027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
697ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
698a7e22394SHartmut Brandtoptions 	NGATM_CCATM
69902152e8fSHartmut Brandt
700c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7013cf4d0bfSPoul-Henning Kamp
7026a8d6623SGarrett Wollman#
7036a8d6623SGarrett Wollman# Network interfaces:
704f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
705f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7069d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
707722012ccSJulian Elischer#  configured or token-ring is enabled.
708fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
709fc67901fSYaroslav Tykhiy#  according to IEEE 802.1Q.  It requires `device miibus'.
71057a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
71167e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
712f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
71367e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
71467e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
71567e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
71667e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
71767e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
71834341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
71967e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
72067e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
72167e4db77SSam Leffler#  `wlan' module.
7221a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
723eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
724f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
725e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
726f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
727f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
728f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
729d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
730d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
731991f5121SMurray Stokely#  simultaneous BPF clients programs runnable.  DHCP requires bpf.
732f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
73359d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
73470e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
73563518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
73663518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
7374c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
738f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
739f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
740cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
741cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
742f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
743f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
744f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
745f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
746f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
747cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
748d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
749f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
7505d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
7516a8d6623SGarrett Wollman#
7528d69c48bSMax Laier# The pf packet filter consists of three devices:
7538d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
7548d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
7558d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
7568d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
7578d69c48bSMax Laier#
758829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
759829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
760829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
7616b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
762829b5d55SPeter Wemm# See pppd(8) for more details.
76389327d27SPeter Wemm#
764f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
7651270082cSYaroslav Tykhiydevice		vlan			#VLAN support (needs miibus)
766be7b82cdSSam Lefflerdevice		wlan			#802.11 support
7676c26723bSSam Leffleroptions		IEEE80211_DEBUG		#enable debugging msgs
7686c26723bSSam Leffleroptions		IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
76967e4db77SSam Lefflerdevice		wlan_wep		#802.11 WEP support
77067e4db77SSam Lefflerdevice		wlan_ccmp		#802.11 CCMP support
77167e4db77SSam Lefflerdevice		wlan_tkip		#802.11 TKIP support
77267e4db77SSam Lefflerdevice		wlan_xauth		#802.11 external authenticator support
77367e4db77SSam Lefflerdevice		wlan_acl		#802.11 MAC ACL support
7746ac646b3SKevin Lodevice		wlan_amrr		#AMRR transmit rate control algorithm
775f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
776f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
777eda6ecb2SMax Khondevice		arcnet			#Generic Arcnet
778f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
77909d225d8SBrooks Davisdevice		loop			#Network loopback device
780f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
78170e04181SYaroslav Tykhiydevice		disc			#Discard device based on loopback
78263518eccSYaroslav Tykhiydevice		edsc			#Ethernet discard device
7834c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
784f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
785f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
786f367e2f2SMaxim Sobolevdevice		gre			#IP over IP tunneling
7877afc53b8SAndrew Thompsondevice		if_bridge		#Bridge interface
7888d69c48bSMax Laierdevice		pf			#PF OpenBSD packet-filter firewall
7898d69c48bSMax Laierdevice		pflog			#logging support interface for PF
7908d69c48bSMax Laierdevice		pfsync			#synchronization interface for PF
791c73b559bSGleb Smirnoffdevice		carp			#Common Address Redundancy Protocol
792b2630c29SGeorge V. Neville-Neildevice		enc			#IPsec interface
79305c872adSBrooks Davisdevice		ppp			#Point-to-point protocol
79489327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
79589327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
7966b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
79718242d3bSAndrew Thompsondevice		lagg			#Link aggregation interface
798d29895dcSGarrett Wollman
799f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
8005d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
8015d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
8025d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
8035d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
8045d94d71cSBoris Popov
805cfa1ca9dSYoshinobu Inoue# for IPv6
8069753d2f8SBrooks Davisdevice		gif			#IPv6 and IPv4 tunneling
807f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
8082f653328SBrooks Davisdevice		faith			#for IPv6 and IPv4 translation
809d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
810cfa1ca9dSYoshinobu Inoue
8116a8d6623SGarrett Wollman#
8126a8d6623SGarrett Wollman# Internet family options:
8136a8d6623SGarrett Wollman#
8146a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
8150948f0a2SBruce M Simpson# with mrouted and XORP.
816e0f688baSJeffrey Hsu#
817d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
818ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
819ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
820ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
821ab6e02daSJordan K. Hubbard#
822ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
823ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
824a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
825ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
826ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
827ab6e02daSJordan K. Hubbard# feature works properly.
8288dd4744eSJordan K. Hubbard#
829ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
830ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
831ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
832ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
833ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
834ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
835ffdd472dSPeter Wemm# out of sync.
836d29895dcSGarrett Wollman#
83784bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
83884bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
83993e0e116SJulian Elischer#
84044299225SAndre Oppermann# IPFIREWALL_FORWARD enables changing of the packet destination either
84144299225SAndre Oppermann# to do some sort of policy routing or transparent proxying.  Used by
842b7522c27SJulian Elischer# ``ipfw forward''. All  redirections apply to locally generated
843b7522c27SJulian Elischer# packets too.  Because of this great care is required when
844b7522c27SJulian Elischer# crafting the ruleset.
845099dd043SAndre Oppermann#
84661c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
847531c890bSPaolo Pisati# LIBALIAS.
84861c0e134SPaolo Pisati#
8491b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
8501c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
8511b968362SDag-Erling Smørgrav# from traceroute and similar tools.
8521b968362SDag-Erling Smørgrav#
8535e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
8545e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
8555e331acdSGarrett Wollman# using the trpt(8) utility.
85665e8111fSBruce Evans#
857e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
858d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
8594479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
8605895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
861e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
86244299225SAndre Oppermannoptions 	IPFIREWALL_FORWARD	#packet destination changes
86361c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
86493e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
8659cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
8669cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
8670c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
8688259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
8691b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
87065e8111fSBruce Evansoptions 	TCPDEBUG
8716a8d6623SGarrett Wollman
87253dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
87353dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
874f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
8754e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
8766eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
8776eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
8786eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
87953dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
8806eeac1d9SJulian Elischeroptions		MBUF_PROFILING
8814a5ccac7SMike Silbersack
882a79b7128SAlfred Perlstein# Statically Link in accept filters
883a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
884a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
885a79b7128SAlfred Perlstein
886b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
887b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
888b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
889b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
890b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
891b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
892b52f8407SBruce M Simpson#options 	TCP_SIGNATURE		#include support for RFC 2385
893b52f8407SBruce M Simpson
894f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
895f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
896358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
897358f8d82SRobert Watson# a smooth scheduling of the traffic.
89868ec4eb6SLuigi Rizzooptions 	DUMMYNET
89968e9d934SLuigi Rizzo
90098cb733cSKenneth D. Merry# Zero copy sockets support.  This enables "zero copy" for sending and
9013c7c6c12SMike Pritchard# receiving data via a socket.  The send side works for any type of NIC,
90298cb733cSKenneth D. Merry# the receive side only works for NICs that support MTUs greater than the
90398cb733cSKenneth D. Merry# page size of your architecture and that support header splitting.  See
90498cb733cSKenneth D. Merry# zero_copy(9) for more details.
90598cb733cSKenneth D. Merryoptions 	ZERO_COPY_SOCKETS
90698cb733cSKenneth D. Merry
9073f8c4506SPoul-Henning Kamp#
9083f8c4506SPoul-Henning Kamp# ATM (HARP version) options
9093f8c4506SPoul-Henning Kamp#
9102b851aebSRobert Watson# XXX: These have been disabled in FreeBSD 7.0 as they are not MPSAFE.
9112b851aebSRobert Watson#
9123f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
9133f8c4506SPoul-Henning Kamp#	for ATM support.
9143f8c4506SPoul-Henning Kamp#
9153f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
9163f8c4506SPoul-Henning Kamp#
9173f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
9183f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
9193f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
9203f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
9213f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
9223f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
9233f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
9243f8c4506SPoul-Henning Kamp#
9253f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
9263f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
9273f8c4506SPoul-Henning Kamp#
92858aa55efSHartmut Brandt# The `harp' pseudo-driver makes all NATM interface drivers available to HARP.
92958aa55efSHartmut Brandt#
9302b851aebSRobert Watson#options 	ATM_CORE		#core ATM protocol family
9312b851aebSRobert Watson#options 	ATM_IP			#IP over ATM support
9322b851aebSRobert Watson#options 	ATM_SIGPVC		#SIGPVC signalling manager
9332b851aebSRobert Watson#options 	ATM_SPANS		#SPANS signalling manager
9342b851aebSRobert Watson#options 	ATM_UNI			#UNI signalling manager
93526837af4SMatthew N. Dodd
9362b851aebSRobert Watson#device		hfa			#FORE PCA-200E ATM PCI
9372b851aebSRobert Watson#device		harp			#Pseudo-interface for NATM
9383f8c4506SPoul-Henning Kamp
9396a8d6623SGarrett Wollman
9406a8d6623SGarrett Wollman#####################################################################
9416a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
942e3178a06SJordan K. Hubbard
9432365e64fSRodney W. Grimes#
9446a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
9456a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
946888a8e35SPoul-Henning Kamp# time.  (Exception: the UFS family--- FFS --- cannot
9476a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
9486a8d6623SGarrett Wollman# compile other filesystems as well.
9496a8d6623SGarrett Wollman#
950534046e3SRong-En Fan# NB: The PORTAL filesystem is known to be buggy, and WILL panic your
951534046e3SRong-En Fan# system if you attempt to do anything with it.  It is included here
952534046e3SRong-En Fan# as an incentive for some enterprising soul to sit down and fix it.
953534046e3SRong-En Fan# The UNION filesystem was known to be buggy in the past.  It is now
954534046e3SRong-En Fan# being actively maintained, although there are still some issues being
955534046e3SRong-En Fan# resolved.
9562365e64fSRodney W. Grimes#
957f1a9c715SDavid Greenman
9586a8d6623SGarrett Wollman# One of these is mandatory:
9596a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
960dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
9616a8d6623SGarrett Wollman
9626a8d6623SGarrett Wollman# The rest are optional:
9635895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
96499d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
9650adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
966dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
967dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
968dfdcada3SDoug Rabsonoptions		NFSLOCKD		#Network Lock Manager
9693ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
970f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
971dd1c7d13SBruce Evans# Broken (depends on NCP):
972b40ce416SJulian Elischer#options 	NWFS			#NetWare filesystem
97399d300a1SRuslan Ermilovoptions 	PORTALFS		#Portal filesystem
9744d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
97552ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
976bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
977daaa73b5SRobert Watsonoptions 	SMBFS			#SMB/CIFS filesystem
978df263cbdSScott Longoptions 	UDF			#Universal Disk Format
97999d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
980bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
981bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
982f1a9c715SDavid Greenman
983d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
984d61e6649SAlexander Langer# making abrupt shutdown less risky.
985f8f8d7afSEivind Eklund#
9863d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
987b1897c19SJulian Elischer
988a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
98951be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
99051be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
99149993db0SRobert Watsonoptions 	UFS_EXTATTR
99249993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
993a64ed089SRobert Watson
99451be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
99551be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
99651be6918SChris D. Faulhaber# for the underlying filesystem.
99751be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
99851be6918SChris D. Faulhaberoptions 	UFS_ACL
99951be6918SChris D. Faulhaber
10009b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10019b5ad47fSIan Dowse# directories at the expense of some memory.
10029b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10039b5ad47fSIan Dowse
1004f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1005f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1006f348204cSPawel Jakub Dawidek
100771e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
100871e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
100971e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
101071e4fff8SPoul-Henning Kamp
101171e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
101271e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
101371e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1014d52d7365SPoul-Henning Kamp
1015495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10162365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10176a8d6623SGarrett Wollman
1018276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
1019276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
1020276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1021276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1022ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10236110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1024276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1025276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
1026276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
1027276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1028276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1029276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1030cb800e34SJulian Elischer#
1031cb800e34SJulian Elischeroptions 	SUIDDIR
1032cb800e34SJulian Elischer
1033df394affSJohn-Mark Gurney# NFS options:
10345895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10355895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10365895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10375895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10385895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10395895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1040df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1041df394affSJohn-Mark Gurney
10429afcea2fSRobert V. Baron# Coda stuff:
10439afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
1044f37a929cSPeter Wemmdevice		vcoda			#coda minicache <-> venus comm.
1045d14e51c9STim J. Robbins# Use the old Coda 5.x venus<->kernel interface instead of the new
1046d14e51c9STim J. Robbins# realms-aware 6.x protocol.
1047d14e51c9STim J. Robbins#options 	CODA_COMPAT_5
1048a1d55890SJordan K. Hubbard
1049053a2b61SEivind Eklund#
1050053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1051053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1052053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1053053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1054053a2b61SEivind Eklund#
10555895e3c8SPeter Wemmoptions 	EXT2FS
1056053a2b61SEivind Eklund
1057fe98fb32SJean-Sébastien Pédron#
1058fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1059fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1060fe98fb32SJean-Sébastien Pédron#
1061fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1062fe98fb32SJean-Sébastien Pédron
10637b30d718SCraig Rodrigues#
10647b30d718SCraig Rodrigues# Add support for the SGI XFS filesystem. Currently,
10657b30d718SCraig Rodrigues# this is limited to read-only access.
10667b30d718SCraig Rodrigues#
10677b30d718SCraig Rodriguesoptions 	XFS
10687b30d718SCraig Rodrigues
1069dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
10700cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
10710cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1072dd85920aSJason Evansoptions 	VFS_AIO
1073053a2b61SEivind Eklund
10748ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1075ac519db0SMark Murraydevice		random
107615bbdecfSMark Murray
10778ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
10788ab2f5ecSMark Murraydevice		mem
10798ab2f5ecSMark Murray
1080c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1081c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1082c4f02a89SMax Khonoptions 	CD9660_ICONV
1083c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1084c4f02a89SMax Khonoptions 	NTFS_ICONV
1085126f0dfaSScott Longoptions 	UDF_ICONV
1086c4f02a89SMax Khon
10876a8d6623SGarrett Wollman
10886a8d6623SGarrett Wollman#####################################################################
1089abc97a06SBruce Evans# POSIX P1003.1B
1090abc97a06SBruce Evans
10911c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1092abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1093abc97a06SBruce Evans
10945895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
10958cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
10968cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
10973ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1098abc97a06SBruce Evans
10995b40ce27SDavid Xu# POSIX message queue
11005b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1101abc97a06SBruce Evans
1102abc97a06SBruce Evans#####################################################################
110312e9f256SRobert Watson# SECURITY POLICY PARAMETERS
110412e9f256SRobert Watson
1105fdcba197SRobert Watson# Support for BSM audit
1106fdcba197SRobert Watsonoptions 	AUDIT
1107fdcba197SRobert Watson
1108cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1109cd6d1d76SBruce Evansoptions 	MAC
1110eae2f20cSRobert Watsonoptions 	MAC_BIBA
1111eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1112eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1113c4725737SRobert Watsonoptions 	MAC_LOMAC
1114eae2f20cSRobert Watsonoptions 	MAC_MLS
1115eae2f20cSRobert Watsonoptions 	MAC_NONE
1116eae2f20cSRobert Watsonoptions 	MAC_PARTITION
111703d03162SRobert Watsonoptions 	MAC_PORTACL
1118eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1119782f7255SRobert Watsonoptions 	MAC_STUB
1120eae2f20cSRobert Watsonoptions 	MAC_TEST
112112e9f256SRobert Watson
112212e9f256SRobert Watson
112312e9f256SRobert Watson#####################################################################
1124000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1125000033d0SJeroen Ruigrok van der Werven
1126000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1127358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1128358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1129358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1130358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1131358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1132358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1133358f8d82SRobert Watson# actually reducing the accuracy of operation.
1134000033d0SJeroen Ruigrok van der Werven
1135000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1136000033d0SJeroen Ruigrok van der Werven
1137f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1138f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1139f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1140f309f881SJohn Baldwin
1141f309f881SJohn Baldwinoptions 	PPS_SYNC
1142f309f881SJohn Baldwin
1143000033d0SJeroen Ruigrok van der Werven
1144000033d0SJeroen Ruigrok van der Werven#####################################################################
1145de6a307eSPeter Dufault# SCSI DEVICES
1146de6a307eSPeter Dufault
11476a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
11486a8d6623SGarrett Wollman
11496a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1150ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
11516a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
11526a8d6623SGarrett Wollman# device configuration sections below.
11536a8d6623SGarrett Wollman#
1154e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1155e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1156e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1157e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1158e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1159e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1160e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1161e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1162e14eb5a1SGarrett Wollman# problem.)
1163ebc1a0e2SPeter Dufault
1164ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1165ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1166700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1167700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1168ebc1a0e2SPeter Dufault
1169ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1170ebc1a0e2SPeter Dufault
1171f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1172f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1173f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1174f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1175f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1176f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1177f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1178f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1179f71c01ccSPeter Wemmhint.da.0.target="0"
1180f71c01ccSPeter Wemmhint.da.0.unit="0"
1181f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1182f71c01ccSPeter Wemmhint.da.1.target="1"
1183f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1184f71c01ccSPeter Wemmhint.da.2.target="3"
1185f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1186f71c01ccSPeter Wemmhint.sa.1.target="6"
1187ebc1a0e2SPeter Dufault
1188ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1189ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1190ebc1a0e2SPeter Dufault
1191ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1192ebc1a0e2SPeter Dufault
1193cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1194cf2458c9SMatt Jacob#
1195cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1196cf2458c9SMatt Jacob# ("WORM") devices.
1197cf2458c9SMatt Jacob#
1198cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1199cf2458c9SMatt Jacob#
1200cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1201cf2458c9SMatt Jacob#
12023c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12033c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1204cf2458c9SMatt Jacob#
1205cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1206cf2458c9SMatt Jacob#
12071eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12081eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12091eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
12101eba4c79SScott Long# source level API compatiblity for porting apps to FreeBSD.
1211cf2458c9SMatt Jacob#
1212cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1213cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1214cf2458c9SMatt Jacob#
1215cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1216cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1217cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1218cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1219cf2458c9SMatt Jacob#
1220cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1221cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1222cf2458c9SMatt Jacob# to them.
1223cf2458c9SMatt Jacob#
1224265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
1225cf2458c9SMatt Jacob# configuration as the "pass" driver.
1226ebc1a0e2SPeter Dufault
1227c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1228c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1229c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1230c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1231c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
123264ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
1233cf2458c9SMatt Jacobdevice		pt		#SCSI processor
123464ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
123564ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1236cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12371eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
12388909a72bSPeter Dufault
1239700daf5eSJustin T. Gibbs# CAM OPTIONS:
1240700daf5eSJustin T. Gibbs# debugging options:
1241700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
1242700daf5eSJustin T. Gibbs#             specify them all!
1243700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
1244700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
1245700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
1246700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
1247d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
1248d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
1249700daf5eSJustin T. Gibbs#
1250700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1251700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1252700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
125356234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
125456234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
12553a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
12563a937198SBrooks Davis#             can be changed at boot and runtime with the
12573a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1258700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
12595895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
12605895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
12615895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
126225388b6cSBruce Evansoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB)
12635895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1264700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1265700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
126632672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
12671a7c583cSGarrett Wollman
1268700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1269700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1270700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1271700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1272700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1273700daf5eSJustin T. Gibbs# respectively.
127493063432SJoerg Wunsch#
1275700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1276700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1277700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
127893063432SJoerg Wunsch#
12795895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
12805895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
128193063432SJoerg Wunsch
12829dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1283b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
12849dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
12859dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
12869dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
12879f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
128825388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
128925388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
129025388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
129125388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
12929f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
12939dfb4471SKenneth D. Merry
12943ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
12953ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
129625388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
12973ece1bd2SKenneth D. Merry
12988904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
12998904e70bSMatt Jacob#
13008904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13018904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13028904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
13038904e70bSMatt Jacob# are in....
13048904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13058904e70bSMatt Jacob
13066a8d6623SGarrett Wollman
13076a8d6623SGarrett Wollman#####################################################################
13086a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13096a8d6623SGarrett Wollman
13101160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
13111160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
13121160da92SJoerg Wunsch# `xterm', among others.
13131160da92SJoerg Wunsch
1314f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
13156d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1316f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1317f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
1318efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13196aec1278SMax Laierdevice		firmware	#firmware(9) support
1320be174c7eSGreg Lehey
13216f2d8adbSBoris Popov# Kernel side iconv library
13226f2d8adbSBoris Popovoptions 	LIBICONV
13236f2d8adbSBoris Popov
132458067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13255895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
132658067a99SPoul-Henning Kamp
13279c62b3eeSDavid Schultz# Maximum size of a tty or pty input buffer.
13289c62b3eeSDavid Schultzoptions 	TTYHOG=8193
13299c62b3eeSDavid Schultz
13306a8d6623SGarrett Wollman
13316a8d6623SGarrett Wollman#####################################################################
1332d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1333d61e6649SAlexander Langer
1334d61e6649SAlexander Langer# For ISA the required hints are listed.
13355bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13365bcb64f2SWarner Losh# no hints are needed.
1337d61e6649SAlexander Langer
1338d61e6649SAlexander Langer#
1339d61e6649SAlexander Langer# Mandatory devices:
1340d61e6649SAlexander Langer#
1341d61e6649SAlexander Langer
13426e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13436e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13446e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13456e818956SDavid E. O'Brien
13467f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13477f5092f3SJohn Baldwin
1348837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1349837f167eSRuslan Ermilov
1350905e8b43SDag-Erling Smørgrav# Various screen savers.
1351905e8b43SDag-Erling Smørgravdevice		blank_saver
1352905e8b43SDag-Erling Smørgravdevice		daemon_saver
1353905e8b43SDag-Erling Smørgravdevice		dragon_saver
1354905e8b43SDag-Erling Smørgravdevice		fade_saver
1355905e8b43SDag-Erling Smørgravdevice		fire_saver
1356905e8b43SDag-Erling Smørgravdevice		green_saver
1357905e8b43SDag-Erling Smørgravdevice		logo_saver
1358905e8b43SDag-Erling Smørgravdevice		rain_saver
1359905e8b43SDag-Erling Smørgravdevice		snake_saver
1360905e8b43SDag-Erling Smørgravdevice		star_saver
1361905e8b43SDag-Erling Smørgravdevice		warp_saver
1362905e8b43SDag-Erling Smørgrav
13631c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1364f453022cSPeter Wemmdevice		sc
1365f71c01ccSPeter Wemmhint.sc.0.at="isa"
1366683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
13676e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
13686e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1369cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1370e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1371c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
13726e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
13736e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
13746e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
137585e36760SJordan K. Hubbard
13767a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
137725388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
137825388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
137925388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
138025388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
13817a88382dSKazutaka YOKOTA
138278f45204SMaxim Sobolev# The following options will let you change the default behaviour of
138378f45204SMaxim Sobolev# cut-n-paste feature
138478f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
138525388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
138625388b6cSBruce Evans					# (default is single space - \"x20\")
138778f45204SMaxim Sobolev
13887a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
13897a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
13907a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
13917a88382dSKazutaka YOKOTA
13926e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
13936e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
13946e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
13956e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
13966e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
13976e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1398c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
13992ac8be82SAndreas Schulz
14008a28ce0eSJohn Baldwin# `flags' for sc
14018a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14028a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14038a28ce0eSJohn Baldwin
14041fe04850SBruce Evans#
1405d61e6649SAlexander Langer# Optional devices:
14066a8d6623SGarrett Wollman#
14076a8d6623SGarrett Wollman
14086a8d6623SGarrett Wollman#
1409d61e6649SAlexander Langer# SCSI host adapters:
14106a8d6623SGarrett Wollman#
14117f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1412859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14136e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14147f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1415d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1416d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1417cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14187f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1419d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1420d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
14216e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14226e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
14231b946e21SScott Long# esp: NCR53c9x.  Only for SBUS hardware right now.
1424d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1425d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1426d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1427e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1428e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1429af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1430ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
143164fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
143264fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1433d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1434fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1435fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1436fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1437fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1438f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
14396e818956SDavid E. O'Brien# wds: WD7000
1440d61e6649SAlexander Langer
14416e818956SDavid E. O'Brien#
14426e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
14436e818956SDavid E. O'Brien# probed correctly.
14446e818956SDavid E. O'Brien#
14456e818956SDavid E. O'Briendevice		bt
14466e818956SDavid E. O'Brienhint.bt.0.at="isa"
14476e818956SDavid E. O'Brienhint.bt.0.port="0x330"
14487f5092f3SJohn Baldwindevice		adv
14497f5092f3SJohn Baldwinhint.adv.0.at="isa"
1450c9953c3bSPeter Wemmdevice		adw
14516e818956SDavid E. O'Briendevice		aha
14526e818956SDavid E. O'Brienhint.aha.0.at="isa"
14537f5092f3SJohn Baldwindevice		aic
14547f5092f3SJohn Baldwinhint.aic.0.at="isa"
14557f5092f3SJohn Baldwindevice		ahb
1456d61e6649SAlexander Langerdevice		ahc
1457cdd49e97SJustin T. Gibbsdevice		ahd
1458d61e6649SAlexander Langerdevice		amd
14591b946e21SScott Longdevice		esp
1460c5933b20SScott Longdevice		iscsi_initiator
1461d61e6649SAlexander Langerdevice		isp
14620787f2b8SMatt Jacobhint.isp.0.disable="1"
14630787f2b8SMatt Jacobhint.isp.0.role="3"
14640787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
14650787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
14660787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
14670787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
14680787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
14690787f2b8SMatt Jacobhint.isp.0.topology="lport"
14700787f2b8SMatt Jacobhint.isp.0.topology="nport"
14710787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
14720787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
14730787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
14740787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
14750787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
14760787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1477d61e6649SAlexander Langerdevice		ispfw
147864fa5108SMatt Jacobdevice		mpt
1479d61e6649SAlexander Langerdevice		ncr
1480d61e6649SAlexander Langerdevice		sym
1481f3d92b26SOlivier Houcharddevice		trm
14826e818956SDavid E. O'Briendevice		wds
14836e818956SDavid E. O'Brienhint.wds.0.at="isa"
14846e818956SDavid E. O'Brienhint.wds.0.port="0x350"
14856e818956SDavid E. O'Brienhint.wds.0.irq="11"
14866e818956SDavid E. O'Brienhint.wds.0.drq="6"
1487d61e6649SAlexander Langer
1488d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1489d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1490d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1491d61e6649SAlexander Langer# default.
1492d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1493d61e6649SAlexander Langer
1494fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1495fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1496fac70739SJeroen Ruigrok van der Werven
1497fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1498fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1499fac70739SJeroen Ruigrok van der Werven
1500662d3818SScott Long# Compile in Aic7xxx Debugging code.
1501662d3818SScott Longoptions 	AHC_DEBUG
1502662d3818SScott Long
1503662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1504662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1505662d3818SScott Long
1506f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1507f8f8803bSBruce Evans# See ahc(4).
1508662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1509662d3818SScott Long
1510cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1511cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1512cdd49e97SJustin T. Gibbs
1513f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1514cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1515cdd49e97SJustin T. Gibbs
151643e9d8a3SScott Long# Print human-readable register definitions when debugging
151743e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
151843e9d8a3SScott Long
1519662d3818SScott Long# Bitmap of units to enable targetmode operations.
1520662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1521662d3818SScott Long
1522d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1523d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1524d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1525d61e6649SAlexander Langer
1526c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1527c5933b20SScott Long#
1528c5933b20SScott Longoptions		ISCSI_INITIATOR_DEBUG=9
1529c5933b20SScott Long
1530d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1531d61e6649SAlexander Langer#
1532d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1533d61e6649SAlexander Langer#
153464fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1535af606348SMatt Jacob#
15369a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
15379a1b0d43SMatt Jacob#		none=0
15389a1b0d43SMatt Jacob#		target=1
15399a1b0d43SMatt Jacob#		initiator=2
15409a1b0d43SMatt Jacob#		both=3			(not supported currently)
1541af606348SMatt Jacob#
15429a1b0d43SMatt Jacoboptions 	ISP_DEFAULT_ROLES=2
1543d61e6649SAlexander Langer
1544d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1545d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1546d61e6649SAlexander Langer					# Allows the ncr to take precedence
1547d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1548d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1549d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1550d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1551d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1552d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1553d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1554d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1555d61e6649SAlexander Langer					# default:8, range:[1..64]
15566a8d6623SGarrett Wollman
15576e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
15586e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
15596e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
15606e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
15616e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
15626e818956SDavid E. O'Brien#
15636e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
15646e818956SDavid E. O'Brien#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
15656e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
15666e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
15676e818956SDavid E. O'Brien#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
15686e818956SDavid E. O'Brien#                           If you ant the driver to handle timeouts, enable
15696e818956SDavid E. O'Brien#                           this option.  If your system is very busy, this
15706e818956SDavid E. O'Brien#                           option will create more trouble than solve.
15716e818956SDavid E. O'Brien#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
15726e818956SDavid E. O'Brien#                           wait when timing out with the above option.
15736e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
15746e818956SDavid E. O'Brien#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
15756e818956SDavid E. O'Brien#                           any interrupt that got lost.  Seems to help in some
15766e818956SDavid E. O'Brien#                           DPT-firmware/Motherboard combinations.  Minimal
15776e818956SDavid E. O'Brien#                           cost, great benefit.
15786e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
15796e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
15806e818956SDavid E. O'Brien#			    are 100% certain you need it.
15816e818956SDavid E. O'Brien
15826e818956SDavid E. O'Briendevice		dpt
15836e818956SDavid E. O'Brien
15846e818956SDavid E. O'Brien# DPT options
15856e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
15866e818956SDavid E. O'Brien#!CAM# options 	DPT_HANDLE_TIMEOUTS
15876e818956SDavid E. O'Brienoptions 	DPT_TIMEOUT_FACTOR=4
15886e818956SDavid E. O'Brienoptions 	DPT_LOST_IRQ
15896e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
15906e818956SDavid E. O'Brien
15916e818956SDavid E. O'Brien#
15926e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
15936e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
15946e818956SDavid E. O'Brien# CAM infrastructure.
15956e818956SDavid E. O'Brien#
15966e818956SDavid E. O'Briendevice		ciss
15976e818956SDavid E. O'Brien
15986e818956SDavid E. O'Brien#
15996e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16006e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16016e818956SDavid E. O'Brien# at Intel for this driver are
16026e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16036e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16046e818956SDavid E. O'Brien#
16056e818956SDavid E. O'Briendevice		iir
16066e818956SDavid E. O'Brien
16076e818956SDavid E. O'Brien#
16086e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16096e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16106e818956SDavid E. O'Brien# the CAM infrastructure.
16116e818956SDavid E. O'Brien#
16126e818956SDavid E. O'Briendevice		mly
16136e818956SDavid E. O'Brien
16146e818956SDavid E. O'Brien#
16156e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16166e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16176e818956SDavid E. O'Brien# controllers.
16186e818956SDavid E. O'Brien#
16196e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16206e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16216e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
16227f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1623f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16246b31d3f7SScott Longoptions 	MFI_DEBUG
16256e818956SDavid E. O'Brien
16266e818956SDavid E. O'Brien#
16276e818956SDavid E. O'Brien# 3ware ATA RAID
16286e818956SDavid E. O'Brien#
16296e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16306e818956SDavid E. O'Brien
163190d3341eSPeter Wemm#
16326d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
16336d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
16346d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1635c9953c3bSPeter Wemmdevice		ata
1636c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1637ce7e8badSAlex Dupredevice		ataraid		# ATA RAID drives
1638c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1639c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1640c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
1641c91a27d2SScott Longdevice		atapicam	# emulate ATAPI devices as SCSI ditto via CAM
1642fd4b4eccSSøren Schmidt				# needs CAM to be present (scbus & pass)
16438b89ef0aSSøren Schmidt#
16446d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
16456d04301dSAlexander Langerhint.ata.0.at="isa"
16466d04301dSAlexander Langerhint.ata.0.port="0x1f0"
16476d04301dSAlexander Langerhint.ata.0.irq="14"
16486d04301dSAlexander Langerhint.ata.1.at="isa"
16496d04301dSAlexander Langerhint.ata.1.port="0x170"
16506d04301dSAlexander Langerhint.ata.1.irq="15"
16516d04301dSAlexander Langer
16526d04301dSAlexander Langer#
1653000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1654000da71aSSøren Schmidt#
1655000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
165674d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
165774d8e840SSøren Schmidt
165874d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
165974d8e840SSøren Schmidt
16608b89ef0aSSøren Schmidt#
16616d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
16626d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
16636a8d6623SGarrett Wollman#
1664f71c01ccSPeter Wemmdevice		fdc
1665f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1666f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1667f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1668f71c01ccSPeter Wemmhint.fdc.0.drq="2"
166985827d9cSJoerg Wunsch#
1670d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1671d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1672d2fb4892SJoerg Wunsch# however.
1673d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1674d2fb4892SJoerg Wunsch#
1675f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1676f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1677f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1678f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
167985827d9cSJoerg Wunsch
1680f71c01ccSPeter Wemm# Specify floppy devices
1681f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1682f71c01ccSPeter Wemmhint.fd.0.drive="0"
1683f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1684f71c01ccSPeter Wemmhint.fd.1.drive="1"
168585827d9cSJoerg Wunsch
16866a8d6623SGarrett Wollman#
1687501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1688501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1689c8956b36SMarcel Moolenaar#
1690501ef98fSMarcel Moolenaardevice		uart
1691501ef98fSMarcel Moolenaar
16928194412bSMarcel Moolenaar# Options for uart(4)
16938194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
16948194412bSMarcel Moolenaar					# instead of DCD.
16958194412bSMarcel Moolenaar
1696501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1697501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1698501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1699501ef98fSMarcel Moolenaar
1700c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1701c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1702c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1703c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1704c8956b36SMarcel Moolenaar# unit number of the probed UART.
1705501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1706501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1707501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1708501ef98fSMarcel Moolenaar
1709501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1710c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1711c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1712c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1713c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1714c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1715c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1716c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1717c8956b36SMarcel Moolenaar#		preferred.  Setting this flag for sio0 gives the old behaviour.
1718c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1719c8956b36SMarcel Moolenaar#		as debug port.
17209546766aSBruce Evans#
17219546766aSBruce Evans
1722501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1723c8956b36SMarcel Moolenaaroptions 	BREAK_TO_DEBUGGER	# A BREAK on a serial console goes to
1724c8956b36SMarcel Moolenaar					# ddb, if available.
17256a8d6623SGarrett Wollman
172626b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
172726b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
172826b6ea69SPaul Saab# Sun servers by the Remote Console.
172926b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
173026b6ea69SPaul Saab
1731af2e25a6SMarcel Moolenaar# Serial Communications Controller
1732af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1733af2e25a6SMarcel Moolenaar# communications controllers.
1734af2e25a6SMarcel Moolenaardevice		scc
1735af2e25a6SMarcel Moolenaar
17369c564b6cSJohn Hay# PCI Universal Communications driver
173764220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
17389c564b6cSJohn Haydevice		puc
17399c564b6cSJohn Hay
17406a8d6623SGarrett Wollman#
1741d61e6649SAlexander Langer# Network interfaces:
17426a8d6623SGarrett Wollman#
1743d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1744d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
17453c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII. Adding
1746d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1747d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1748d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1749d61e6649SAlexander Langer# individual driver.
1750d61e6649SAlexander Langerdevice		miibus
1751d61e6649SAlexander Langer
17527f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
17537f5092f3SJohn Baldwin#       PCI and ISA varieties.
1754cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1755cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1756343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1757343ed0a8SJohn Baldwin#       adapters.
1758343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
175995d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1760586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1761586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1762586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
17637f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
17647f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
17657f5092f3SJohn Baldwin# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
1766d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1767d61e6649SAlexander Langer#       and various workalikes including:
1768d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1769d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1770d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1771d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1772d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1773d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1774d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1775d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1776d61e6649SAlexander Langer#       KNE110TX.
1777d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1778a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
177996a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
17807f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
17817f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
17827f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
17837f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
17847f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
17857f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1786d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1787d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1788cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
17891ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
179052c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
179144ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1792c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1793c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1794c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1795c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1796c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1797c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1798c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
17992bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1800d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1801ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1802ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1803ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1804cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1805cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
180641f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
18070fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
18080fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
18090fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
18100fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
18110fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1812d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1813d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1814d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1815d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1816d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1817d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1818d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1819d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1820d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1821d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1822d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1823d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1824d61e6649SAlexander Langer#       card which is 32-bit.
1825b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1826b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
18277d0de413SMax Khon# sbsh:	Support for Granch SBNI16 SHDSL modem PCI adapters
1828d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1829d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1830d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1831d61e6649SAlexander Langer#       (also single mode and multimode).
1832d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1833d61e6649SAlexander Langer#       attach each one as a separate network interface.
18347f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
18357f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1836d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1837d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1838d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1839d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1840d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1841d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1842d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1843c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1844c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
1845d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1846d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1847d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1848d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1849d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
18503c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
1851362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
1852d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1853d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1854d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1855d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1856d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1857d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1858d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1859d61e6649SAlexander Langer#       NE2000 clone.
18607f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
18617f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
18627f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
18637f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
18647f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
18657f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1866d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1867d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1868d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1869d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1870d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1871d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1872d61e6649SAlexander Langer
18737f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
18747f5092f3SJohn Baldwin
18757f5092f3SJohn Baldwindevice		cm
18767f5092f3SJohn Baldwinhint.cm.0.at="isa"
18777f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
18787f5092f3SJohn Baldwinhint.cm.0.irq="9"
18797f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
18807f5092f3SJohn Baldwindevice		ep
18817f5092f3SJohn Baldwindevice		ex
1882c06a3350SPeter Wemmdevice		fe
18837f5092f3SJohn Baldwinhint.fe.0.at="isa"
18847f5092f3SJohn Baldwinhint.fe.0.port="0x300"
18857f5092f3SJohn Baldwindevice		fea
18867f5092f3SJohn Baldwindevice		sn
18877f5092f3SJohn Baldwinhint.sn.0.at="isa"
18887f5092f3SJohn Baldwinhint.sn.0.port="0x300"
18897f5092f3SJohn Baldwinhint.sn.0.irq="10"
18907f5092f3SJohn Baldwindevice		an
18917f5092f3SJohn Baldwindevice		cnw
18927f5092f3SJohn Baldwindevice		wi
18937f5092f3SJohn Baldwindevice		xe
18947f5092f3SJohn Baldwin
1895d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1896cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
1897343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
1898343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
1899343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
19008090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
1901404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
1902d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
19034664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
19044664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
19051ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
190652c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
1907343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
1908d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
1909343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
1910d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
19112e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
1912d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
19137d0de413SMax Khondevice		sbsh		# Granch SBNI16 SHDSL modem
1914d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1915343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
1916d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1917d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1918eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1919d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1920d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1921d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1922d61e6649SAlexander Langer
1923d61e6649SAlexander Langer# PCI Ethernet NICs.
1924d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
1925c6c22d35SJack F Vogel#device		em		# Intel Pro/1000 Gigabit Ethernet
1926c6c22d35SJack F Vogel#device		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
1927c6c22d35SJack F Vogel#device		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
192844ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
1929f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
1930fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
19316e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
193295d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
1933c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1934d61e6649SAlexander Langer
1935343ed0a8SJohn Baldwin# PCI FDDI NICs.
1936c06a3350SPeter Wemmdevice		fpa
1937d61e6649SAlexander Langer
19382bc6081cSScott Long# PCI WAN adapters.
19392bc6081cSScott Longdevice		lmc
19402bc6081cSScott Long
194198cb733cSKenneth D. Merry# Use "private" jumbo buffers allocated exclusively for the ti(4) driver.
194298cb733cSKenneth D. Merry# This option is incompatible with the TI_JUMBO_HDRSPLIT option below.
194398cb733cSKenneth D. Merry#options 	TI_PRIVATE_JUMBOS
194498cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
194598cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
194698cb733cSKenneth D. Merryoptions 	TI_JUMBO_HDRSPLIT
194798cb733cSKenneth D. Merry
19482c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
19492c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
19502c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
19512c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
19522c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
19532c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
19542c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
19552c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
19562c8f5a28SKenneth D. Merry
195768713f97SKenjiro Cho#
195844b5247dSKenjiro Cho# ATM related options (Cranor version)
195944b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
196068713f97SKenjiro Cho#
196168713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
196268713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
196368713f97SKenjiro Cho#
1964c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
1965c594298bSHartmut Brandt# ATM PCI cards.
1966c594298bSHartmut Brandt#
1967fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
1968fb24f088SHartmut Brandt#
19698dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
19708dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
19718dd4275cSHartmut Brandt#
1972f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
197368713f97SKenjiro Cho# atm devices.
19743cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
197568713f97SKenjiro Cho# bypass TCP/IP.
197668713f97SKenjiro Cho#
1977fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
1978fb24f088SHartmut Brandt# hatm and fatm.
19791ba46a03SHartmut Brandt#
198068713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
198168713f97SKenjiro Cho# for more details, please read the original documents at
198298a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
198368713f97SKenjiro Cho#
1984f71c01ccSPeter Wemmdevice		atm
198544b5247dSKenjiro Chodevice		en
1986fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
1987c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
19888dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
19891ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
19903cbceb82SKenjiro Chooptions 	NATM			#native ATM
1991f4567b9cSJulian Elischer
19927e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
19937e9024cdSHartmut Brandt
1994c19da41eSPeter Wemm#
19950739ea1dSSeigo Tanimura# Sound drivers
1996c19da41eSPeter Wemm#
19970739ea1dSSeigo Tanimura# sound: The generic sound driver.
1998c7406082SJohn-Mark Gurney#
19990739ea1dSSeigo Tanimura
20000739ea1dSSeigo Tanimuradevice		sound
20010739ea1dSSeigo Tanimura
20020739ea1dSSeigo Tanimura#
20030739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2004c7406082SJohn-Mark Gurney#
20057f5092f3SJohn Baldwin# The flags of the device tells the device a bit more info about the
20067f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
20077f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
20087f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
20097f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
20107f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
20117f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
20127f5092f3SJohn Baldwin#
2013c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
20140739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2015d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2016903b2fb9SJoel Dahl# snd_au88x0		Aureal Vortex 1/2/Advantage PCI. This driver
2017903b2fb9SJoel Dahl#			lacks support for playback and recording.
2018903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2019903b2fb9SJoel Dahl#			for sparc64.
20200739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
20210739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
20220739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
20230739ea1dSSeigo Tanimura#			4281)
20240739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
20250739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
20260fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
20279f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
20289f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
20290739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2030727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2031727ded3aSJoel Dahl#			conjunction with snd_sbc.
20320739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
20330739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
20344b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
20354b8939a1SAriff Abdullah#			compatible.
20360739ea1dSSeigo Tanimura# snd_ich:		Intel ICH PCI and some more audio controllers
2037903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2038903b2fb9SJoel Dahl#			nForce controllers.
20390739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
20400739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
20410739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
20420739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
20430739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
20441c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20450739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
20461c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
20470739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
20487f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
20499f548240SAlexander Leidinger# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
20500739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2051903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
20520739ea1dSSeigo Tanimura#			M5451 PCI.
20530739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
20540739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
20550739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
20560739ea1dSSeigo Tanimura# snd_uaudio:		USB audio.
205781bb901eSPeter Wemm
2058f37a929cSPeter Wemmdevice		snd_ad1816
2059f37a929cSPeter Wemmdevice		snd_als4000
2060d9bde1adSAriff Abdullahdevice		snd_atiixp
2061f37a929cSPeter Wemm#device		snd_au88x0
20627a7386a3SPyun YongHyeon#device		snd_audiocs
20630739ea1dSSeigo Tanimuradevice		snd_cmi
2064f37a929cSPeter Wemmdevice		snd_cs4281
20650739ea1dSSeigo Tanimuradevice		snd_csa
2066f37a929cSPeter Wemmdevice		snd_ds1
2067f37a929cSPeter Wemmdevice		snd_emu10k1
20680fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2069b1ff0220SAlexander Leidingerdevice		snd_envy24
20709f548240SAlexander Leidingerdevice		snd_envy24ht
2071f37a929cSPeter Wemmdevice		snd_es137x
20720739ea1dSSeigo Tanimuradevice		snd_ess
2073f37a929cSPeter Wemmdevice		snd_fm801
20740739ea1dSSeigo Tanimuradevice		snd_gusc
20754b8939a1SAriff Abdullahdevice		snd_hda
20760739ea1dSSeigo Tanimuradevice		snd_ich
20770739ea1dSSeigo Tanimuradevice		snd_maestro
2078f37a929cSPeter Wemmdevice		snd_maestro3
20790739ea1dSSeigo Tanimuradevice		snd_mss
20800739ea1dSSeigo Tanimuradevice		snd_neomagic
2081f37a929cSPeter Wemmdevice		snd_sb16
2082f37a929cSPeter Wemmdevice		snd_sb8
20830739ea1dSSeigo Tanimuradevice		snd_sbc
20840739ea1dSSeigo Tanimuradevice		snd_solo
20859f548240SAlexander Leidingerdevice		snd_spicds
2086f37a929cSPeter Wemmdevice		snd_t4dwave
2087f37a929cSPeter Wemmdevice		snd_via8233
2088f37a929cSPeter Wemmdevice		snd_via82c686
20890739ea1dSSeigo Tanimuradevice		snd_vibes
20900739ea1dSSeigo Tanimuradevice		snd_uaudio
2091c19da41eSPeter Wemm
20921c9c6382SRuslan Ermilov# For non-PnP sound cards:
2093673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2094673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2095673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2096673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2097673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2098673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2099673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2100673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2101673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2102673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2103673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2104673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2105673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2106673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
21077f5092f3SJohn Baldwin
21086a8d6623SGarrett Wollman#
210983820457SPoul-Henning Kamp# IEEE-488 hardware:
211083820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2111346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2112346fa631SPoul-Henning Kamp
211383820457SPoul-Henning Kampdevice	pcii
211483820457SPoul-Henning Kamphint.pcii.0.at="isa"
211583820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
211683820457SPoul-Henning Kamphint.pcii.0.irq="5"
211783820457SPoul-Henning Kamphint.pcii.0.drq="1"
211883820457SPoul-Henning Kamp
2119346fa631SPoul-Henning Kampdevice	tnt4882
2120346fa631SPoul-Henning Kamp
212183820457SPoul-Henning Kamp#
2122567e21c2SBruce Evans# Miscellaneous hardware:
21236a8d6623SGarrett Wollman#
21246fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
21253ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
21261c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
21272849b131SBruce Evans# cy: Cyclades serial driver
21287f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2129787f1498SJohn Baldwin# rc: RISCom/8 multiport card
2130dd267672SJohn Baldwin# rp: Comtrol Rocketport(ISA/PCI) - single card
21317f5092f3SJohn Baldwin# si: Specialix SI/XIO 4-32 port terminal multiplexor
2132603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2133657e73c4SPeter Dufault
21343b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
21353b577e1fSJordan K. Hubbard#
21363b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
21373b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
21383b577e1fSJordan K. Hubbard#
2139f71c01ccSPeter Wemm#               device  rp	# core driver support
2140f71c01ccSPeter Wemm#
21413b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
2142b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2143b147fcf9SBruce Evans#		hint.rp.0.port="0x280"
21443b577e1fSJordan K. Hubbard#
21453b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
21463b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
2147f71c01ccSPeter Wemm#   your kernel probe hints:
2148b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2149b147fcf9SBruce Evans#		hint.rp.0.port="0x100"
2150b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2151b147fcf9SBruce Evans#		hint.rp.1.port="0x180"
21523b577e1fSJordan K. Hubbard#
21533b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
2154b147fcf9SBruce Evans#		hint.rp.0.at="isa"
2155b147fcf9SBruce Evans#		hint.rp.0.port="0x180"
2156b147fcf9SBruce Evans#		hint.rp.1.at="isa"
2157b147fcf9SBruce Evans#		hint.rp.1.port="0x100"
2158b147fcf9SBruce Evans#		hint.rp.2.at="isa"
2159b147fcf9SBruce Evans#		hint.rp.2.port="0x340"
2160b147fcf9SBruce Evans#		hint.rp.3.at="isa"
2161b147fcf9SBruce Evans#		hint.rp.3.port="0x240"
21623b577e1fSJordan K. Hubbard#
2163dd267672SJohn Baldwin#   For PCI cards, you need no hints.
21643b577e1fSJordan K. Hubbard
21653ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
21663ae5b532SMatthew N. Dodddevice		mcd
21673ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
21683ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
21696fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
21706fe8789dSMatthew N. Dodddevice		scd
21716fe8789dSMatthew N. Doddhint.scd.0.at="isa"
21726fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
21731c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
21747f5092f3SJohn Baldwinhint.joy.0.at="isa"
21757f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2176787f1498SJohn Baldwindevice		rc
2177787f1498SJohn Baldwinhint.rc.0.at="isa"
2178787f1498SJohn Baldwinhint.rc.0.port="0x220"
2179787f1498SJohn Baldwinhint.rc.0.irq="12"
2180f71c01ccSPeter Wemmdevice		rp
21817f5092f3SJohn Baldwinhint.rp.0.at="isa"
21827f5092f3SJohn Baldwinhint.rp.0.port="0x280"
21837f5092f3SJohn Baldwindevice		si
21847f5092f3SJohn Baldwinoptions 	SI_DEBUG
21857f5092f3SJohn Baldwinhint.si.0.at="isa"
21867f5092f3SJohn Baldwinhint.si.0.maddr="0xd0000"
21877f5092f3SJohn Baldwinhint.si.0.irq="12"
2188603d67aeSRink Springerdevice		cmx
2189a800f455SJulian Elischer
2190eeb706c0SJustin T. Gibbs#
2191a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
21921c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2193a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
21941c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
21951c2b5939SRoger Hardiman#
2196a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2197a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2198a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2199a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
22001c2b5939SRoger Hardiman# These options can be used to override the auto detection
220198a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
22021c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
22039ff07e32SAmancio Hasty#
22044f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
22051c2b5939SRoger Hardiman# or
22061c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
22073c7c6c12SMike Pritchard# Specifies the default video capture mode.
2208a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2209a2f87f42SPeter Pentchev# to prevent hangs during initialisation, e.g. VideoLogic Captivator PCI.
2210a9c5b8d0SSøren Schmidt#
22114f5f3f07SBrian Somers# options 	BKTR_USE_PLL
2212a2f87f42SPeter Pentchev# This is required for PAL or SECAM boards with a 28Mhz crystal and no 35Mhz
2213a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2214a9c5b8d0SSøren Schmidt#
22151c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
22161c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
22171c2b5939SRoger Hardiman#
22181c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
22191c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
22201c2b5939SRoger Hardiman#
22211c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
22221c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
22231c2b5939SRoger Hardiman#
22241c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
22251c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
22261c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
22271c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
22281c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
22291c2b5939SRoger Hardiman# As a rough guess, old = before 1998
22301c2b5939SRoger Hardiman#
223130e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
223230e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
223330e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
223430e27d96SAlexander Langer# mono sound.
2235017b0edcSMatt Jacob
2236c17d4340SNicolas Souchu#
2237c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2238c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2239c17d4340SNicolas Souchu#
224028ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
22410f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
224237973e86SPeter Wemm#     device smbus
224337973e86SPeter Wemm#     device iicbus
224437973e86SPeter Wemm#     device iicbb
2245c17d4340SNicolas Souchu#     device iicsmb
22460f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
22470f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
224828ebb692SNicolas Souchu#
2249c06a3350SPeter Wemmdevice		bktr
2250446cee6eSJoerg Wunsch
2251dc9deb29SPoul-Henning Kamp#
22526e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
22536e818956SDavid E. O'Brien#
22545bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
22556e818956SDavid E. O'Brien# pccard: pccard slots
22566e818956SDavid E. O'Brien# cardbus: cardbus slots
22576e818956SDavid E. O'Briendevice		cbb
22586e818956SDavid E. O'Briendevice		pccard
22596e818956SDavid E. O'Briendevice		cardbus
22606e818956SDavid E. O'Brien
22616e818956SDavid E. O'Brien#
22625bcb64f2SWarner Losh# MMC/SD
22635bcb64f2SWarner Losh#
22645bcb64f2SWarner Losh# mmc: mmc bus
22655bcb64f2SWarner Losh# mmcsd: mmc memory and sd cards.
22665bcb64f2SWarner Losh#device		mmc
22675bcb64f2SWarner Losh#device		mmcsd
22685bcb64f2SWarner Losh
22695bcb64f2SWarner Losh#
22708afa373cSNicolas Souchu# SMB bus
22718afa373cSNicolas Souchu#
22723c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
22733c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
22743c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
22758afa373cSNicolas Souchu#
22768afa373cSNicolas Souchu# Supported devices:
22774d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
22788afa373cSNicolas Souchu#
22793c5656bfSArchie Cobbs# Supported SMB interfaces:
228028ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
228128ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
22827f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
22837f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
22847f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
22857f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2286b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
22874d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
228844e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
22894d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
22908afa373cSNicolas Souchu#
2291c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
22923c5656bfSArchie Cobbs
22937f5092f3SJohn Baldwindevice		intpm
22947f5092f3SJohn Baldwindevice		alpm
22957f5092f3SJohn Baldwindevice		ichsmb
22967f5092f3SJohn Baldwindevice		viapm
229744e6ce01SNicolas Souchudevice		amdpm
22984d5f30e0SRuslan Ermilovdevice		amdsmb
229944e6ce01SNicolas Souchudevice		nfpm
23004d5f30e0SRuslan Ermilovdevice		nfsmb
23017f5092f3SJohn Baldwin
2302c9953c3bSPeter Wemmdevice		smb
23038afa373cSNicolas Souchu
23048afa373cSNicolas Souchu#
23058afa373cSNicolas Souchu# I2C Bus
23068afa373cSNicolas Souchu#
23078afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
23088afa373cSNicolas Souchu#
23098afa373cSNicolas Souchu# Supported devices:
23108afa373cSNicolas Souchu# ic	i2c network interface
23118afa373cSNicolas Souchu# iic	i2c standard io
2312f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
23138afa373cSNicolas Souchu#
23148afa373cSNicolas Souchu# Supported interfaces:
231528ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
231628ebb692SNicolas Souchu#
231728ebb692SNicolas Souchu# Other:
231828ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
23198afa373cSNicolas Souchu#
2320c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2321c9953c3bSPeter Wemmdevice		iicbb
23228afa373cSNicolas Souchu
2323c9953c3bSPeter Wemmdevice		ic
2324c9953c3bSPeter Wemmdevice		iic
2325c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
23268afa373cSNicolas Souchu
2327ab4c624bSMike Smith# Parallel-Port Bus
2328ab4c624bSMike Smith#
2329ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2330ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2331ab4c624bSMike Smith# are automatically probed and attached when found.
2332ab4c624bSMike Smith#
2333ab4c624bSMike Smith# Supported devices:
2334ab4c624bSMike Smith# vpo	Iomega Zip Drive
2335f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2336f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2337fdf94d1aSNicolas Souchu# lpt	Parallel Printer
233846f3ff79SMike Smith# plip	Parallel network interface
2339fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2340f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
234128ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2342ab4c624bSMike Smith#
2343ab4c624bSMike Smith# Supported interfaces:
2344ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2345ab4c624bSMike Smith#
2346ef8f7626SNicolas Souchu
23470f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
23480f210c92SNicolas Souchu				  # (see flags in ppc(4))
23495895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
23509d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2351ef8f7626SNicolas Souchu				# compliant peripheral
23525895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
23535895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
23545895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
23555895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
23565895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
23573b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
23583b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2359ef8f7626SNicolas Souchu
2360f71c01ccSPeter Wemmdevice		ppc
2361f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2362f71c01ccSPeter Wemmhint.ppc.0.irq="7"
23630d31b179SPeter Wemmdevice		ppbus
23640d31b179SPeter Wemmdevice		vpo
23650d31b179SPeter Wemmdevice		lpt
23660d31b179SPeter Wemmdevice		plip
23670d31b179SPeter Wemmdevice		ppi
23680d31b179SPeter Wemmdevice		pps
23690d31b179SPeter Wemmdevice		lpbb
23700d31b179SPeter Wemmdevice		pcfclock
2371ab4c624bSMike Smith
23720ac40133SBrian Somers# Kernel BOOTP support
23730ac40133SBrian Somers
23740ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
23750ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
23760ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
23770ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
23780ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
23790ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2380eead3ae9SBenno Riceoptions		BOOTP_BLOCKSIZE=8192 # Override NFS block size
2381432aad0eSTor Egge
2382d94f38acSEivind Eklund#
23834103b765SPoul-Henning Kamp# Add software watchdog routines.
2384370c3cb5SSean Kelly#
23854103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2386370c3cb5SSean Kelly
2387370c3cb5SSean Kelly#
2388b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
23894e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
23904e0ee531SMike Barcroft# it back on at run-time.
2391c796cfa1SAndrzej Bialecki#
2392c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2393c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2394c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2395c796cfa1SAndrzej Bialecki#
239619dde963SPeter Wemm#options 	NO_SWAPPING
2397c796cfa1SAndrzej Bialecki
23989dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
23999dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
24009dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
24019dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
24029dab0776SDavid Greenman#
24035895e3c8SPeter Wemmoptions 	NSFBUFS=1024
24049dab0776SDavid Greenman
240515a1057cSEivind Eklund#
2406053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2407ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2408053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2409053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2410053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2411053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
241215a1057cSEivind Eklund#
241315a1057cSEivind Eklundoptions 	DEBUG_LOCKS
241415a1057cSEivind Eklund
241526086a03SPeter Wemm
241626086a03SPeter Wemm#####################################################################
24171d33cf3dSNick Hibma# USB support
24181d33cf3dSNick Hibma# UHCI controller
2419c9953c3bSPeter Wemmdevice		uhci
24201d33cf3dSNick Hibma# OHCI controller
2421c9953c3bSPeter Wemmdevice		ohci
2422ca3acad1SBernd Walter# EHCI controller
2423ca3acad1SBernd Walterdevice		ehci
242439e5901eSTakanori Watanabe# SL811 Controller
242539e5901eSTakanori Watanabedevice 		slhci
24261d33cf3dSNick Hibma# General USB code (mandatory for USB)
2427c9953c3bSPeter Wemmdevice		usb
24281d33cf3dSNick Hibma#
2429b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2430b5ea1f0cSNick Hibmadevice		udbp
2431d1233ab3SBruce Evans# USB Fm Radio
2432d1233ab3SBruce Evansdevice		ufm
2433f26c33d2SNick Hibma# Generic USB device driver
2434c9953c3bSPeter Wemmdevice		ugen
2435f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2436c9953c3bSPeter Wemmdevice		uhid
24371d33cf3dSNick Hibma# USB keyboard
2438c9953c3bSPeter Wemmdevice		ukbd
24391d33cf3dSNick Hibma# USB printer
2440c9953c3bSPeter Wemmdevice		ulpt
24416521db35SKris Kennaway# USB Iomega Zip 100 Drive (Requires scbus and da)
2442c9953c3bSPeter Wemmdevice		umass
2443ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2444ce17576aSScott Longdevice		umct
2445e9fb12d3SNick Hibma# USB modem support
2446e9fb12d3SNick Hibmadevice		umodem
2447f26c33d2SNick Hibma# USB mouse
2448c9953c3bSPeter Wemmdevice		ums
24491c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2450e2dbd15fSNick Hibmadevice		urio
24512fd84f56SNick Hibma# USB scanners
24522fd84f56SNick Hibmadevice		uscanner
2453d1233ab3SBruce Evans#
2454916e6e02SJosef Karthauser# USB serial support
2455916e6e02SJosef Karthauserdevice		ucom
24569aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
24579aab0d96SMaxim Konovalovdevice		uark
2458d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2459d1233ab3SBruce Evansdevice		ubsa
2460d1233ab3SBruce Evans# USB support for BWCT console serial adapters
2461d1233ab3SBruce Evansdevice		ubser
246248b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
246348b68edfSJosef Karthauserdevice		uftdi
2464c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2465c5286e11STakanori Watanabedevice		uipaq
246648b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2467916e6e02SJosef Karthauserdevice		uplcom
24682e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
24692e7328e7SRink Springerdevice		uslcom
247048b68edfSJosef Karthauser# USB Visor and Palm devices
247148b68edfSJosef Karthauserdevice		uvisor
2472d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2473d1233ab3SBruce Evansdevice		uvscom
2474f26c33d2SNick Hibma#
2475ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2476d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2477d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2478d04bb221SBill Paul# eval board.
2479c9953c3bSPeter Wemmdevice		aue
2480bf029145SRobert Watson
2481bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2482bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2483bf029145SRobert Watson
2484bf029145SRobert Watsondevice		axe
2485bf029145SRobert Watson
2486dfd1e98eSBill Paul#
24876bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
24886bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
24896bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
24906bcf0032SMaxim Sobolevdevice		cdce
24916bcf0032SMaxim Sobolev#
249201779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
249301779872SBill Paul# and Netmate II, and the Belkin F5U111.
2494c9953c3bSPeter Wemmdevice		cue
249501779872SBill Paul#
2496dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2497d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2498d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
249901779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
250001779872SBill Paul# and 2104USB, and the Corega USB-T.
2501c9953c3bSPeter Wemmdevice		kue
250211e04b05SShunsuke Akiyama#
250311e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
250411e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
250511e04b05SShunsuke Akiyamadevice		rue
2506cdd40f3bSMIHIRA Sanpei Yoshiro#
2507cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2508cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2509cdd40f3bSMIHIRA Sanpei Yoshiro
25108a4cd00aSWarner Losh#
25118a4cd00aSWarner Losh# ZyDas ZD1211/ZD1211B wireless ethernet driver
25128a4cd00aSWarner Loshdevice		zyd
25138a4cd00aSWarner Losh#
25148a4cd00aSWarner Losh# Ralink Technology RT2500USB chispet driver
25158a4cd00aSWarner Loshdevice		ural
25168a4cd00aSWarner Losh#
25178a4cd00aSWarner Losh# Ralink Technology RT2501USB/RT2601USB chispet driver
25188a4cd00aSWarner Loshdevice		rum
2519f26c33d2SNick Hibma
25208a4cd00aSWarner Losh#
2521f26c33d2SNick Hibma# debugging options for the USB subsystem
25221d33cf3dSNick Hibma#
25231d33cf3dSNick Hibmaoptions 	USB_DEBUG
2524f26c33d2SNick Hibma
25256e8394b8SKazutaka YOKOTA# options for ukbd:
25266e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2527cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
25286e8394b8SKazutaka YOKOTA
2529565f53bbSShunsuke Akiyama# options for uplcom:
25303c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2531565f53bbSShunsuke Akiyama						# in milliseconds
2532565f53bbSShunsuke Akiyama
253320280807SShunsuke Akiyama# options for uvscom:
253420280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
25353c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2536565f53bbSShunsuke Akiyama						# in milliseconds
253720280807SShunsuke Akiyama
25388b7ce2ffSSam Leffler#####################################################################
2539869093b1SHidetoshi Shimokawa# FireWire support
25407d2ba89bSJohn Baldwin
2541869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
25427d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
254379acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2544869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
25451c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2546869093b1SHidetoshi Shimokawa
2547869093b1SHidetoshi Shimokawa#####################################################################
2548869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2549869093b1SHidetoshi Shimokawa
2550869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2551869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2552869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2553869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2554869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2555869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
25567d2ba89bSJohn Baldwin
25577d2ba89bSJohn Baldwin#####################################################################
25588b7ce2ffSSam Leffler# crypto subsystem
25598b7ce2ffSSam Leffler#
25601c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2561b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
25621c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
25638b7ce2ffSSam Leffler#
25641c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
25651c9c6382SRuslan Ermilov# been fed back to OpenBSD.
25668b7ce2ffSSam Leffler
25678b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
25688b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
25698b7ce2ffSSam Leffler
2570ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
25718b7ce2ffSSam Leffler
2572b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2573b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2574b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2575b7c4858fSSam Leffler
2576b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2577b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2578b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2579b7c4858fSSam Leffler
25808b7ce2ffSSam Leffler#####################################################################
25818b7ce2ffSSam Leffler
25828b7ce2ffSSam Leffler
2583785d2100SJohn Birrell#
2584785d2100SJohn Birrell# Embedded system options:
2585785d2100SJohn Birrell#
2586785d2100SJohn Birrell# An embedded system might want to run something other than init.
258725388b6cSBruce Evansoptions 	INIT_PATH=/sbin/init:/stand/sysinstall
2588bc0e3a03SJeroen Ruigrok van der Werven
2589bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2590bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
25911c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2592395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2593bc0e3a03SJeroen Ruigrok van der Werven
2594e2c1a4e9SBenno Rice#
2595e2c1a4e9SBenno Rice# Verbose SYSINIT
2596e2c1a4e9SBenno Rice#
2597e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2598e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2599e2c1a4e9SBenno Rice# will print function names instead of addresses.
2600e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2601e2c1a4e9SBenno Rice
2602446af86dSJohn Baldwin#####################################################################
2603446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2604446af86dSJohn Baldwin#
2605446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2606446af86dSJohn Baldwinoptions 	SEMMAP=31
2607446af86dSJohn Baldwin
2608446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2609446af86dSJohn Baldwin# one time.
2610446af86dSJohn Baldwinoptions 	SEMMNI=11
2611446af86dSJohn Baldwin
2612446af86dSJohn Baldwin# Total number of semaphores system wide
2613446af86dSJohn Baldwinoptions 	SEMMNS=61
2614446af86dSJohn Baldwin
2615446af86dSJohn Baldwin# Total number of undo structures in system
2616446af86dSJohn Baldwinoptions 	SEMMNU=31
2617446af86dSJohn Baldwin
2618446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2619446af86dSJohn Baldwin# at one time.
2620446af86dSJohn Baldwinoptions 	SEMMSL=61
2621446af86dSJohn Baldwin
2622446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2623446af86dSJohn Baldwin# semaphore at one time.
2624446af86dSJohn Baldwinoptions 	SEMOPM=101
2625446af86dSJohn Baldwin
2626446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2627446af86dSJohn Baldwin# System V semaphore at one time.
2628446af86dSJohn Baldwinoptions 	SEMUME=11
2629446af86dSJohn Baldwin
2630446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2631446af86dSJohn Baldwinoptions 	SHMALL=1025
2632446af86dSJohn Baldwin
2633446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
263425388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2635446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2636446af86dSJohn Baldwin
2637446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2638446af86dSJohn Baldwinoptions 	SHMMIN=2
2639446af86dSJohn Baldwin
2640446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2641446af86dSJohn Baldwin# at one time.
2642446af86dSJohn Baldwinoptions 	SHMMNI=33
2643446af86dSJohn Baldwin
2644446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2645446af86dSJohn Baldwin# a single process at one time.
2646446af86dSJohn Baldwinoptions 	SHMSEG=9
2647446af86dSJohn Baldwin
2648d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2649d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2650d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2651d9282887SDima Dorfman# console.
2652d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2653d9282887SDima Dorfman
26545bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
26555bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
26565bbb8060STor Egge# file.  Both offset and length of the read operation must be
26575bbb8060STor Egge# multiples of the physical media sector size.
26585bbb8060STor Egge#
2659995356dcSDag-Erling Smørgravoptions 	DIRECTIO
26605bbb8060STor Egge
26615bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
26625bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
26635bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
26645bbb8060STor Egge#
2665995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
26665bbb8060STor Egge
2667446af86dSJohn Baldwin#####################################################################
2668446af86dSJohn Baldwin
2669bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2670bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2671bc0e3a03SJeroen Ruigrok van der Werven
2672bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
267328d7984fSJeroen Ruigrok van der Werven
267428d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2675bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
267628d7984fSJeroen Ruigrok van der Werven
2677bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
26788b6f5e65SJeroen Ruigrok van der Werven
267928d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2680bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
268128d7984fSJeroen Ruigrok van der Werven
26828b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
26838b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
26848b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
26858b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
26868b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
26878b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
26888b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
26898b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
26908b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
26918b6f5e65SJeroen Ruigrok van der Werven
26928b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
26938b6f5e65SJeroen Ruigrok van der Werven
2694bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2695bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2696bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2697bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
26988b6f5e65SJeroen Ruigrok van der Werven
26998b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
27008b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
27018b6f5e65SJeroen Ruigrok van der Werven
2702bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2703bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
27048b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
27058b6f5e65SJeroen Ruigrok van der Werven
2706316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2707316ec49aSScott Long
2708662d3818SScott Long# Adaptec Array Controller driver options
2709662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2710662d3818SScott Long				# 0 - quiet, only emit warnings
2711662d3818SScott Long				# 1 - noisy, emit major function
2712662d3818SScott Long				#     points and things done
2713662d3818SScott Long				# 2 - extremely noisy, emit trace
2714662d3818SScott Long				#     items in loops, etc.
2715662d3818SScott Long
27161e9ea774SBruce Evans# Yet more undocumented options for linting.
27171e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
27181e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
27191e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
272025388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
272125388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
27221e9ea774SBruce Evansoptions 	MAXFILES=999
2723