xref: /freebsd/sys/conf/NOTES (revision 91ed2fec199e662431538cc72d5b032c9f4f1a83)
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
5313c18821SJohn Baldwin# To statically compile in device wiring instead of /boot/device.hints
5413c18821SJohn Baldwin#hints		"LINT.hints"		# Default places to look for devices.
5513c18821SJohn Baldwin
5613c18821SJohn Baldwin# Use the following to compile in values accessible to the kernel
5713c18821SJohn Baldwin# through getenv() (or kenv(1) in userland). The format of the file
5813c18821SJohn Baldwin# is 'variable=value', see kenv(1)
5913c18821SJohn Baldwin#
6013c18821SJohn Baldwin#env		"LINT.env"
6113c18821SJohn Baldwin
626a8d6623SGarrett Wollman#
637bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
64503e6666SBruce Evans# generated Makefile in the build area.
65503e6666SBruce Evans#
66503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
67503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
681c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
69503e6666SBruce Evans#
70503e6666SBruce Evans# DEBUG happens to be magic.
717bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
727bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
737bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
747bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
757bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
767bf01a14SPeter Wemm#
772c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
782c8635c6SPeter Wemm# kernel.
792c8635c6SPeter Wemm#
800e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
810e3d06b1SWarner Losh#
82503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
835895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
842c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
85f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
86f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
87fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
88fa75a3c2SPoul-Henning Kamp
893236b30eSGreg Lehey#
90480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
91480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
92480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
93480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
94480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
95480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
96480c6b8aSGreg Lehey#
97480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
98480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
99480c6b8aSGreg Lehey#     further by changing the parameters:
1003236b30eSGreg Lehey#
101480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
102480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
103480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
104a59d364aSMatthew Dillon#
105480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
106480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
107480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
1083236b30eSGreg Lehey#
109480c6b8aSGreg Lehey
1103236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1113236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1123236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1133236b30eSGreg Lehey
1143236b30eSGreg Lehey#
115a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1163c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
117a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1188b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
119a59d364aSMatthew Dillon#
120a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
121a59d364aSMatthew Dillon
122f9fbd1a4SMatt Jacob#
123f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
124f9fbd1a4SMatt Jacob#
12550a8df3cSAlexander Motin# These are the maximal and safe 'raw' I/O block device access sizes.
12650a8df3cSAlexander Motin# Reads and writes will be split into MAXPHYS chunks for known good
12750a8df3cSAlexander Motin# devices and DFLTPHYS for the rest. Some applications have better
12850a8df3cSAlexander Motin# performance with larger raw I/O access sizes. Note that certain VM
129f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
130af52cb44SSergey Kandaurov# can make an unbootable kernel.
131f9fbd1a4SMatt Jacob#
132f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
133f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
134f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
135f9fbd1a4SMatt Jacob
136f9fbd1a4SMatt Jacob
137827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
138272afb65SWojciech A. Koszek# the kernel binary itself. See config(8) for more details.
139827d623eSJordan K. Hubbard#
140827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
141827d623eSJordan K. Hubbard
14256fddc5dSBrooks Davis#
14356fddc5dSBrooks Davis# Compile-time defaults for various boot parameters
14456fddc5dSBrooks Davis#
14556fddc5dSBrooks Davisoptions 	BOOTVERBOSE=1
14656fddc5dSBrooks Davisoptions 	BOOTHOWTO=RB_MULTIPLE
14756fddc5dSBrooks Davis
148069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
149069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
150069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1515d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1527226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1535ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
15422db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1557226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
156f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
157e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1581669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
159069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1608a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
161e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1627dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1631d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1645aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
165d68d0cf5SAndrey V. Elsukovoptions 	GEOM_PART_BSD64		# BSD disklabel64
16691e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1676ad9a99fSMarcel Moolenaaroptions 	GEOM_PART_EBR_COMPAT	# Backward compatible partition names
1681d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
169e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1706bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
171b03fab12SMarcel Moolenaaroptions 	GEOM_PART_PC98		# PC-9800 disk partitioning
17210020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
173069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
17489b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
175e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
176560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1777dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
178069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
17975261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
18002e17f0bSMarius Strobloptions 	GEOM_VINUM		# Vinum logical volume manager
181f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
182069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1831c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1847b03a440SPoul-Henning Kamp
1858b140d57SMike Smith#
1868b140d57SMike Smith# The root device and filesystem type can be compiled in;
1878b140d57SMike Smith# this provides a fallback option if the root device cannot
1883b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1898b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1908b140d57SMike Smith#
1918b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1928b140d57SMike Smith
1936a8d6623SGarrett Wollman
1946a8d6623SGarrett Wollman#####################################################################
195f5d05ac3SJeff Roberson# Scheduler options:
196f5d05ac3SJeff Roberson#
197a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
198f5d05ac3SJeff Roberson# select which scheduler is compiled in.
199f5d05ac3SJeff Roberson#
200f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
2011c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
202f5d05ac3SJeff Roberson# good interactivity and priority selection.
203f5d05ac3SJeff Roberson#
204bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
205bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
206bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
207bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2089c0ef6d5SOliver Fromme# is the default scheduler.
209f5d05ac3SJeff Roberson#
21075a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
21175a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
21275a66a92SJeff Roberson#
213b998bd92SJeff Robersonoptions 	SCHED_4BSD
21475a66a92SJeff Robersonoptions 	SCHED_STATS
215b998bd92SJeff Roberson#options 	SCHED_ULE
216f5d05ac3SJeff Roberson
217f5d05ac3SJeff Roberson#####################################################################
218477a642cSPeter Wemm# SMP OPTIONS:
219477a642cSPeter Wemm#
220477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
221477a642cSPeter Wemm
222477a642cSPeter Wemm# Mandatory:
223477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
224477a642cSPeter Wemm
22568b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
22668b739cdSAttilio Rao# A default value should be already present, for every architecture.
22768b739cdSAttilio Raooptions 	MAXCPU=32
22868b739cdSAttilio Rao
229941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
230941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
231941646f5SAttilio Raooptions 	MAXMEMDOM=1
232941646f5SAttilio Rao
2332498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2342498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
235d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
236701f1408SScott Long# to disable it.
237701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2382498cf8cSJohn Baldwin
239cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
240cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
241d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
242cd6e6e4eSJohn Baldwin# to disable it.
243cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
244cd6e6e4eSJohn Baldwin
2451ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2461ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
247d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2481ae1c2a3SAttilio Rao# disable it.
2491ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2504e7f640dSJohn Baldwin
251ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
252ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
253ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
254cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
255ad27c4c7SJohn Baldwin# and WITNESS options.
256ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
257ad27c4c7SJohn Baldwin
2581a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2591a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2601a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
261cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2621a5d9b15SJohn Baldwin# and WITNESS options.
2631a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2641a5d9b15SJohn Baldwin
2654e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2664e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2674e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2684e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2694e7f640dSJohn Baldwin# and WITNESS options.
2704e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2714e7f640dSJohn Baldwin
2721fe4c660SJohn Baldwin# SMP Debugging Options:
2731fe4c660SJohn Baldwin#
2745b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2755b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2765e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2775e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2785e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
27967ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2800c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2818c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2820c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2830c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2840c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2859923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
286ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
287ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
28875a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
28975a66a92SJeff Roberson#	  frequency.
290ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
291ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
292c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
293c6111de5SDavide Italiano	  to hold active lock queues.
294aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2951fe4c660SJohn Baldwin#         during locking operations.
296e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2973c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
298660d1e3aSJohn Baldwin#	  sleep.
299660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
3009923b511SScott Longoptions 	PREEMPTION
3010c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
302ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
3031fe4c660SJohn Baldwinoptions 	WITNESS
304e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
305660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3061fe4c660SJohn Baldwin
307cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
30807dba937SKip Macyoptions 	LOCK_PROFILING
30900096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
31000096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
31100096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
31200096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3134db0d7f1SDag-Erling Smørgrav
3145b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3155b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3165b999a6bSDavide Italiano
317ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
318ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
319ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
320c6111de5SDavide Italianooptions 	UMTX_PROFILING
321331805a5SDavide Italiano
322ef0ebfc3SJohn Baldwin
323477a642cSPeter Wemm#####################################################################
3246a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
325690f540cSAndrey A. Chernov
3266a8d6623SGarrett Wollman#
3276a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
32856c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3297bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3307bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3317bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3327bbf05a2SJuli Mallett# signal delivery mechanism.
3336a8d6623SGarrett Wollman#
3345895e3c8SPeter Wemmoptions 	COMPAT_43
3356a8d6623SGarrett Wollman
336d3e64681SPoul-Henning Kamp# Old tty interface.
337d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
338d3e64681SPoul-Henning Kamp
339f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
340f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
341f5e4c105SJohn Baldwin
342f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
343f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
344f0eb293eSAlfred Perlstein
345a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
346a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
347a01b4125SKen Smith
3486c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3496c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3506c9fdda7SRuslan Ermilov
3515965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3525965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3535965c4b7SJohn Baldwin
3546a8d6623SGarrett Wollman#
3556a8d6623SGarrett Wollman# These three options provide support for System V Interface
3566a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3576a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3586a8d6623SGarrett Wollman#
3596a8d6623SGarrett Wollmanoptions 	SYSVSHM
3606a8d6623SGarrett Wollmanoptions 	SYSVSEM
3616a8d6623SGarrett Wollmanoptions 	SYSVMSG
3626a8d6623SGarrett Wollman
3636a8d6623SGarrett Wollman
3646a8d6623SGarrett Wollman#####################################################################
3656a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3666a8d6623SGarrett Wollman
3676a8d6623SGarrett Wollman#
368e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3696a8d6623SGarrett Wollman#
370e2ee2173SMarcel Moolenaaroptions 	KDB
371b5d89ca8SBruce Evans
372b5d89ca8SBruce Evans#
373e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3747085e708SBruce Evans#
375e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
376e2ee2173SMarcel Moolenaar
377e2ee2173SMarcel Moolenaar#
378e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
379e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
380e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
381e2ee2173SMarcel Moolenaar#
382e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
383e2ee2173SMarcel Moolenaar
384e2ee2173SMarcel Moolenaar#
385e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
386e2ee2173SMarcel Moolenaar#
387e2ee2173SMarcel Moolenaaroptions 	DDB
3887085e708SBruce Evans
3897085e708SBruce Evans#
390bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
391bfdd261eSBruce Evans# representation.
392bfdd261eSBruce Evans#
393bfdd261eSBruce Evansoptions 	DDB_NUMSYM
394bfdd261eSBruce Evans
395bfdd261eSBruce Evans#
396e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
3970be15decSJohn Baldwin#
398e2ee2173SMarcel Moolenaaroptions 	GDB
399562d05dfSPaul Traina
400562d05dfSPaul Traina#
401df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
402df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4031c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
404df970488SRobert Watson# interfere with serial console operation.
405df970488SRobert Watson#
406df970488SRobert Watsonoptions 	SYSCTL_DEBUG
407df970488SRobert Watson
408df970488SRobert Watson#
40921d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
41021d748a9SAlfred Perlstein#
41121d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
41221d748a9SAlfred Perlstein
41321d748a9SAlfred Perlstein#
41421d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
41521d748a9SAlfred Perlstein#
41621d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
41721d748a9SAlfred Perlstein
41821d748a9SAlfred Perlstein#
41931615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
42031615ef7SRebecca Cran# resulting kernel.
42131615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
42231615ef7SRebecca Cran
42331615ef7SRebecca Cran#
424d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
425d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
426d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
427d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
428d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
429d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
430d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
431d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
432d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
433d7854da1SMatthew D Fleming# code.
434d7854da1SMatthew D Fleming#
435d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
436d7854da1SMatthew D Fleming
437d7854da1SMatthew D Fleming#
438e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
439e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
440e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
441e4eb384bSBosko Milekic#
442e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
443e4eb384bSBosko Milekic
444e4eb384bSBosko Milekic#
445847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
446847a2a17SPawel Jakub Dawidek# malloc(9).
447847a2a17SPawel Jakub Dawidek#
448847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
449847a2a17SPawel Jakub Dawidek
450847a2a17SPawel Jakub Dawidek#
451e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
452e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
453e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
454e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
455e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
456e79f350dSWarner Losh#
457e79f350dSWarner Losh#options	EARLY_PRINTF
458e79f350dSWarner Losh
459e79f350dSWarner Losh#
460ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
461ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
462ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
463ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
464ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
465ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
466ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4676a8d6623SGarrett Wollman#
4682365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
469ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
47021c64a07SAndrey A. Chernov
4716a8d6623SGarrett Wollman#
472f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
473a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
4746e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
47536b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
47636b7dde4SAndriy Gapon# before malloc(9) is functional.
477a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
478a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
479a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
480a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
481e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
482d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
483d4a2ab8cSAttilio Rao# separated by the "," character (ie:
484d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
485a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
486a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
487f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
488c508c1b6SJohn Baldwin#
489c508c1b6SJohn Baldwinoptions 	KTR
49036b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
49136b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
49225388b6cSBruce Evansoptions 	KTR_COMPILE=(KTR_INTR|KTR_PROC)
493a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
494d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
495d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
496c508c1b6SJohn Baldwin
497c508c1b6SJohn Baldwin#
4981c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
499f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
500453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
501453ffeefSRobert Watson# in a worker thread.
502453ffeefSRobert Watson#
503453ffeefSRobert Watsonoptions 	ALQ
504453ffeefSRobert Watsonoptions 	KTR_ALQ
505453ffeefSRobert Watson
506453ffeefSRobert Watson#
5075526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5086a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5096a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5106a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5116a8d6623SGarrett Wollman# programming errors.
5126a8d6623SGarrett Wollman#
5135526d2d9SEivind Eklundoptions 	INVARIANTS
5145526d2d9SEivind Eklund
5155526d2d9SEivind Eklund#
51634b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
51734b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
51834b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
51934b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
52034b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
52134b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
52234b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
52334b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
52434b15f2aSJohn Baldwin# infrastructure without the added overhead.
52534b15f2aSJohn Baldwin#
52634b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
52734b15f2aSJohn Baldwin
52834b15f2aSJohn Baldwin#
5295526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
5305526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
5315526d2d9SEivind Eklund# it is disabled by default.
5325526d2d9SEivind Eklund#
5330dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
534da59a31cSDavid Greenman
5350dd1eea1SJordan K. Hubbard#
5360b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5373c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5380b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5390b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5400b5438c6SRobert Watson# impossible) scenarios.
5410b5438c6SRobert Watson#
5420b5438c6SRobert Watsonoptions 	REGRESSION
5430b5438c6SRobert Watson
5440b5438c6SRobert Watson#
5459c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
546346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
547346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
548346ebe51SEivind Eklund# from.)
549346ebe51SEivind Eklund#
550346ebe51SEivind Eklundoptions 	COMPILING_LINT
551346ebe51SEivind Eklund
5523c90d1eaSRobert Watson#
5533c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5543c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5553c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5563c90d1eaSRobert Watson#
5573c90d1eaSRobert Watsonoptions 	STACK
5583c90d1eaSRobert Watson
5596a8d6623SGarrett Wollman
5606a8d6623SGarrett Wollman#####################################################################
561d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
562d47cce3eSMarcel Moolenaar
563d47cce3eSMarcel Moolenaar#
564d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5659c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
566d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
567d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
568d47cce3eSMarcel Moolenaar#
569ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
570ad3869b4SJoseph Koshy# please see hwpmc(4).
571ad3869b4SJoseph Koshy
572d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
573d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
574d47cce3eSMarcel Moolenaar
575d47cce3eSMarcel Moolenaar
576d47cce3eSMarcel Moolenaar#####################################################################
5776a8d6623SGarrett Wollman# NETWORKING OPTIONS
57870c0b54cSAndrey A. Chernov
5796a8d6623SGarrett Wollman#
580a22fb0daSGeorge V. Neville-Neil# Protocol families
5816a8d6623SGarrett Wollman#
5826a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
58351f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
584a22fb0daSGeorge V. Neville-Neil
5854871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
5864871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
5878b07e49aSJulian Elischer
58809fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
58909fe6320SNavdeep Parhar
590a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
591a22fb0daSGeorge V. Neville-Neil# your kernel configuration
592a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
5932cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
59414dd6717SSam Leffler#
595db2e4792SBjoern A. Zeeb# #DEPRECATED#
596db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
597db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
598db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
59914dd6717SSam Leffler# they are assumed trusted.
60014dd6717SSam Leffler#
601fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
602fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
60314dd6717SSam Leffler#
604cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
6057b495c44SVANHULLEBUS Yvan#
6067b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
6077b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
6087b495c44SVANHULLEBUS Yvan#
6097b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
610f73bbaf2SDavid Greenman
611237abf0cSDavide Italiano#
612237abf0cSDavide Italiano# SMB/CIFS requester
613237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
614237abf0cSDavide Italiano# options.
615237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
616237abf0cSDavide Italiano
617d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
618d8589bd5SBoris Popovoptions 	LIBMCHAIN
619d8589bd5SBoris Popov
6206cd047a0SGleb Smirnoff# libalias library, performing NAT
6216cd047a0SGleb Smirnoffoptions 	LIBALIAS
6226cd047a0SGleb Smirnoff
62334b07340SKip Macy# flowtable cache
62434b07340SKip Macyoptions 	FLOWTABLE
62534b07340SKip Macy
626f8829a4aSRandall Stewart#
627f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
628f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
629f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
630f8829a4aSRandall Stewart# extensions. This release supports all the extensions
631f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6329c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
633f8829a4aSRandall Stewart# and is quite well tested.
634f8829a4aSRandall Stewart#
635f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6369c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6379c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
638f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
639f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
640f8829a4aSRandall Stewart#
641f8829a4aSRandall Stewartoptions 	SCTP
642f8829a4aSRandall Stewart# There are bunches of options:
643f8829a4aSRandall Stewart# this one turns on all sorts of
644d51e8487SJosh Paetzel# nastily printing that you can
6459c0ef6d5SOliver Fromme# do. It's all controlled by a
646f8829a4aSRandall Stewart# bit mask (settable by socket opt and
647f8829a4aSRandall Stewart# by sysctl). Including will not cause
648f8829a4aSRandall Stewart# logging until you set the bits.. but it
649f8829a4aSRandall Stewart# can be quite verbose.. so without this
650f8829a4aSRandall Stewart# option we don't do any of the tests for
651f8829a4aSRandall Stewart# bits and prints.. which makes the code run
652f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
653f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
654f8829a4aSRandall Stewart#
6559c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6569c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6579c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
658f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
659f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
660f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
661f8829a4aSRandall Stewart# like with such an offload (which only exists in
662f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
663f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
664f8829a4aSRandall Stewart# to be.. but it does speed things up try only
665f8829a4aSRandall Stewart# for in a captured lab environment :-)
666f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
667f8829a4aSRandall Stewart#
668cb7a4976SRandall Stewart
669f8829a4aSRandall Stewart#
670f8829a4aSRandall Stewart# All that options after that turn on specific types of
671f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
672f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
673f8829a4aSRandall Stewart# see. I have used this to produce interesting
674f8829a4aSRandall Stewart# charts and graphs as well :->
675f8829a4aSRandall Stewart#
6769c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
677f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
678f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
679f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
680cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
681f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
6829c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
683cb7a4976SRandall Stewart# things too.
684f8829a4aSRandall Stewart#
685f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
686f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
687cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
688cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
689cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
690cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
691cb7a4976SRandall Stewart
692f8829a4aSRandall Stewart
69302b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
69402b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
695cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
696cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
697cceffdeeSAndrew Thompson# option.
69802b199f1SMax Laieroptions 	ALTQ
699755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
700c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
70102b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
70202b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
70302b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7043c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
705cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
70602b199f1SMax Laieroptions 	ALTQ_DEBUG
70702b199f1SMax Laier
7084cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7094cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7104cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7114cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
71292a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
71392a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7144cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
71573e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
71673e87266SGleb Smirnoff					# affects netgraph(4) and nodes
71773e87266SGleb Smirnoff# Node types
7184cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
719bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
720b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
721b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
722b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
723b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
724b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
725b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
726b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
727b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
72892a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
729901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7307d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
7314cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7329e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
73331578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7344cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7359d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
73646aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
7374cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
73837379158SBrooks Davisoptions 	NETGRAPH_GIF
73937379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7404cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7414cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
74237379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
743f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
74448e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
745901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7464cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
747a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
748a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
749a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
750cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7516cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7527d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
753d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
754991633afSMarko Zecoptions 	NETGRAPH_PIPE
755b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
756b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
757add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7589e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7594cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
760b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7614d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7620a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
763d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
764e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7654cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7664cf49a43SJulian Elischeroptions 	NETGRAPH_UI
767b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
768b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
769666ea1b6SMaksim Yevmenkin
77002152e8fSHartmut Brandt# NgATM - Netgraph ATM
77102152e8fSHartmut Brandtoptions 	NGATM_ATM
772027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
773027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
774027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
775ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
776a7e22394SHartmut Brandtoptions 	NGATM_CCATM
77702152e8fSHartmut Brandt
778c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7793cf4d0bfSPoul-Henning Kamp
7800990ef0aSKevin Lo# Network stack virtualization.
781287cd4a2SKevin Lo#options	VIMAGE
782287cd4a2SKevin Lo#options	VNET_DEBUG	# debug for VIMAGE
7830990ef0aSKevin Lo
7846a8d6623SGarrett Wollman#
7856a8d6623SGarrett Wollman# Network interfaces:
786f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
78736782d14SWojciech A. Koszekdevice		loop
78836782d14SWojciech A. Koszek
789f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7909d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
791722012ccSJulian Elischer#  configured or token-ring is enabled.
79236782d14SWojciech A. Koszekdevice		ether
79336782d14SWojciech A. Koszek
794fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
7959d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
79636782d14SWojciech A. Koszekdevice		vlan
79736782d14SWojciech A. Koszek
79857a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
79967e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
800f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
80136782d14SWojciech A. Koszekdevice		wlan
80236782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
80336782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
80459aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
80559aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
80636782d14SWojciech A. Koszek
80767e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
80867e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
80967e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
81036782d14SWojciech A. Koszekdevice		wlan_wep
81136782d14SWojciech A. Koszekdevice		wlan_ccmp
81236782d14SWojciech A. Koszekdevice		wlan_tkip
81336782d14SWojciech A. Koszek
81467e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
81567e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
81634341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
81736782d14SWojciech A. Koszekdevice		wlan_xauth
81836782d14SWojciech A. Koszek
81967e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
82067e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
82167e4db77SSam Leffler#  `wlan' module.
82236782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
82336782d14SWojciech A. Koszekdevice		wlan_acl
82436782d14SWojciech A. Koszekdevice		wlan_amrr
82536782d14SWojciech A. Koszek
82636782d14SWojciech A. Koszek# Generic TokenRing
82736782d14SWojciech A. Koszekdevice		token
82836782d14SWojciech A. Koszek
8291a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
83036782d14SWojciech A. Koszekdevice		fddi
83136782d14SWojciech A. Koszek
832eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
83336782d14SWojciech A. Koszekdevice		arcnet
83436782d14SWojciech A. Koszek
835f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
836e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
83736782d14SWojciech A. Koszekdevice		sppp
83836782d14SWojciech A. Koszek
839f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
840d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8419c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
84236782d14SWojciech A. Koszekdevice		bpf
84336782d14SWojciech A. Koszek
844e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
845e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
846e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
847e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
848e4b68814SLuigi Rizzodevice		netmap
849e4b68814SLuigi Rizzo
850f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
85159d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
85270e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
85336782d14SWojciech A. Koszekdevice		disc
85436782d14SWojciech A. Koszek
855d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
856d0ea4743SBjoern A. Zeeb# like interface pair.
857d0ea4743SBjoern A. Zeebdevice		epair
858d0ea4743SBjoern A. Zeeb
85963518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
86063518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
86136782d14SWojciech A. Koszekdevice		edsc
86236782d14SWojciech A. Koszek
8634c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
86436782d14SWojciech A. Koszekdevice		tap
86536782d14SWojciech A. Koszek
86636782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
86736782d14SWojciech A. Koszekdevice		tun
86836782d14SWojciech A. Koszek
869f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
870cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
871cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
872f367e2f2SMaxim Sobolev#  The `gre' device implements two types of IP4 over IP4 tunneling:
873f367e2f2SMaxim Sobolev#  GRE and MOBILE, as specified in the RFC1701 and RFC2004.
874f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
875f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
87636782d14SWojciech A. Koszekdevice		gif
87736782d14SWojciech A. Koszekdevice		gre
87836782d14SWojciech A. Koszekoptions 	XBONEHACK
87936782d14SWojciech A. Koszek
880f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
881cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
882d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
88336782d14SWojciech A. Koszekdevice		faith
88436782d14SWojciech A. Koszekdevice		stf
88536782d14SWojciech A. Koszek
8868d69c48bSMax Laier# The pf packet filter consists of three devices:
8878d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
8888d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
8898d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
8908d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
89136782d14SWojciech A. Koszekdevice		pf
89236782d14SWojciech A. Koszekdevice		pflog
89336782d14SWojciech A. Koszekdevice		pfsync
89436782d14SWojciech A. Koszek
89536782d14SWojciech A. Koszek# Bridge interface.
89636782d14SWojciech A. Koszekdevice		if_bridge
89736782d14SWojciech A. Koszek
89836782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
89936782d14SWojciech A. Koszekdevice		carp
90036782d14SWojciech A. Koszek
90136782d14SWojciech A. Koszek# IPsec interface.
90236782d14SWojciech A. Koszekdevice		enc
90336782d14SWojciech A. Koszek
90436782d14SWojciech A. Koszek# Link aggregation interface.
90536782d14SWojciech A. Koszekdevice		lagg
90636782d14SWojciech A. Koszek
9078d69c48bSMax Laier#
9086a8d6623SGarrett Wollman# Internet family options:
9096a8d6623SGarrett Wollman#
9106a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9110948f0a2SBruce M Simpson# with mrouted and XORP.
912e0f688baSJeffrey Hsu#
913d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
914ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
915ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
916ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
917ab6e02daSJordan K. Hubbard#
918ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
919ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
920a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
921ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
922ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
923ab6e02daSJordan K. Hubbard# feature works properly.
9248dd4744eSJordan K. Hubbard#
925ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
926ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
927ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
928ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
929ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
930ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
931ffdd472dSPeter Wemm# out of sync.
932d29895dcSGarrett Wollman#
93384bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
93484bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
93593e0e116SJulian Elischer#
93661c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
937531c890bSPaolo Pisati# LIBALIAS.
93861c0e134SPaolo Pisati#
9391b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9401c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9411b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9421b968362SDag-Erling Smørgrav#
9437f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9447f7ef494SGleb Smirnoff#
9455e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9465e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9475e331acdSGarrett Wollman# using the trpt(8) utility.
94865e8111fSBruce Evans#
94965e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9509731596aSGleb Smirnoff#
951e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
952d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9534479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9545895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
955e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
95661c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
95793e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9589cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9599cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9600c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9618259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9621b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
9637f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
96465e8111fSBruce Evansoptions 	TCPDEBUG
9659731596aSGleb Smirnoffoptions 	RADIX_MPATH
9666a8d6623SGarrett Wollman
96753dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
96853dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
969f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9704e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9716eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9726eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9736eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
97453dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9756eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9764a5ccac7SMike Silbersack
9779c0ef6d5SOliver Fromme# Statically link in accept filters
978a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
979744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
980a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
981a79b7128SAlfred Perlstein
982b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
983b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
984b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
985b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
986b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
987b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
9885164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
989b52f8407SBruce M Simpson
990f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
991f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
992358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
993358f8d82SRobert Watson# a smooth scheduling of the traffic.
99468ec4eb6SLuigi Rizzooptions 	DUMMYNET
99568e9d934SLuigi Rizzo
9966a8d6623SGarrett Wollman#####################################################################
9976a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
998e3178a06SJordan K. Hubbard
9992365e64fSRodney W. Grimes#
10003f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10013f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10023f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10033f850e6aSKonstantin Belousov# filesystems as well.
10046a8d6623SGarrett Wollman#
100555793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1006534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1007534046e3SRong-En Fan# resolved.
10082365e64fSRodney W. Grimes#
1009f1a9c715SDavid Greenman
10106a8d6623SGarrett Wollman# One of these is mandatory:
10116a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1012dd1c7d13SBruce Evansoptions 	NFSCLIENT		#Network File System client
10136a8d6623SGarrett Wollman
10146a8d6623SGarrett Wollman# The rest are optional:
10155895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
101699d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
10175fe58019SAttilio Raooptions 	FUSE			#FUSE support module
1018dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1019dd1c7d13SBruce Evansoptions 	NFSSERVER		#Network File System server
1020dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10214133ee1eSKevin Looptions 	NFSCL			#New Network Filesystem Client
10224133ee1eSKevin Looptions 	NFSD			#New Network Filesystem Server
10239c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10241bea7c61SMaxim Sobolev
1025f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10264d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
102752ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1028bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1029237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
103078920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1031df263cbdSScott Longoptions 	UDF			#Universal Disk Format
103299d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1033bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1034bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1035f1a9c715SDavid Greenman
1036d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1037d61e6649SAlexander Langer# making abrupt shutdown less risky.
1038f8f8d7afSEivind Eklund#
10393d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1040b1897c19SJulian Elischer
1041a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
104251be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
104351be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
104449993db0SRobert Watsonoptions 	UFS_EXTATTR
104549993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1046a64ed089SRobert Watson
104751be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
104851be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
104951be6918SChris D. Faulhaber# for the underlying filesystem.
105051be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
105151be6918SChris D. Faulhaberoptions 	UFS_ACL
105251be6918SChris D. Faulhaber
10539b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10549b5ad47fSIan Dowse# directories at the expense of some memory.
10559b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10569b5ad47fSIan Dowse
1057f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1058f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1059f348204cSPawel Jakub Dawidek
106071e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
106171e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
106271e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
106371e4fff8SPoul-Henning Kamp
106471e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
106571e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
106671e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1067d52d7365SPoul-Henning Kamp
1068495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10692365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10706a8d6623SGarrett Wollman
1071276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
107245c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1073276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1074276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1075ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10766110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1077276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1078276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
10799c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1080276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1081276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1082276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1083cb800e34SJulian Elischer#
1084cb800e34SJulian Elischeroptions 	SUIDDIR
1085cb800e34SJulian Elischer
1086df394affSJohn-Mark Gurney# NFS options:
10875895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
10885895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
10895895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
10905895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
10915895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
10925895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
1093df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1094df394affSJohn-Mark Gurney
1095053a2b61SEivind Eklund#
1096053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1097053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1098053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1099053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1100053a2b61SEivind Eklund#
11015895e3c8SPeter Wemmoptions 	EXT2FS
1102053a2b61SEivind Eklund
1103fe98fb32SJean-Sébastien Pédron#
1104fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1105fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1106fe98fb32SJean-Sébastien Pédron#
1107fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1108fe98fb32SJean-Sébastien Pédron
1109dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
11100cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
11110cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1112dd85920aSJason Evansoptions 	VFS_AIO
1113053a2b61SEivind Eklund
11148ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1115ac519db0SMark Murraydevice		random
111615bbdecfSMark Murray
11178ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1118e83e229dSWarner Loshdevice		mem
11198ab2f5ecSMark Murray
112000a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
112100a5db46SStacey Sondevice		ksyms
112200a5db46SStacey Son
1123c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1124c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1125c4f02a89SMax Khonoptions 	CD9660_ICONV
1126c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1127126f0dfaSScott Longoptions 	UDF_ICONV
1128c4f02a89SMax Khon
11296a8d6623SGarrett Wollman
11306a8d6623SGarrett Wollman#####################################################################
1131abc97a06SBruce Evans# POSIX P1003.1B
1132abc97a06SBruce Evans
11331c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1134abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1135abc97a06SBruce Evans
11365895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11378cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11388cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11393ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1140abc97a06SBruce Evans
11415b40ce27SDavid Xu# POSIX message queue
11425b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1143abc97a06SBruce Evans
1144abc97a06SBruce Evans#####################################################################
114512e9f256SRobert Watson# SECURITY POLICY PARAMETERS
114612e9f256SRobert Watson
1147fdcba197SRobert Watson# Support for BSM audit
1148fdcba197SRobert Watsonoptions 	AUDIT
1149fdcba197SRobert Watson
1150cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1151cd6d1d76SBruce Evansoptions 	MAC
1152eae2f20cSRobert Watsonoptions 	MAC_BIBA
1153eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1154eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1155c4725737SRobert Watsonoptions 	MAC_LOMAC
1156eae2f20cSRobert Watsonoptions 	MAC_MLS
1157eae2f20cSRobert Watsonoptions 	MAC_NONE
1158eae2f20cSRobert Watsonoptions 	MAC_PARTITION
115903d03162SRobert Watsonoptions 	MAC_PORTACL
1160eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1161782f7255SRobert Watsonoptions 	MAC_STUB
1162eae2f20cSRobert Watsonoptions 	MAC_TEST
116312e9f256SRobert Watson
116496fcc75fSRobert Watson# Support for Capsicum
116555d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
116655d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
116796fcc75fSRobert Watson
116812e9f256SRobert Watson
116912e9f256SRobert Watson#####################################################################
1170000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1171000033d0SJeroen Ruigrok van der Werven
1172000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1173358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1174358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1175358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1176358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1177358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1178358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1179358f8d82SRobert Watson# actually reducing the accuracy of operation.
1180000033d0SJeroen Ruigrok van der Werven
1181000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1182000033d0SJeroen Ruigrok van der Werven
1183f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1184f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1185f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1186f309f881SJohn Baldwin
1187f309f881SJohn Baldwinoptions 	PPS_SYNC
1188f309f881SJohn Baldwin
1189b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1190b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1191b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1192b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1193b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1194b0fdc837SLawrence Stewart
1195b0fdc837SLawrence Stewartoptions 	FFCLOCK
1196b0fdc837SLawrence Stewart
1197000033d0SJeroen Ruigrok van der Werven
1198000033d0SJeroen Ruigrok van der Werven#####################################################################
1199de6a307eSPeter Dufault# SCSI DEVICES
1200de6a307eSPeter Dufault
12016a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12026a8d6623SGarrett Wollman
12036a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1204ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12056a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12066a8d6623SGarrett Wollman# device configuration sections below.
12076a8d6623SGarrett Wollman#
1208e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1209e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1210e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1211e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1212e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1213e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1214e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1215e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1216e14eb5a1SGarrett Wollman# problem.)
1217ebc1a0e2SPeter Dufault
1218ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1219ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1220700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1221700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1222ebc1a0e2SPeter Dufault
1223ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1224ebc1a0e2SPeter Dufault
1225f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1226f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1227f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1228f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1229f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1230f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1231f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1232f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1233f71c01ccSPeter Wemmhint.da.0.target="0"
1234f71c01ccSPeter Wemmhint.da.0.unit="0"
1235f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1236f71c01ccSPeter Wemmhint.da.1.target="1"
1237f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1238f71c01ccSPeter Wemmhint.da.2.target="3"
1239f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1240f71c01ccSPeter Wemmhint.sa.1.target="6"
1241ebc1a0e2SPeter Dufault
1242ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1243ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1244ebc1a0e2SPeter Dufault
1245ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1246ebc1a0e2SPeter Dufault
1247cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1248cf2458c9SMatt Jacob#
1249cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1250cf2458c9SMatt Jacob# ("WORM") devices.
1251cf2458c9SMatt Jacob#
1252cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1253cf2458c9SMatt Jacob#
1254cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1255cf2458c9SMatt Jacob#
12563c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12573c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1258cf2458c9SMatt Jacob#
1259cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1260cf2458c9SMatt Jacob#
12611eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12621eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12631eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1264d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1265cf2458c9SMatt Jacob#
1266cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1267cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1268cf2458c9SMatt Jacob#
1269cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1270cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1271cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1272cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1273cf2458c9SMatt Jacob#
1274cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1275cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1276cf2458c9SMatt Jacob# to them.
1277cf2458c9SMatt Jacob#
1278b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1279ebc1a0e2SPeter Dufault
1280c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1281c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1282c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1283c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1284c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1285dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1286cf2458c9SMatt Jacobdevice		pt		#SCSI processor
128764ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
128864ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1289cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
12901eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1291130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
12928909a72bSPeter Dufault
1293700daf5eSJustin T. Gibbs# CAM OPTIONS:
1294700daf5eSJustin T. Gibbs# debugging options:
1295f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1296f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1297f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1298f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1299f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1300f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1301f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1302700daf5eSJustin T. Gibbs#
1303700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1304700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1305700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
130656234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
130756234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13083a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13093a937198SBrooks Davis#             can be changed at boot and runtime with the
13103a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1311700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1312f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1313f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13145895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13155895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13165895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1317f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13185895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1319700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1320700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
132132672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
13221a7c583cSGarrett Wollman
1323700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1324700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1325700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1326700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1327700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1328700daf5eSJustin T. Gibbs# respectively.
132993063432SJoerg Wunsch#
1330700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1331700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1332700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
133393063432SJoerg Wunsch#
13345895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13355895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
133693063432SJoerg Wunsch
13379dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1338b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13399dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13409dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13419dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13429f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
134325388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
134425388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
134525388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
134625388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13479f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13489dfb4471SKenneth D. Merry
13493ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13503ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
135125388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13523ece1bd2SKenneth D. Merry
13538904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13548904e70bSMatt Jacob#
13558904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13568904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13579c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13588904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13598904e70bSMatt Jacob
13606a8d6623SGarrett Wollman
13616a8d6623SGarrett Wollman#####################################################################
13626a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13636a8d6623SGarrett Wollman
1364bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13656d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1366f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1367932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1368efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13696aec1278SMax Laierdevice		firmware	#firmware(9) support
1370be174c7eSGreg Lehey
13716f2d8adbSBoris Popov# Kernel side iconv library
13726f2d8adbSBoris Popovoptions 	LIBICONV
13736f2d8adbSBoris Popov
137458067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13755895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
137658067a99SPoul-Henning Kamp
13776a8d6623SGarrett Wollman
13786a8d6623SGarrett Wollman#####################################################################
1379d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1380d61e6649SAlexander Langer
1381d61e6649SAlexander Langer# For ISA the required hints are listed.
13825bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13835bcb64f2SWarner Losh# no hints are needed.
1384d61e6649SAlexander Langer
1385d61e6649SAlexander Langer#
1386d61e6649SAlexander Langer# Mandatory devices:
1387d61e6649SAlexander Langer#
1388d61e6649SAlexander Langer
13896e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
13906e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
13916e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
13926e818956SDavid E. O'Brien
13937f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
13947f5092f3SJohn Baldwin
1395837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1396837f167eSRuslan Ermilov
1397905e8b43SDag-Erling Smørgrav# Various screen savers.
1398905e8b43SDag-Erling Smørgravdevice		blank_saver
1399905e8b43SDag-Erling Smørgravdevice		daemon_saver
1400905e8b43SDag-Erling Smørgravdevice		dragon_saver
1401905e8b43SDag-Erling Smørgravdevice		fade_saver
1402905e8b43SDag-Erling Smørgravdevice		fire_saver
1403905e8b43SDag-Erling Smørgravdevice		green_saver
1404905e8b43SDag-Erling Smørgravdevice		logo_saver
1405905e8b43SDag-Erling Smørgravdevice		rain_saver
1406905e8b43SDag-Erling Smørgravdevice		snake_saver
1407905e8b43SDag-Erling Smørgravdevice		star_saver
1408905e8b43SDag-Erling Smørgravdevice		warp_saver
1409905e8b43SDag-Erling Smørgrav
14101c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1411f453022cSPeter Wemmdevice		sc
1412f71c01ccSPeter Wemmhint.sc.0.at="isa"
1413683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14146e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14156e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1416cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1417e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1418c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14196e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14206e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14216e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
142285e36760SJordan K. Hubbard
14237a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
142425388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
142525388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
142625388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
142725388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14287a88382dSKazutaka YOKOTA
1429d51e8487SJosh Paetzel# The following options will let you change the default behavior of
143078f45204SMaxim Sobolev# cut-n-paste feature
143178f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
143225388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
143325388b6cSBruce Evans					# (default is single space - \"x20\")
143478f45204SMaxim Sobolev
14357a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14367a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14377a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14387a88382dSKazutaka YOKOTA
14396e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14406e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14416e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14426e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14436e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14446e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1445c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14462ac8be82SAndreas Schulz
14478a28ce0eSJohn Baldwin# `flags' for sc
14488a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14498a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14508a28ce0eSJohn Baldwin
145183409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1452e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
145383409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
145483409a55SEd Schouten
1455ccbb7b5eSEd Maste# The vt video console driver.
1456ccbb7b5eSEd Mastedevice		vt
1457ccbb7b5eSEd Masteoptions		VT_ALT_TO_ESC_HACK=1	# Prepend ESC sequence to ALT keys
1458ccbb7b5eSEd Masteoptions		VT_MAXWINDOWS=16	# Number of virtual consoles
1459ccbb7b5eSEd Masteoptions		VT_TWOBUTTON_MOUSE	# Use right mouse button to paste
1460ccbb7b5eSEd Maste
1461ccbb7b5eSEd Maste# The following options set the default framebuffer size.
1462ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_HEIGHT=480
1463ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_WIDTH=640
1464ccbb7b5eSEd Maste
1465ccbb7b5eSEd Maste# The following options will let you change the default vt terminal colors.
1466ccbb7b5eSEd Masteoptions		TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)
1467ccbb7b5eSEd Masteoptions		TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)
1468ccbb7b5eSEd Maste
14691fe04850SBruce Evans#
1470d61e6649SAlexander Langer# Optional devices:
14716a8d6623SGarrett Wollman#
14726a8d6623SGarrett Wollman
14736a8d6623SGarrett Wollman#
1474d61e6649SAlexander Langer# SCSI host adapters:
14756a8d6623SGarrett Wollman#
14767f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1477859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14786e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14797f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1480d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1481d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1482cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14837f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
14846e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14856e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1486a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1487a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1488a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1489d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1490d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1491d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1492e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1493e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1494af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1495ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
149664fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
149764fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1498d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1499fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1500fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1501fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1502fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1503f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
15046e818956SDavid E. O'Brien# wds: WD7000
1505d61e6649SAlexander Langer
15066e818956SDavid E. O'Brien#
15076e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
15086e818956SDavid E. O'Brien# probed correctly.
15096e818956SDavid E. O'Brien#
15106e818956SDavid E. O'Briendevice		bt
15116e818956SDavid E. O'Brienhint.bt.0.at="isa"
15126e818956SDavid E. O'Brienhint.bt.0.port="0x330"
15137f5092f3SJohn Baldwindevice		adv
15147f5092f3SJohn Baldwinhint.adv.0.at="isa"
1515c9953c3bSPeter Wemmdevice		adw
15166e818956SDavid E. O'Briendevice		aha
15176e818956SDavid E. O'Brienhint.aha.0.at="isa"
15187f5092f3SJohn Baldwindevice		aic
15197f5092f3SJohn Baldwinhint.aic.0.at="isa"
15207f5092f3SJohn Baldwindevice		ahb
1521d61e6649SAlexander Langerdevice		ahc
1522cdd49e97SJustin T. Gibbsdevice		ahd
15231b946e21SScott Longdevice		esp
1524c5933b20SScott Longdevice		iscsi_initiator
1525d61e6649SAlexander Langerdevice		isp
15260787f2b8SMatt Jacobhint.isp.0.disable="1"
15270787f2b8SMatt Jacobhint.isp.0.role="3"
15280787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15290787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15300787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15310787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15320787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15330787f2b8SMatt Jacobhint.isp.0.topology="lport"
15340787f2b8SMatt Jacobhint.isp.0.topology="nport"
15350787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15360787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15370787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15380787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15390787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15400787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1541d61e6649SAlexander Langerdevice		ispfw
154264fa5108SMatt Jacobdevice		mpt
1543d61e6649SAlexander Langerdevice		ncr
1544d61e6649SAlexander Langerdevice		sym
1545f3d92b26SOlivier Houcharddevice		trm
15466e818956SDavid E. O'Briendevice		wds
15476e818956SDavid E. O'Brienhint.wds.0.at="isa"
15486e818956SDavid E. O'Brienhint.wds.0.port="0x350"
15496e818956SDavid E. O'Brienhint.wds.0.irq="11"
15506e818956SDavid E. O'Brienhint.wds.0.drq="6"
1551d61e6649SAlexander Langer
1552d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1553d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1554d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1555d61e6649SAlexander Langer# default.
1556d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1557d61e6649SAlexander Langer
1558fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1559fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1560fac70739SJeroen Ruigrok van der Werven
1561fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1562fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1563fac70739SJeroen Ruigrok van der Werven
1564662d3818SScott Long# Compile in Aic7xxx Debugging code.
1565662d3818SScott Longoptions 	AHC_DEBUG
1566662d3818SScott Long
1567662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1568662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1569662d3818SScott Long
1570f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1571f8f8803bSBruce Evans# See ahc(4).
1572662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1573662d3818SScott Long
1574cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1575cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1576cdd49e97SJustin T. Gibbs
1577f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1578cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1579cdd49e97SJustin T. Gibbs
158043e9d8a3SScott Long# Print human-readable register definitions when debugging
158143e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
158243e9d8a3SScott Long
1583662d3818SScott Long# Bitmap of units to enable targetmode operations.
1584662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1585662d3818SScott Long
1586d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1587d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1588d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1589d61e6649SAlexander Langer
1590c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1591c5933b20SScott Long#
1592c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1593c5933b20SScott Long
1594d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1595d61e6649SAlexander Langer#
1596d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1597d61e6649SAlexander Langer#
159864fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1599af606348SMatt Jacob#
16009a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
16019a1b0d43SMatt Jacob#		none=0
16029a1b0d43SMatt Jacob#		target=1
16039a1b0d43SMatt Jacob#		initiator=2
16049a1b0d43SMatt Jacob#		both=3			(not supported currently)
1605af606348SMatt Jacob#
160615f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
160715f0f952SMatt Jacob#
1608e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1609d61e6649SAlexander Langer
1610d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1611d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1612d61e6649SAlexander Langer					# Allows the ncr to take precedence
1613d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1614d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1615d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1616d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1617d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1618d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1619d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1620d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1621d61e6649SAlexander Langer					# default:8, range:[1..64]
16226a8d6623SGarrett Wollman
16236e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16246e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16256e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16266e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16276e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16286e818956SDavid E. O'Brien#
16296e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16306e818956SDavid E. O'Brien#  DPT_MEASURE_PERFORMANCE  Enables a set of (semi)invasive metrics. Various
16316e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16326e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16336e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16346e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16356e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16366e818956SDavid E. O'Brien#			    are 100% certain you need it.
16376e818956SDavid E. O'Brien
16386e818956SDavid E. O'Briendevice		dpt
16396e818956SDavid E. O'Brien
16406e818956SDavid E. O'Brien# DPT options
16416e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16426e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16436e818956SDavid E. O'Brien
16446e818956SDavid E. O'Brien#
16456e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16466e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16476e818956SDavid E. O'Brien# CAM infrastructure.
16486e818956SDavid E. O'Brien#
16496e818956SDavid E. O'Briendevice		ciss
16506e818956SDavid E. O'Brien
16516e818956SDavid E. O'Brien#
16526e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16536e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16546e818956SDavid E. O'Brien# at Intel for this driver are
16556e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16566e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16576e818956SDavid E. O'Brien#
16586e818956SDavid E. O'Briendevice		iir
16596e818956SDavid E. O'Brien
16606e818956SDavid E. O'Brien#
16616e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16626e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16636e818956SDavid E. O'Brien# the CAM infrastructure.
16646e818956SDavid E. O'Brien#
16656e818956SDavid E. O'Briendevice		mly
16666e818956SDavid E. O'Brien
16676e818956SDavid E. O'Brien#
16686e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16696e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16706e818956SDavid E. O'Brien# controllers.
16716e818956SDavid E. O'Brien#
16726e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16736e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16746e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
167564c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16767f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1677f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16786b31d3f7SScott Longoptions 	MFI_DEBUG
16796e818956SDavid E. O'Brien
16806e818956SDavid E. O'Brien#
16816e818956SDavid E. O'Brien# 3ware ATA RAID
16826e818956SDavid E. O'Brien#
16836e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16846e818956SDavid E. O'Brien
168590d3341eSPeter Wemm#
1686e19ef875SAlexander Motin# Serial ATA host controllers:
1687e19ef875SAlexander Motin#
1688e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1689dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1690e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
16911a00526bSAlexander Motin#
16921a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
16931a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1694e19ef875SAlexander Motin
1695e19ef875SAlexander Motindevice		ahci
1696dd48af36SAlexander Motindevice		mvs
1697e19ef875SAlexander Motindevice		siis
1698e19ef875SAlexander Motin
1699e19ef875SAlexander Motin#
170045f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
170145f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
17026d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1703c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1704c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1705c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1706c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1707c9953c3bSPeter Wemmdevice		ata
1708c4bda3c6SAlexander Motin
1709c4bda3c6SAlexander Motin# Modular ATA
1710c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1711c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1712c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1713c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1714c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1715c4bda3c6SAlexander Motin
1716c4bda3c6SAlexander Motin# PCI ATA chipsets
1717c4bda3c6SAlexander Motin#device		ataahci		# AHCI SATA
1718c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1719c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1720c4bda3c6SAlexander Motin#device		ataadaptec	# Adaptec
1721c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1722c4bda3c6SAlexander Motin#device		ataati		# ATI
1723c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1724c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1725c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1726c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1727c4bda3c6SAlexander Motin#device		ataintel	# Intel
1728c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1729c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1730c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1731c4bda3c6SAlexander Motin#device		atamicron	# Micron
1732c4bda3c6SAlexander Motin#device		atanational	# National
1733c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1734c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1735c4bda3c6SAlexander Motin#device		atapromise	# Promise
1736c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1737c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1738c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1739c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1740c4bda3c6SAlexander Motin
17418b89ef0aSSøren Schmidt#
17426d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17436d04301dSAlexander Langerhint.ata.0.at="isa"
17446d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17456d04301dSAlexander Langerhint.ata.0.irq="14"
17466d04301dSAlexander Langerhint.ata.1.at="isa"
17476d04301dSAlexander Langerhint.ata.1.port="0x170"
17486d04301dSAlexander Langerhint.ata.1.irq="15"
17496d04301dSAlexander Langer
17506d04301dSAlexander Langer#
1751000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1752000da71aSSøren Schmidt#
1753000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
175474d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
17556fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17566fb5300bSAlexander Motin#			before timing out.
175774d8e840SSøren Schmidt
17580d307e09SAlexander Motinoptions 	ATA_STATIC_ID
17596fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
176074d8e840SSøren Schmidt
17618b89ef0aSSøren Schmidt#
17626d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17636d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17646a8d6623SGarrett Wollman#
1765f71c01ccSPeter Wemmdevice		fdc
1766f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1767f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1768f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1769f71c01ccSPeter Wemmhint.fdc.0.drq="2"
177085827d9cSJoerg Wunsch#
1771d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1772d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1773d2fb4892SJoerg Wunsch# however.
1774d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1775d2fb4892SJoerg Wunsch#
1776f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1777f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1778f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1779f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
178085827d9cSJoerg Wunsch
1781f71c01ccSPeter Wemm# Specify floppy devices
1782f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1783f71c01ccSPeter Wemmhint.fd.0.drive="0"
1784f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1785f71c01ccSPeter Wemmhint.fd.1.drive="1"
178685827d9cSJoerg Wunsch
17876a8d6623SGarrett Wollman#
1788501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1789501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1790c8956b36SMarcel Moolenaar#
1791501ef98fSMarcel Moolenaardevice		uart
1792501ef98fSMarcel Moolenaar
17938194412bSMarcel Moolenaar# Options for uart(4)
17948194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
17958194412bSMarcel Moolenaar					# instead of DCD.
17961662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
17971662b008SIan Lepore					# no interrupt support (50 Hz default).
17988194412bSMarcel Moolenaar
1799501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1800501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1801501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1802501ef98fSMarcel Moolenaar
1803c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1804c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1805c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1806c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1807c8956b36SMarcel Moolenaar# unit number of the probed UART.
1808501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1809501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1810501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1811501ef98fSMarcel Moolenaar
1812501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1813c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1814c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1815c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1816c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1817c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1818c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1819c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1820d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1821c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1822c8956b36SMarcel Moolenaar#		as debug port.
18239546766aSBruce Evans#
18249546766aSBruce Evans
1825501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
1826*91ed2fecSJohn-Mark Gurneyoptions 	BREAK_TO_DEBUGGER	# A BREAK/DBG on the console goes to
1827c8956b36SMarcel Moolenaar					# ddb, if available.
18286a8d6623SGarrett Wollman
182926b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
183026b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18319c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1832c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
183326b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
183426b6ea69SPaul Saab
1835af2e25a6SMarcel Moolenaar# Serial Communications Controller
1836af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1837af2e25a6SMarcel Moolenaar# communications controllers.
1838af2e25a6SMarcel Moolenaardevice		scc
1839af2e25a6SMarcel Moolenaar
18409c564b6cSJohn Hay# PCI Universal Communications driver
184164220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18429c564b6cSJohn Haydevice		puc
18439c564b6cSJohn Hay
18446a8d6623SGarrett Wollman#
1845d61e6649SAlexander Langer# Network interfaces:
18466a8d6623SGarrett Wollman#
1847dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1848d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18493c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18508c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
18518c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
18528c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18538c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18548c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
18558c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1856dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
18578c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
18588c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1859dfd77572SJohn Baldwin
1860dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1861dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1862dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1863dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1864dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1865dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1866dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1867dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1868dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1869dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1870dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1871dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1872dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1873dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1874dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1875dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1876dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1877dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1878dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1879e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1880dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1881dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1882dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1883dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1884dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1885dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1886dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1887dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1888d61e6649SAlexander Langer
18897f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
18907f5092f3SJohn Baldwin#       PCI and ISA varieties.
1891ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1892ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1893cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1894cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1895d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
18963c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1897390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1898343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1899343ed0a8SJohn Baldwin#       adapters.
1900343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
190195d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1902586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1903586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1904586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
19054e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1906dd46ab31SDavid Christensen#       adapters.
19073132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1908eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1909119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
19107f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19117f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
191254e4ee71SNavdeep Parhar# cxgbe: Support for PCI express 10Gb/1Gb adapters based on the Chelsio T4
191354e4ee71SNavdeep Parhar#       (Terminator 4) ASIC.
1914d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1915d61e6649SAlexander Langer#       and various workalikes including:
1916d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1917d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1918d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1919d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1920d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1921d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1922d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1923d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1924d61e6649SAlexander Langer#       KNE110TX.
1925d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1926a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
192796a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
19287f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19297f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19307f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19317f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19327f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19337f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1934d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1935d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1936cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19371ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
193852c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
193975a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
194044ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1941c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1942c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1943c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1944d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1945d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1946778eefa4SJohn Baldwin#	Requires the mwl firmware module
1947778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1948c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1949c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1950c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1951c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19522bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1953d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1954ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1955ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1956ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1957cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1958cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
19592f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
196041f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19610fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19620fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19630fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19640fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19650fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1966390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19670587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1968d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1969d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1970d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1971d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1972d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1973d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1974d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1975d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1976d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1977d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1978d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1979d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1980d61e6649SAlexander Langer#       card which is 32-bit.
1981d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1982b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1983b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1984d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1985d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1986d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1987d61e6649SAlexander Langer#       (also single mode and multimode).
1988d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1989d61e6649SAlexander Langer#       attach each one as a separate network interface.
19907f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
19917f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
1992d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1993d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1994d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
1995d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
1996d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
1997d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1998d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1999c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2000c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2001d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2002d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2003d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2004d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2005d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20063c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2007362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2008d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2009d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2010e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2011e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20122608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2013d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2014d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2015d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2016d61e6649SAlexander Langer#       NE2000 clone.
20177f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20187f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20197f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20207f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20217f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20227f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2023d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2024d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2025d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2026d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2027d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2028d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2029d61e6649SAlexander Langer
20307f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20317f5092f3SJohn Baldwin
20327f5092f3SJohn Baldwindevice		cm
20337f5092f3SJohn Baldwinhint.cm.0.at="isa"
20347f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20357f5092f3SJohn Baldwinhint.cm.0.irq="9"
20367f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20377f5092f3SJohn Baldwindevice		ep
20387f5092f3SJohn Baldwindevice		ex
2039c06a3350SPeter Wemmdevice		fe
20407f5092f3SJohn Baldwinhint.fe.0.at="isa"
20417f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20427f5092f3SJohn Baldwindevice		fea
20437f5092f3SJohn Baldwindevice		sn
20447f5092f3SJohn Baldwinhint.sn.0.at="isa"
20457f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20467f5092f3SJohn Baldwinhint.sn.0.irq="10"
20477f5092f3SJohn Baldwindevice		an
20487f5092f3SJohn Baldwindevice		wi
20497f5092f3SJohn Baldwindevice		xe
20507f5092f3SJohn Baldwin
2051d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2052ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2053cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2054d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20553c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2056343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2057343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2058343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2059119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
20608090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
2061404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2062d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20634d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20644664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20654664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20661ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
206752c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20680587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2069343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
20700587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2071d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2072343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
20730587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2074d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
20752e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2076d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2077d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2078d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2079343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2080d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
20810587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2082d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2083eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2084d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
20852608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2086d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2087d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2088d61e6649SAlexander Langer
2089d61e6649SAlexander Langer# PCI Ethernet NICs.
209054e4ee71SNavdeep Parhardevice		cxgbe		# Chelsio T4 10GbE PCIe adapter
2091d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
209202f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
209302f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2094fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2095800422dcSJack F Vogeldevice		ixgbe		# Intel Pro/10Gbe PCIE Ethernet
209644ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2097f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2098fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
20992f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
21006e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
210195d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2102c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2103548d35fdSGeorge V. Neville-Neildevice		vxge		# Exar/Neterion XFrame 3100 10GbE
2104d61e6649SAlexander Langer
2105343ed0a8SJohn Baldwin# PCI FDDI NICs.
2106c06a3350SPeter Wemmdevice		fpa
2107d61e6649SAlexander Langer
21082bc6081cSScott Long# PCI WAN adapters.
21092bc6081cSScott Longdevice		lmc
21102bc6081cSScott Long
2111390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2112390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2113390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2114390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2115390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2116390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2117390cee87SJohn Baldwin#device		ath_rf2413
2118390cee87SJohn Baldwin#device		ath_rf2417
2119390cee87SJohn Baldwin#device		ath_rf2425
2120390cee87SJohn Baldwin#device		ath_rf5111
2121390cee87SJohn Baldwin#device		ath_rf5112
2122390cee87SJohn Baldwin#device		ath_rf5413
2123390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2124390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2125bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2126bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2127bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2128bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2129bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2130bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2131bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2132bc391cb2SWarner Losh# 4 are safe.
2133bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2134390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2135390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
213658c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2137390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2138390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2139eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2140d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2141d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2142778eefa4SJohn Baldwindevice		mwlfw
2143390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2144390cee87SJohn Baldwin
214510a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
214610a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
214798cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
214898cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
214910a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2150b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
215198cb733cSKenneth D. Merry
21522c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21532c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21542c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21552c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21562c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21572c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21582c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21592c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21602c8f5a28SKenneth D. Merry
216168713f97SKenjiro Cho#
216244b5247dSKenjiro Cho# ATM related options (Cranor version)
216344b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
216468713f97SKenjiro Cho#
216568713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
216668713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
216768713f97SKenjiro Cho#
2168c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2169c594298bSHartmut Brandt# ATM PCI cards.
2170c594298bSHartmut Brandt#
2171fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2172fb24f088SHartmut Brandt#
21738dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
21748dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
21758dd4275cSHartmut Brandt#
2176f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
217768713f97SKenjiro Cho# atm devices.
21783cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
217968713f97SKenjiro Cho# bypass TCP/IP.
218068713f97SKenjiro Cho#
2181fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2182fb24f088SHartmut Brandt# hatm and fatm.
21831ba46a03SHartmut Brandt#
218468713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
218568713f97SKenjiro Cho# for more details, please read the original documents at
218698a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
218768713f97SKenjiro Cho#
2188f71c01ccSPeter Wemmdevice		atm
218944b5247dSKenjiro Chodevice		en
2190fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2191c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
21928dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
21931ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
21948c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2195f4567b9cSJulian Elischer
21967e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
21977e9024cdSHartmut Brandt
2198c19da41eSPeter Wemm#
21990739ea1dSSeigo Tanimura# Sound drivers
2200c19da41eSPeter Wemm#
22010739ea1dSSeigo Tanimura# sound: The generic sound driver.
2202c7406082SJohn-Mark Gurney#
22030739ea1dSSeigo Tanimura
22040739ea1dSSeigo Tanimuradevice		sound
22050739ea1dSSeigo Tanimura
22060739ea1dSSeigo Tanimura#
22070739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2208c7406082SJohn-Mark Gurney#
22099c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22107f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22117f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22127f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22137f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22147f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22157f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22167f5092f3SJohn Baldwin#
2217c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22180739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2219d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2220903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2221903b2fb9SJoel Dahl#			for sparc64.
22220739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22230739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22240739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22250739ea1dSSeigo Tanimura#			4281)
22260739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22270739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22280fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22299f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22309f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22310739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2232727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2233727ded3aSJoel Dahl#			conjunction with snd_sbc.
22340739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22350739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22364b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22374b8939a1SAriff Abdullah#			compatible.
2238e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
223917470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2240903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2241903b2fb9SJoel Dahl#			nForce controllers.
22420739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22430739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22440739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22450739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22460739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22471c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22480739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22491c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22500739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22517f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22520739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2253de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2254903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22550739ea1dSSeigo Tanimura#			M5451 PCI.
2256de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22570739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22580739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22590739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
226081bb901eSPeter Wemm
2261f37a929cSPeter Wemmdevice		snd_ad1816
2262f37a929cSPeter Wemmdevice		snd_als4000
2263d9bde1adSAriff Abdullahdevice		snd_atiixp
22647a7386a3SPyun YongHyeon#device		snd_audiocs
22650739ea1dSSeigo Tanimuradevice		snd_cmi
2266f37a929cSPeter Wemmdevice		snd_cs4281
22670739ea1dSSeigo Tanimuradevice		snd_csa
2268f37a929cSPeter Wemmdevice		snd_ds1
2269f37a929cSPeter Wemmdevice		snd_emu10k1
22700fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2271b1ff0220SAlexander Leidingerdevice		snd_envy24
22729f548240SAlexander Leidingerdevice		snd_envy24ht
2273f37a929cSPeter Wemmdevice		snd_es137x
22740739ea1dSSeigo Tanimuradevice		snd_ess
2275f37a929cSPeter Wemmdevice		snd_fm801
22760739ea1dSSeigo Tanimuradevice		snd_gusc
22774b8939a1SAriff Abdullahdevice		snd_hda
2278e4afd792SAlexander Motindevice		snd_hdspe
22790739ea1dSSeigo Tanimuradevice		snd_ich
22800739ea1dSSeigo Tanimuradevice		snd_maestro
2281f37a929cSPeter Wemmdevice		snd_maestro3
22820739ea1dSSeigo Tanimuradevice		snd_mss
22830739ea1dSSeigo Tanimuradevice		snd_neomagic
2284f37a929cSPeter Wemmdevice		snd_sb16
2285f37a929cSPeter Wemmdevice		snd_sb8
22860739ea1dSSeigo Tanimuradevice		snd_sbc
22870739ea1dSSeigo Tanimuradevice		snd_solo
22889f548240SAlexander Leidingerdevice		snd_spicds
2289f37a929cSPeter Wemmdevice		snd_t4dwave
2290de8d750fSJoel Dahldevice		snd_uaudio
2291f37a929cSPeter Wemmdevice		snd_via8233
2292f37a929cSPeter Wemmdevice		snd_via82c686
22930739ea1dSSeigo Tanimuradevice		snd_vibes
2294c19da41eSPeter Wemm
22951c9c6382SRuslan Ermilov# For non-PnP sound cards:
2296673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2297673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2298673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2299673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2300673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2301673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2302673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2303673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2304673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2305673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2306673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2307673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2308673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2309673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23107f5092f3SJohn Baldwin
23116a8d6623SGarrett Wollman#
231218fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
231318fe4678SAriff Abdullah#
231418fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
231518fe4678SAriff Abdullah#                              sanity checking and possible increase of
231618fe4678SAriff Abdullah#                              verbosity.
231718fe4678SAriff Abdullah#
2318d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
231918fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
232018fe4678SAriff Abdullah#
232118fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
232218fe4678SAriff Abdullah#                              in. This options enable most feeder converters
232318fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
232418fe4678SAriff Abdullah#
232518fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
232618fe4678SAriff Abdullah#
232718fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
232818fe4678SAriff Abdullah#                              as much as possible (the default trying to
232918fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
233018fe4678SAriff Abdullah#
233118fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
233218fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
233318fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
233418fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
233518fe4678SAriff Abdullah#
233618fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
233718fe4678SAriff Abdullah#                              disabling multichannel processing.
233818fe4678SAriff Abdullah#
233918fe4678SAriff Abdullahoptions		SND_DEBUG
234018fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
234118fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
234218fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
234318fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
234418fe4678SAriff Abdullahoptions		SND_PCM_64
234518fe4678SAriff Abdullahoptions		SND_OLDSTEREO
234618fe4678SAriff Abdullah
234718fe4678SAriff Abdullah#
234883820457SPoul-Henning Kamp# IEEE-488 hardware:
234983820457SPoul-Henning Kamp# pcii:		PCIIA cards (uPD7210 based isa cards)
2350346fa631SPoul-Henning Kamp# tnt4882:	National Instruments PCI-GPIB card.
2351346fa631SPoul-Henning Kamp
235283820457SPoul-Henning Kampdevice	pcii
235383820457SPoul-Henning Kamphint.pcii.0.at="isa"
235483820457SPoul-Henning Kamphint.pcii.0.port="0x2e1"
235583820457SPoul-Henning Kamphint.pcii.0.irq="5"
235683820457SPoul-Henning Kamphint.pcii.0.drq="1"
235783820457SPoul-Henning Kamp
2358346fa631SPoul-Henning Kampdevice	tnt4882
2359346fa631SPoul-Henning Kamp
236083820457SPoul-Henning Kamp#
2361567e21c2SBruce Evans# Miscellaneous hardware:
23626a8d6623SGarrett Wollman#
23636fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
23643ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
23651c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23667f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2367603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2368657e73c4SPeter Dufault
23693ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
23703ae5b532SMatthew N. Dodddevice		mcd
23713ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
23723ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
23736fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
23746fe8789dSMatthew N. Dodddevice		scd
23756fe8789dSMatthew N. Doddhint.scd.0.at="isa"
23766fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
23771c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23787f5092f3SJohn Baldwinhint.joy.0.at="isa"
23797f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2380603d67aeSRink Springerdevice		cmx
2381a800f455SJulian Elischer
2382eeb706c0SJustin T. Gibbs#
2383a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23841c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2385a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
23861c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
23871c2b5939SRoger Hardiman#
2388a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2389a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2390a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2391a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
23921c2b5939SRoger Hardiman# These options can be used to override the auto detection
239398a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
23941c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
23959ff07e32SAmancio Hasty#
23964f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
23971c2b5939SRoger Hardiman# or
23981c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
23993c7c6c12SMike Pritchard# Specifies the default video capture mode.
24001748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2401d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2402a9c5b8d0SSøren Schmidt#
24034f5f3f07SBrian Somers# options 	BKTR_USE_PLL
24041748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2405a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2406a9c5b8d0SSøren Schmidt#
24071c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24089c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24091c2b5939SRoger Hardiman#
24101c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2411d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
24121c2b5939SRoger Hardiman#
24131c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24141c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24151c2b5939SRoger Hardiman#
24161c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24171c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24181c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24191c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24201c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24211c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24221c2b5939SRoger Hardiman#
242330e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
242430e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
242530e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
242630e27d96SAlexander Langer# mono sound.
2427017b0edcSMatt Jacob
2428c17d4340SNicolas Souchu#
2429c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2430c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2431c17d4340SNicolas Souchu#
243228ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24330f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
243437973e86SPeter Wemm#     device smbus
243537973e86SPeter Wemm#     device iicbus
243637973e86SPeter Wemm#     device iicbb
2437c17d4340SNicolas Souchu#     device iicsmb
24380f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24390f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
244028ebb692SNicolas Souchu#
2441c06a3350SPeter Wemmdevice		bktr
2442446cee6eSJoerg Wunsch
2443dc9deb29SPoul-Henning Kamp#
24446e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24456e818956SDavid E. O'Brien#
24465bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24476e818956SDavid E. O'Brien# pccard: pccard slots
24486e818956SDavid E. O'Brien# cardbus: cardbus slots
24496e818956SDavid E. O'Briendevice		cbb
24506e818956SDavid E. O'Briendevice		pccard
24516e818956SDavid E. O'Briendevice		cardbus
24526e818956SDavid E. O'Brien
24536e818956SDavid E. O'Brien#
24545bcb64f2SWarner Losh# MMC/SD
24555bcb64f2SWarner Losh#
2456831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2457831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2458831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2459831f5dcfSAlexander Motin#
2460831f5dcfSAlexander Motindevice		mmc
2461831f5dcfSAlexander Motindevice		mmcsd
2462831f5dcfSAlexander Motindevice		sdhci
24635bcb64f2SWarner Losh
24645bcb64f2SWarner Losh#
24658afa373cSNicolas Souchu# SMB bus
24668afa373cSNicolas Souchu#
24673c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24683c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24693c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24708afa373cSNicolas Souchu#
24718afa373cSNicolas Souchu# Supported devices:
24724d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24738afa373cSNicolas Souchu#
24743c5656bfSArchie Cobbs# Supported SMB interfaces:
247528ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
247628ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24777f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24787f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24797f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24807f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2481b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24824d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
248344e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24844d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
24850572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
24868afa373cSNicolas Souchu#
2487c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
24883c5656bfSArchie Cobbs
24897f5092f3SJohn Baldwindevice		intpm
24907f5092f3SJohn Baldwindevice		alpm
24917f5092f3SJohn Baldwindevice		ichsmb
24927f5092f3SJohn Baldwindevice		viapm
249344e6ce01SNicolas Souchudevice		amdpm
24944d5f30e0SRuslan Ermilovdevice		amdsmb
249544e6ce01SNicolas Souchudevice		nfpm
24964d5f30e0SRuslan Ermilovdevice		nfsmb
24970572ccaaSJim Harrisdevice		ismt
24987f5092f3SJohn Baldwin
2499c9953c3bSPeter Wemmdevice		smb
25008afa373cSNicolas Souchu
25018afa373cSNicolas Souchu#
25028afa373cSNicolas Souchu# I2C Bus
25038afa373cSNicolas Souchu#
25048afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
25058afa373cSNicolas Souchu#
25068afa373cSNicolas Souchu# Supported devices:
25078afa373cSNicolas Souchu# ic	i2c network interface
25088afa373cSNicolas Souchu# iic	i2c standard io
2509f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25101ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
25118afa373cSNicolas Souchu#
25128afa373cSNicolas Souchu# Supported interfaces:
251328ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
251428ebb692SNicolas Souchu#
251528ebb692SNicolas Souchu# Other:
251628ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25178afa373cSNicolas Souchu#
2518c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2519c9953c3bSPeter Wemmdevice		iicbb
25208afa373cSNicolas Souchu
2521c9953c3bSPeter Wemmdevice		ic
2522c9953c3bSPeter Wemmdevice		iic
2523c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25241ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
25258afa373cSNicolas Souchu
2526286fa445SRafal Jaworowski# I2C peripheral devices
2527286fa445SRafal Jaworowski#
2528286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
25291513a6ffSJayachandran C.# ds1374	Dallas Semiconductor DS1374 RTC
2530286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2531f8e8af9cSHiroki Sato# s35390a	Seiko Instruments S-35390A RTC
2532286fa445SRafal Jaworowski#
2533286fa445SRafal Jaworowskidevice		ds133x
25341513a6ffSJayachandran C.device		ds1374
2535286fa445SRafal Jaworowskidevice		ds1672
2536f8e8af9cSHiroki Satodevice		s35390a
2537286fa445SRafal Jaworowski
2538ab4c624bSMike Smith# Parallel-Port Bus
2539ab4c624bSMike Smith#
2540ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2541ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2542ab4c624bSMike Smith# are automatically probed and attached when found.
2543ab4c624bSMike Smith#
2544ab4c624bSMike Smith# Supported devices:
2545ab4c624bSMike Smith# vpo	Iomega Zip Drive
2546f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2547f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2548fdf94d1aSNicolas Souchu# lpt	Parallel Printer
254946f3ff79SMike Smith# plip	Parallel network interface
2550fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2551f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
255228ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25531caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2554ab4c624bSMike Smith#
2555ab4c624bSMike Smith# Supported interfaces:
2556ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2557ab4c624bSMike Smith#
2558ef8f7626SNicolas Souchu
25590f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25600f210c92SNicolas Souchu				  # (see flags in ppc(4))
25615895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25629d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2563ef8f7626SNicolas Souchu				# compliant peripheral
25645895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25655895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25665895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25675895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25685895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25693b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25703b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2571ef8f7626SNicolas Souchu
2572f71c01ccSPeter Wemmdevice		ppc
2573f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2574f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25750d31b179SPeter Wemmdevice		ppbus
25760d31b179SPeter Wemmdevice		vpo
25770d31b179SPeter Wemmdevice		lpt
25780d31b179SPeter Wemmdevice		plip
25790d31b179SPeter Wemmdevice		ppi
25800d31b179SPeter Wemmdevice		pps
25810d31b179SPeter Wemmdevice		lpbb
25820d31b179SPeter Wemmdevice		pcfclock
2583ab4c624bSMike Smith
25840ac40133SBrian Somers# Kernel BOOTP support
25850ac40133SBrian Somers
25860ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
25870ac40133SBrian Somers				# Requires NFSCLIENT and NFS_ROOT
25880ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
25890ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
25900ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
25910ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2592eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2593432aad0eSTor Egge
2594d94f38acSEivind Eklund#
25954103b765SPoul-Henning Kamp# Add software watchdog routines.
2596370c3cb5SSean Kelly#
25974103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2598370c3cb5SSean Kelly
2599370c3cb5SSean Kelly#
2600f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2601f7829d0dSAttilio Rao#
2602f7829d0dSAttilio Raooptions 	DEADLKRES
2603f7829d0dSAttilio Rao
2604f7829d0dSAttilio Rao#
2605b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
26064e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
26074e0ee531SMike Barcroft# it back on at run-time.
2608c796cfa1SAndrzej Bialecki#
2609c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2610c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2611c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2612c796cfa1SAndrzej Bialecki#
261319dde963SPeter Wemm#options 	NO_SWAPPING
2614c796cfa1SAndrzej Bialecki
26159dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26169dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26179dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26189dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26199dab0776SDavid Greenman#
26205895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26219dab0776SDavid Greenman
262215a1057cSEivind Eklund#
2623053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26249c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2625053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2626053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2627053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2628053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
262915a1057cSEivind Eklund#
263015a1057cSEivind Eklundoptions 	DEBUG_LOCKS
263115a1057cSEivind Eklund
263226086a03SPeter Wemm
263326086a03SPeter Wemm#####################################################################
26341d33cf3dSNick Hibma# USB support
26351d33cf3dSNick Hibma# UHCI controller
2636c9953c3bSPeter Wemmdevice		uhci
26371d33cf3dSNick Hibma# OHCI controller
2638c9953c3bSPeter Wemmdevice		ohci
2639ca3acad1SBernd Walter# EHCI controller
2640ca3acad1SBernd Walterdevice		ehci
2641857508a3SAndrew Thompson# XHCI controller
2642857508a3SAndrew Thompsondevice		xhci
264339e5901eSTakanori Watanabe# SL811 Controller
2644b92755d1SAndrew Thompson#device		slhci
26451d33cf3dSNick Hibma# General USB code (mandatory for USB)
2646c9953c3bSPeter Wemmdevice		usb
26471d33cf3dSNick Hibma#
2648b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2649b5ea1f0cSNick Hibmadevice		udbp
2650d1233ab3SBruce Evans# USB Fm Radio
2651d1233ab3SBruce Evansdevice		ufm
2652f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2653c9953c3bSPeter Wemmdevice		uhid
26541d33cf3dSNick Hibma# USB keyboard
2655c9953c3bSPeter Wemmdevice		ukbd
26561d33cf3dSNick Hibma# USB printer
2657c9953c3bSPeter Wemmdevice		ulpt
265831615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2659c9953c3bSPeter Wemmdevice		umass
266031615ef7SRebecca Cran# USB mass storage driver for device-side mode
266131615ef7SRebecca Crandevice		usfs
2662ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2663ce17576aSScott Longdevice		umct
2664e9fb12d3SNick Hibma# USB modem support
2665e9fb12d3SNick Hibmadevice		umodem
2666f26c33d2SNick Hibma# USB mouse
2667c9953c3bSPeter Wemmdevice		ums
2668eed447b5SHans Petter Selasky# USB touchpad(s)
2669eed447b5SHans Petter Selaskydevice		atp
2670eed447b5SHans Petter Selaskydevice		wsp
2671f25a8a01SGleb Smirnoff# eGalax USB touch screen
2672f25a8a01SGleb Smirnoffdevice		uep
26731c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2674e2dbd15fSNick Hibmadevice		urio
2675d1233ab3SBruce Evans#
2676916e6e02SJosef Karthauser# USB serial support
2677916e6e02SJosef Karthauserdevice		ucom
2678fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2679483b9e47SNick Hibmadevice		u3g
26809aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
26819aab0d96SMaxim Konovalovdevice		uark
2682d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2683d1233ab3SBruce Evansdevice		ubsa
268448b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
268548b68edfSJosef Karthauserdevice		uftdi
2686c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2687c5286e11STakanori Watanabedevice		uipaq
268848b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2689916e6e02SJosef Karthauserdevice		uplcom
26902e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
26912e7328e7SRink Springerdevice		uslcom
269248b68edfSJosef Karthauser# USB Visor and Palm devices
269348b68edfSJosef Karthauserdevice		uvisor
2694d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2695d1233ab3SBruce Evansdevice		uvscom
2696f26c33d2SNick Hibma#
2697ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2698d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2699d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2700d04bb221SBill Paul# eval board.
2701c9953c3bSPeter Wemmdevice		aue
2702bf029145SRobert Watson
2703bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2704bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2705bf029145SRobert Watsondevice		axe
270679eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
270779eb99dfSLi-Wen Hsudevice		axge
2708bf029145SRobert Watson
2709dfd1e98eSBill Paul#
27106bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
27116bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
27126bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
27136bcf0032SMaxim Sobolevdevice		cdce
27146bcf0032SMaxim Sobolev#
271501779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
271601779872SBill Paul# and Netmate II, and the Belkin F5U111.
2717c9953c3bSPeter Wemmdevice		cue
271801779872SBill Paul#
2719dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2720d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2721d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
272201779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
272301779872SBill Paul# and 2104USB, and the Corega USB-T.
2724c9953c3bSPeter Wemmdevice		kue
272511e04b05SShunsuke Akiyama#
272611e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
272711e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
272811e04b05SShunsuke Akiyamadevice		rue
2729cdd40f3bSMIHIRA Sanpei Yoshiro#
2730cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2731cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2732941e2863SAndrew Thompson#
273322445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
273422445463SKevin Lodevice		mos
273522445463SKevin Lo#
2736941e2863SAndrew Thompson# HSxPA devices from Option N.V
2737941e2863SAndrew Thompsondevice		uhso
2738cdd40f3bSMIHIRA Sanpei Yoshiro
273931d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
274031d98677SRui Paulodevice		rsu
27418a4cd00aSWarner Losh#
274271aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
274371aa1d32SSam Lefflerdevice		rum
274493393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
274593393dfdSAndrew Thompsondevice		run
27468a4cd00aSWarner Losh#
274771aa1d32SSam Leffler# Atheros AR5523 wireless driver
274871aa1d32SSam Lefflerdevice		uath
274971aa1d32SSam Leffler#
2750d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2751d1f25d5dSBernhard Schmidtdevice		upgt
2752d1f25d5dSBernhard Schmidt#
275371aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27548a4cd00aSWarner Loshdevice		ural
27558a4cd00aSWarner Losh#
275629311227SHans Petter Selasky# RNDIS USB ethernet driver
275729311227SHans Petter Selaskydevice		urndis
27585aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27595aaea652SKevin Lodevice		urtw
27605aaea652SKevin Lo#
2761c2c2fc4dSRui Paulo# Realtek RTL8188CU/RTL8192CU wireless driver
2762c2c2fc4dSRui Paulodevice		urtwn
2763c2c2fc4dSRui Paulo#
276471aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
276571aa1d32SSam Lefflerdevice		zyd
276645b395cdSGleb Smirnoff#
276745b395cdSGleb Smirnoff# Sierra USB wireless driver
276845b395cdSGleb Smirnoffdevice		usie
2769f26c33d2SNick Hibma
27708a4cd00aSWarner Losh#
2771f26c33d2SNick Hibma# debugging options for the USB subsystem
27721d33cf3dSNick Hibma#
27731d33cf3dSNick Hibmaoptions 	USB_DEBUG
2774fe75118bSNick Hibmaoptions 	U3G_DEBUG
2775f26c33d2SNick Hibma
27766e8394b8SKazutaka YOKOTA# options for ukbd:
27776e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2778cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
27796e8394b8SKazutaka YOKOTA
2780565f53bbSShunsuke Akiyama# options for uplcom:
27813c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2782565f53bbSShunsuke Akiyama						# in milliseconds
2783565f53bbSShunsuke Akiyama
278420280807SShunsuke Akiyama# options for uvscom:
278520280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
27863c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2787565f53bbSShunsuke Akiyama						# in milliseconds
278820280807SShunsuke Akiyama
27898b7ce2ffSSam Leffler#####################################################################
2790869093b1SHidetoshi Shimokawa# FireWire support
27917d2ba89bSJohn Baldwin
2792869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
27937d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
279479acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2795869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
27961c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2797869093b1SHidetoshi Shimokawa
2798869093b1SHidetoshi Shimokawa#####################################################################
2799869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2800869093b1SHidetoshi Shimokawa
2801869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2802869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2803869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2804869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2805869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2806869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
28077d2ba89bSJohn Baldwin
28087d2ba89bSJohn Baldwin#####################################################################
28098b7ce2ffSSam Leffler# crypto subsystem
28108b7ce2ffSSam Leffler#
28111c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2812b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
28131c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
28148b7ce2ffSSam Leffler#
28151c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28161c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28178b7ce2ffSSam Leffler
28188b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
28198b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28208b7ce2ffSSam Leffler
2821ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28228b7ce2ffSSam Leffler
2823b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2824b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2825b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2826b7c4858fSSam Leffler
2827b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2828b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2829b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2830b7c4858fSSam Leffler
28318b7ce2ffSSam Leffler#####################################################################
28328b7ce2ffSSam Leffler
28338b7ce2ffSSam Leffler
2834785d2100SJohn Birrell#
2835785d2100SJohn Birrell# Embedded system options:
2836785d2100SJohn Birrell#
2837785d2100SJohn Birrell# An embedded system might want to run something other than init.
28380fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2839bc0e3a03SJeroen Ruigrok van der Werven
2840bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2841bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28421c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2843395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
2844bc0e3a03SJeroen Ruigrok van der Werven
2845e2c1a4e9SBenno Rice#
2846e2c1a4e9SBenno Rice# Verbose SYSINIT
2847e2c1a4e9SBenno Rice#
2848e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2849e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2850e2c1a4e9SBenno Rice# will print function names instead of addresses.
2851e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2852e2c1a4e9SBenno Rice
2853446af86dSJohn Baldwin#####################################################################
2854446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2855446af86dSJohn Baldwin#
2856446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2857446af86dSJohn Baldwin# one time.
2858446af86dSJohn Baldwinoptions 	SEMMNI=11
2859446af86dSJohn Baldwin
2860446af86dSJohn Baldwin# Total number of semaphores system wide
2861446af86dSJohn Baldwinoptions 	SEMMNS=61
2862446af86dSJohn Baldwin
2863446af86dSJohn Baldwin# Total number of undo structures in system
2864446af86dSJohn Baldwinoptions 	SEMMNU=31
2865446af86dSJohn Baldwin
2866446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2867446af86dSJohn Baldwin# at one time.
2868446af86dSJohn Baldwinoptions 	SEMMSL=61
2869446af86dSJohn Baldwin
2870446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2871446af86dSJohn Baldwin# semaphore at one time.
2872446af86dSJohn Baldwinoptions 	SEMOPM=101
2873446af86dSJohn Baldwin
2874446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2875446af86dSJohn Baldwin# System V semaphore at one time.
2876446af86dSJohn Baldwinoptions 	SEMUME=11
2877446af86dSJohn Baldwin
2878446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2879446af86dSJohn Baldwinoptions 	SHMALL=1025
2880446af86dSJohn Baldwin
2881446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
288225388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2883446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2884446af86dSJohn Baldwin
2885446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2886446af86dSJohn Baldwinoptions 	SHMMIN=2
2887446af86dSJohn Baldwin
2888446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2889446af86dSJohn Baldwin# at one time.
2890446af86dSJohn Baldwinoptions 	SHMMNI=33
2891446af86dSJohn Baldwin
2892446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2893446af86dSJohn Baldwin# a single process at one time.
2894446af86dSJohn Baldwinoptions 	SHMSEG=9
2895446af86dSJohn Baldwin
28961d7a4f3cSAlfred Perlstein# Compress user core dumps.
28971d7a4f3cSAlfred Perlsteinoptions		COMPRESS_USER_CORES
28981d7a4f3cSAlfred Perlstein# required to compress file output from kernel for COMPRESS_USER_CORES.
28991d7a4f3cSAlfred Perlsteindevice		gzio
29001d7a4f3cSAlfred Perlstein
2901d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2902d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2903d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2904d9282887SDima Dorfman# console.
2905d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2906d9282887SDima Dorfman
29075bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
29085bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
29095bbb8060STor Egge# file.  Both offset and length of the read operation must be
29105bbb8060STor Egge# multiples of the physical media sector size.
29115bbb8060STor Egge#
2912995356dcSDag-Erling Smørgravoptions 	DIRECTIO
29135bbb8060STor Egge
29145bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
29155bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29165bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29175bbb8060STor Egge#
2918995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29195bbb8060STor Egge
2920446af86dSJohn Baldwin#####################################################################
2921446af86dSJohn Baldwin
2922bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29239c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2924bc0e3a03SJeroen Ruigrok van der Werven
2925bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
292628d7984fSJeroen Ruigrok van der Werven
292728d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2928bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
292928d7984fSJeroen Ruigrok van der Werven
2930bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29318b6f5e65SJeroen Ruigrok van der Werven
293228d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2933bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
293428d7984fSJeroen Ruigrok van der Werven
29358b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29368b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29378b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29388b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29398b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29408b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29418b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29428b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29438b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29448b6f5e65SJeroen Ruigrok van der Werven
29458b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29468b6f5e65SJeroen Ruigrok van der Werven
2947bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2948bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2949bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2950bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29518b6f5e65SJeroen Ruigrok van der Werven
29528b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29538b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29548b6f5e65SJeroen Ruigrok van der Werven
29558b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29568b6f5e65SJeroen Ruigrok van der Werven
2957316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2958316ec49aSScott Long
2959662d3818SScott Long# Adaptec Array Controller driver options
2960662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2961662d3818SScott Long				# 0 - quiet, only emit warnings
2962662d3818SScott Long				# 1 - noisy, emit major function
2963662d3818SScott Long				#     points and things done
2964662d3818SScott Long				# 2 - extremely noisy, emit trace
2965662d3818SScott Long				#     items in loops, etc.
2966662d3818SScott Long
2967097055e2SEdward Tomasz Napierala# Resource Accounting
2968097055e2SEdward Tomasz Napieralaoptions 	RACCT
2969097055e2SEdward Tomasz Napierala
2970ec125fbbSEdward Tomasz Napierala# Resource Limits
2971ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2972ec125fbbSEdward Tomasz Napierala
29731e9ea774SBruce Evans# Yet more undocumented options for linting.
29741e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29751e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29761e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
297725388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
297825388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29791e9ea774SBruce Evansoptions 	MAXFILES=999
2980efba048eSXin LI
2981997b0a64SDag-Erling Smørgrav# Random number generator
2982997b0a64SDag-Erling Smørgravoptions 	RANDOM_YARROW	# Yarrow RNG
2983997b0a64SDag-Erling Smørgrav##options 	RANDOM_FORTUNA	# Fortuna RNG - not yet implemented
2984997b0a64SDag-Erling Smørgravoptions 	RANDOM_DEBUG	# Debugging messages
2985997b0a64SDag-Erling Smørgravoptions 	RANDOM_RWFILE	# Read and write entropy cache
298681e3caafSJustin Hibbits
298781e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
298881e3caafSJustin Hibbitsoptions         IMAGACT_BINMISC
2989