xref: /freebsd/sys/conf/NOTES (revision e1b74f21f5993f6f5b482f6215aa9520ae68c2ca)
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
159fcdb1ffcSAndrey V. Elsukovoptions 	GEOM_MAP		# Map based partitioning
160069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1618a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
162e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1637dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1641d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1655aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
166d68d0cf5SAndrey V. Elsukovoptions 	GEOM_PART_BSD64		# BSD disklabel64
16791e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1686ad9a99fSMarcel Moolenaaroptions 	GEOM_PART_EBR_COMPAT	# Backward compatible partition names
1691d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
170e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1716bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
172b03fab12SMarcel Moolenaaroptions 	GEOM_PART_PC98		# PC-9800 disk partitioning
17310020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
174069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
17589b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
176e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
177560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1787dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
179069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
180fcdb1ffcSAndrey V. Elsukovoptions 	GEOM_UNCOMPRESS		# Read-only compressed disks (lzma, zip)
18175261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
18202e17f0bSMarius Strobloptions 	GEOM_VINUM		# Vinum logical volume manager
183f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
184069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1851c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1867b03a440SPoul-Henning Kamp
1878b140d57SMike Smith#
1888b140d57SMike Smith# The root device and filesystem type can be compiled in;
1898b140d57SMike Smith# this provides a fallback option if the root device cannot
1903b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1918b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1928b140d57SMike Smith#
1938b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1948b140d57SMike Smith
1956a8d6623SGarrett Wollman
1966a8d6623SGarrett Wollman#####################################################################
197f5d05ac3SJeff Roberson# Scheduler options:
198f5d05ac3SJeff Roberson#
199a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
200f5d05ac3SJeff Roberson# select which scheduler is compiled in.
201f5d05ac3SJeff Roberson#
202f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
2031c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
204f5d05ac3SJeff Roberson# good interactivity and priority selection.
205f5d05ac3SJeff Roberson#
206bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
207bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
208bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
209bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2109c0ef6d5SOliver Fromme# is the default scheduler.
211f5d05ac3SJeff Roberson#
21275a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
21375a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
21475a66a92SJeff Roberson#
215b998bd92SJeff Robersonoptions 	SCHED_4BSD
21675a66a92SJeff Robersonoptions 	SCHED_STATS
217b998bd92SJeff Roberson#options 	SCHED_ULE
218f5d05ac3SJeff Roberson
219f5d05ac3SJeff Roberson#####################################################################
220477a642cSPeter Wemm# SMP OPTIONS:
221477a642cSPeter Wemm#
222477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
223477a642cSPeter Wemm
224477a642cSPeter Wemm# Mandatory:
225477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
226477a642cSPeter Wemm
22768b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
22868b739cdSAttilio Rao# A default value should be already present, for every architecture.
22968b739cdSAttilio Raooptions 	MAXCPU=32
23068b739cdSAttilio Rao
231941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
232941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
233941646f5SAttilio Raooptions 	MAXMEMDOM=1
234941646f5SAttilio Rao
2352498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2362498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
237d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
238701f1408SScott Long# to disable it.
239701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2402498cf8cSJohn Baldwin
241cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
242cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
243d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
244cd6e6e4eSJohn Baldwin# to disable it.
245cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
246cd6e6e4eSJohn Baldwin
2471ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2481ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
249d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2501ae1c2a3SAttilio Rao# disable it.
2511ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2524e7f640dSJohn Baldwin
253ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
254ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
255ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
256cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
257ad27c4c7SJohn Baldwin# and WITNESS options.
258ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
259ad27c4c7SJohn Baldwin
2601a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2611a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2621a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
263cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2641a5d9b15SJohn Baldwin# and WITNESS options.
2651a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2661a5d9b15SJohn Baldwin
2674e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2684e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2694e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2704e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2714e7f640dSJohn Baldwin# and WITNESS options.
2724e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2734e7f640dSJohn Baldwin
2741fe4c660SJohn Baldwin# SMP Debugging Options:
2751fe4c660SJohn Baldwin#
2765b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2775b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2785e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2795e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2805e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
28167ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2820c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2838c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2840c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2850c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2860c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2879923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
288ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
289ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
29075a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
29175a66a92SJeff Roberson#	  frequency.
292ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
293ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
294c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
295c6111de5SDavide Italiano	  to hold active lock queues.
296aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
2971fe4c660SJohn Baldwin#         during locking operations.
298e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
2993c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
300660d1e3aSJohn Baldwin#	  sleep.
301660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
3029923b511SScott Longoptions 	PREEMPTION
3030c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
304ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
3051fe4c660SJohn Baldwinoptions 	WITNESS
306e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
307660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3081fe4c660SJohn Baldwin
309cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
31007dba937SKip Macyoptions 	LOCK_PROFILING
31100096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
31200096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
31300096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
31400096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3154db0d7f1SDag-Erling Smørgrav
3165b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3175b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3185b999a6bSDavide Italiano
319ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
320ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
321ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
322c6111de5SDavide Italianooptions 	UMTX_PROFILING
323331805a5SDavide Italiano
324ef0ebfc3SJohn Baldwin
325477a642cSPeter Wemm#####################################################################
3266a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
327690f540cSAndrey A. Chernov
3286a8d6623SGarrett Wollman#
3296a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
33056c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3317bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3327bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3337bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3347bbf05a2SJuli Mallett# signal delivery mechanism.
3356a8d6623SGarrett Wollman#
3365895e3c8SPeter Wemmoptions 	COMPAT_43
3376a8d6623SGarrett Wollman
338d3e64681SPoul-Henning Kamp# Old tty interface.
339d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
340d3e64681SPoul-Henning Kamp
341f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
342f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
343f5e4c105SJohn Baldwin
344f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
345f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
346f0eb293eSAlfred Perlstein
347a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
348a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
349a01b4125SKen Smith
3506c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3516c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3526c9fdda7SRuslan Ermilov
3535965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3545965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3555965c4b7SJohn Baldwin
3567d313e7bSJohn Baldwin# Enable FreeBSD9 compatibility syscalls
3577d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD9
3587d313e7bSJohn Baldwin
3597d313e7bSJohn Baldwin# Enable FreeBSD10 compatibility syscalls
3607d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD10
3617d313e7bSJohn Baldwin
3628d59ecb2SHans Petter Selasky# Enable Linux Kernel Programming Interface
3638d59ecb2SHans Petter Selaskyoptions 	COMPAT_LINUXKPI
3648d59ecb2SHans Petter Selasky
3656a8d6623SGarrett Wollman#
3666a8d6623SGarrett Wollman# These three options provide support for System V Interface
3676a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3686a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3696a8d6623SGarrett Wollman#
3706a8d6623SGarrett Wollmanoptions 	SYSVSHM
3716a8d6623SGarrett Wollmanoptions 	SYSVSEM
3726a8d6623SGarrett Wollmanoptions 	SYSVMSG
3736a8d6623SGarrett Wollman
3746a8d6623SGarrett Wollman
3756a8d6623SGarrett Wollman#####################################################################
3766a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3776a8d6623SGarrett Wollman
3786a8d6623SGarrett Wollman#
379e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3806a8d6623SGarrett Wollman#
381e2ee2173SMarcel Moolenaaroptions 	KDB
382b5d89ca8SBruce Evans
383b5d89ca8SBruce Evans#
384e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3857085e708SBruce Evans#
386e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
387e2ee2173SMarcel Moolenaar
388e2ee2173SMarcel Moolenaar#
389e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
390e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
391e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
392e2ee2173SMarcel Moolenaar#
393e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
394e2ee2173SMarcel Moolenaar
395e2ee2173SMarcel Moolenaar#
396e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
397e2ee2173SMarcel Moolenaar#
398e2ee2173SMarcel Moolenaaroptions 	DDB
3997085e708SBruce Evans
4007085e708SBruce Evans#
401bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
402bfdd261eSBruce Evans# representation.
403bfdd261eSBruce Evans#
404bfdd261eSBruce Evansoptions 	DDB_NUMSYM
405bfdd261eSBruce Evans
406bfdd261eSBruce Evans#
407e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
4080be15decSJohn Baldwin#
409e2ee2173SMarcel Moolenaaroptions 	GDB
410562d05dfSPaul Traina
411562d05dfSPaul Traina#
412df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
413df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4141c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
415df970488SRobert Watson# interfere with serial console operation.
416df970488SRobert Watson#
417df970488SRobert Watsonoptions 	SYSCTL_DEBUG
418df970488SRobert Watson
419df970488SRobert Watson#
42021d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
42121d748a9SAlfred Perlstein#
42221d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
42321d748a9SAlfred Perlstein
42421d748a9SAlfred Perlstein#
42521d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
42621d748a9SAlfred Perlstein#
42721d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
42821d748a9SAlfred Perlstein
42921d748a9SAlfred Perlstein#
43031615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
43131615ef7SRebecca Cran# resulting kernel.
43231615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
43331615ef7SRebecca Cran
43431615ef7SRebecca Cran#
435d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
436d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
437d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
438d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
439d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
440d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
441d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
442d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
443d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
444d7854da1SMatthew D Fleming# code.
445d7854da1SMatthew D Fleming#
446d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
447d7854da1SMatthew D Fleming
448d7854da1SMatthew D Fleming#
449e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
450e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
451e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
452e4eb384bSBosko Milekic#
453e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
454e4eb384bSBosko Milekic
455e4eb384bSBosko Milekic#
456847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
457847a2a17SPawel Jakub Dawidek# malloc(9).
458847a2a17SPawel Jakub Dawidek#
459847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
460847a2a17SPawel Jakub Dawidek
461847a2a17SPawel Jakub Dawidek#
462e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
463e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
464e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
465e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
466e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
467e79f350dSWarner Losh#
468e79f350dSWarner Losh#options	EARLY_PRINTF
469e79f350dSWarner Losh
470e79f350dSWarner Losh#
471ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
472ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
473ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
474ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
475ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
476ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
477ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4786a8d6623SGarrett Wollman#
4792365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
480ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
48121c64a07SAndrey A. Chernov
4826a8d6623SGarrett Wollman#
483f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
484a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
4856e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
48636b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
48736b7dde4SAndriy Gapon# before malloc(9) is functional.
488a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
489a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
490a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
491a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
492e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
493d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
494d4a2ab8cSAttilio Rao# separated by the "," character (ie:
495d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
496a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
497a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
498f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
499c508c1b6SJohn Baldwin#
500c508c1b6SJohn Baldwinoptions 	KTR
50136b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
50236b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
5036740ed37SGleb Smirnoffoptions 	KTR_COMPILE=(KTR_ALL)
504a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
505d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
506d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
507c508c1b6SJohn Baldwin
508c508c1b6SJohn Baldwin#
5091c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
510f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
511453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
512453ffeefSRobert Watson# in a worker thread.
513453ffeefSRobert Watson#
514453ffeefSRobert Watsonoptions 	ALQ
515453ffeefSRobert Watsonoptions 	KTR_ALQ
516453ffeefSRobert Watson
517453ffeefSRobert Watson#
5185526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5196a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5206a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5216a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5226a8d6623SGarrett Wollman# programming errors.
5236a8d6623SGarrett Wollman#
5245526d2d9SEivind Eklundoptions 	INVARIANTS
5255526d2d9SEivind Eklund
5265526d2d9SEivind Eklund#
52734b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
52834b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
52934b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
53034b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
53134b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
53234b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
53334b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
53434b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
53534b15f2aSJohn Baldwin# infrastructure without the added overhead.
53634b15f2aSJohn Baldwin#
53734b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
53834b15f2aSJohn Baldwin
53934b15f2aSJohn Baldwin#
5405526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
5415526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
5425526d2d9SEivind Eklund# it is disabled by default.
5435526d2d9SEivind Eklund#
5440dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
545da59a31cSDavid Greenman
5460dd1eea1SJordan K. Hubbard#
5470b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5483c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5490b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5500b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5510b5438c6SRobert Watson# impossible) scenarios.
5520b5438c6SRobert Watson#
5530b5438c6SRobert Watsonoptions 	REGRESSION
5540b5438c6SRobert Watson
5550b5438c6SRobert Watson#
5569c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
557346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
558346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
559346ebe51SEivind Eklund# from.)
560346ebe51SEivind Eklund#
561346ebe51SEivind Eklundoptions 	COMPILING_LINT
562346ebe51SEivind Eklund
5633c90d1eaSRobert Watson#
5643c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5653c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5663c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5673c90d1eaSRobert Watson#
5683c90d1eaSRobert Watsonoptions 	STACK
5693c90d1eaSRobert Watson
5706a8d6623SGarrett Wollman
5716a8d6623SGarrett Wollman#####################################################################
572d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
573d47cce3eSMarcel Moolenaar
574d47cce3eSMarcel Moolenaar#
575d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5769c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
577d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
578d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
579d47cce3eSMarcel Moolenaar#
580ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
581ad3869b4SJoseph Koshy# please see hwpmc(4).
582ad3869b4SJoseph Koshy
583d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
584680f1afdSJohn Baldwinoptions 	HWPMC_DEBUG
585d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
586d47cce3eSMarcel Moolenaar
587d47cce3eSMarcel Moolenaar
588d47cce3eSMarcel Moolenaar#####################################################################
5896a8d6623SGarrett Wollman# NETWORKING OPTIONS
59070c0b54cSAndrey A. Chernov
5916a8d6623SGarrett Wollman#
592a22fb0daSGeorge V. Neville-Neil# Protocol families
5936a8d6623SGarrett Wollman#
5946a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
59551f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
596a22fb0daSGeorge V. Neville-Neil
5974871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
5984871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
5998b07e49aSJulian Elischer
60009fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
60109fe6320SNavdeep Parhar
602a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
603a22fb0daSGeorge V. Neville-Neil# your kernel configuration
604a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
6052cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
60614dd6717SSam Leffler#
607db2e4792SBjoern A. Zeeb# #DEPRECATED#
608db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
609db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
610db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
61114dd6717SSam Leffler# they are assumed trusted.
61214dd6717SSam Leffler#
613fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
614fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
61514dd6717SSam Leffler#
616cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
6177b495c44SVANHULLEBUS Yvan#
6187b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
6197b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
6207b495c44SVANHULLEBUS Yvan#
6217b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
622f73bbaf2SDavid Greenman
623237abf0cSDavide Italiano#
624237abf0cSDavide Italiano# SMB/CIFS requester
625237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
626237abf0cSDavide Italiano# options.
627237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
628237abf0cSDavide Italiano
629d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
630d8589bd5SBoris Popovoptions 	LIBMCHAIN
631d8589bd5SBoris Popov
6326cd047a0SGleb Smirnoff# libalias library, performing NAT
6336cd047a0SGleb Smirnoffoptions 	LIBALIAS
6346cd047a0SGleb Smirnoff
63534b07340SKip Macy# flowtable cache
63634b07340SKip Macyoptions 	FLOWTABLE
63734b07340SKip Macy
638f8829a4aSRandall Stewart#
639f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
640f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
641f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
642f8829a4aSRandall Stewart# extensions. This release supports all the extensions
643f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6449c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
645f8829a4aSRandall Stewart# and is quite well tested.
646f8829a4aSRandall Stewart#
647f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6489c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6499c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
650f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
651f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
652f8829a4aSRandall Stewart#
653f8829a4aSRandall Stewartoptions 	SCTP
654f8829a4aSRandall Stewart# There are bunches of options:
655f8829a4aSRandall Stewart# this one turns on all sorts of
656d51e8487SJosh Paetzel# nastily printing that you can
6579c0ef6d5SOliver Fromme# do. It's all controlled by a
658f8829a4aSRandall Stewart# bit mask (settable by socket opt and
659f8829a4aSRandall Stewart# by sysctl). Including will not cause
660f8829a4aSRandall Stewart# logging until you set the bits.. but it
661f8829a4aSRandall Stewart# can be quite verbose.. so without this
662f8829a4aSRandall Stewart# option we don't do any of the tests for
663f8829a4aSRandall Stewart# bits and prints.. which makes the code run
664f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
665f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
666f8829a4aSRandall Stewart#
6679c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6689c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6699c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
670f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
671f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
672f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
673f8829a4aSRandall Stewart# like with such an offload (which only exists in
674f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
675f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
676f8829a4aSRandall Stewart# to be.. but it does speed things up try only
677f8829a4aSRandall Stewart# for in a captured lab environment :-)
678f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
679f8829a4aSRandall Stewart#
680cb7a4976SRandall Stewart
681f8829a4aSRandall Stewart#
682f8829a4aSRandall Stewart# All that options after that turn on specific types of
683f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
684f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
685f8829a4aSRandall Stewart# see. I have used this to produce interesting
686f8829a4aSRandall Stewart# charts and graphs as well :->
687f8829a4aSRandall Stewart#
6889c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
689f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
690f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
691f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
692cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
693f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
6949c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
695cb7a4976SRandall Stewart# things too.
696f8829a4aSRandall Stewart#
697f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
698f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
699cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
700cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
701cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
702cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
703cb7a4976SRandall Stewart
704f8829a4aSRandall Stewart
70502b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
70602b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
707cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
708cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
709cceffdeeSAndrew Thompson# option.
71002b199f1SMax Laieroptions 	ALTQ
711755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
712c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
71302b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
71402b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
715a5b789f6SErmal Luçioptions		ALTQ_FAIRQ	# Fair Packet Scheduler
71602b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7173c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
718cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
71902b199f1SMax Laieroptions 	ALTQ_DEBUG
72002b199f1SMax Laier
7214cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7224cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7234cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7244cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
72592a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
72692a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7274cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
72873e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
72973e87266SGleb Smirnoff					# affects netgraph(4) and nodes
73073e87266SGleb Smirnoff# Node types
7314cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
732bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
733b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
734b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
735b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
736b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
737b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
738b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
739b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
740b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
74192a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
742901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7437d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
7444cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7459e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
74631578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7474cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7489d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
74946aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
7504cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
75137379158SBrooks Davisoptions 	NETGRAPH_GIF
75237379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7534cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7544cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
75537379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
756f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
75748e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
758901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7594cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
760a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
761a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
762a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
763cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7646cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7657d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
766d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
767991633afSMarko Zecoptions 	NETGRAPH_PIPE
768b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
769b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
770add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7719e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7724cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
773b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7744d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7750a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
776d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
777e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7784cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7794cf49a43SJulian Elischeroptions 	NETGRAPH_UI
780b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
781b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
782666ea1b6SMaksim Yevmenkin
78302152e8fSHartmut Brandt# NgATM - Netgraph ATM
78402152e8fSHartmut Brandtoptions 	NGATM_ATM
785027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
786027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
787027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
788ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
789a7e22394SHartmut Brandtoptions 	NGATM_CCATM
79002152e8fSHartmut Brandt
791c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7923cf4d0bfSPoul-Henning Kamp
7930990ef0aSKevin Lo# Network stack virtualization.
794287cd4a2SKevin Lo#options	VIMAGE
795287cd4a2SKevin Lo#options	VNET_DEBUG	# debug for VIMAGE
7960990ef0aSKevin Lo
7976a8d6623SGarrett Wollman#
7986a8d6623SGarrett Wollman# Network interfaces:
799f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
80036782d14SWojciech A. Koszekdevice		loop
80136782d14SWojciech A. Koszek
802f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
8039d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
804722012ccSJulian Elischer#  configured or token-ring is enabled.
80536782d14SWojciech A. Koszekdevice		ether
80636782d14SWojciech A. Koszek
807fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
8089d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
80936782d14SWojciech A. Koszekdevice		vlan
81036782d14SWojciech A. Koszek
811007054f0SBryan Venteicher# The `vxlan' device implements the VXLAN encapsulation of Ethernet
812007054f0SBryan Venteicher# frames in UDP packets according to RFC7348.
813007054f0SBryan Venteicherdevice		vxlan
814007054f0SBryan Venteicher
81557a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
81667e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
817f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
81836782d14SWojciech A. Koszekdevice		wlan
81936782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
82036782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
82159aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
82259aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
82336782d14SWojciech A. Koszek
82467e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
82567e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
82667e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
82736782d14SWojciech A. Koszekdevice		wlan_wep
82836782d14SWojciech A. Koszekdevice		wlan_ccmp
82936782d14SWojciech A. Koszekdevice		wlan_tkip
83036782d14SWojciech A. Koszek
83167e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
83267e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
83334341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
83436782d14SWojciech A. Koszekdevice		wlan_xauth
83536782d14SWojciech A. Koszek
83667e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
83767e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
83867e4db77SSam Leffler#  `wlan' module.
83936782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
84036782d14SWojciech A. Koszekdevice		wlan_acl
84136782d14SWojciech A. Koszekdevice		wlan_amrr
84236782d14SWojciech A. Koszek
84336782d14SWojciech A. Koszek# Generic TokenRing
84436782d14SWojciech A. Koszekdevice		token
84536782d14SWojciech A. Koszek
8461a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
84736782d14SWojciech A. Koszekdevice		fddi
84836782d14SWojciech A. Koszek
849eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
85036782d14SWojciech A. Koszekdevice		arcnet
85136782d14SWojciech A. Koszek
852f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
853e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
85436782d14SWojciech A. Koszekdevice		sppp
85536782d14SWojciech A. Koszek
856f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
857d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8589c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
85936782d14SWojciech A. Koszekdevice		bpf
86036782d14SWojciech A. Koszek
861e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
862e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
863e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
864e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
865e4b68814SLuigi Rizzodevice		netmap
866e4b68814SLuigi Rizzo
867f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
86859d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
86970e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
87036782d14SWojciech A. Koszekdevice		disc
87136782d14SWojciech A. Koszek
872d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
873d0ea4743SBjoern A. Zeeb# like interface pair.
874d0ea4743SBjoern A. Zeebdevice		epair
875d0ea4743SBjoern A. Zeeb
87663518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
87763518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
87836782d14SWojciech A. Koszekdevice		edsc
87936782d14SWojciech A. Koszek
8804c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
88136782d14SWojciech A. Koszekdevice		tap
88236782d14SWojciech A. Koszek
88336782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
88436782d14SWojciech A. Koszekdevice		tun
88536782d14SWojciech A. Koszek
886f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
887cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
888cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
889f325335cSAndrey V. Elsukov#  The `gre' device implements GRE (Generic Routing Encapsulation) tunneling,
890f325335cSAndrey V. Elsukov#  as specified in the RFC 2784 and RFC 2890.
891f325335cSAndrey V. Elsukov#  The `me' device implements Minimal Encapsulation within IPv4 as
892f325335cSAndrey V. Elsukov#  specified in the RFC 2004.
893f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
894f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
89536782d14SWojciech A. Koszekdevice		gif
89636782d14SWojciech A. Koszekdevice		gre
897f325335cSAndrey V. Elsukovdevice		me
89836782d14SWojciech A. Koszekoptions 	XBONEHACK
89936782d14SWojciech A. Koszek
900d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
90136782d14SWojciech A. Koszekdevice		stf
90236782d14SWojciech A. Koszek
9038d69c48bSMax Laier# The pf packet filter consists of three devices:
9048d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
9058d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
9068d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
9078d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
90836782d14SWojciech A. Koszekdevice		pf
90936782d14SWojciech A. Koszekdevice		pflog
91036782d14SWojciech A. Koszekdevice		pfsync
91136782d14SWojciech A. Koszek
91236782d14SWojciech A. Koszek# Bridge interface.
91336782d14SWojciech A. Koszekdevice		if_bridge
91436782d14SWojciech A. Koszek
91536782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
91636782d14SWojciech A. Koszekdevice		carp
91736782d14SWojciech A. Koszek
91836782d14SWojciech A. Koszek# IPsec interface.
91936782d14SWojciech A. Koszekdevice		enc
92036782d14SWojciech A. Koszek
92136782d14SWojciech A. Koszek# Link aggregation interface.
92236782d14SWojciech A. Koszekdevice		lagg
92336782d14SWojciech A. Koszek
9248d69c48bSMax Laier#
9256a8d6623SGarrett Wollman# Internet family options:
9266a8d6623SGarrett Wollman#
9276a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9280948f0a2SBruce M Simpson# with mrouted and XORP.
929e0f688baSJeffrey Hsu#
930d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
931ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
932ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
933ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
934ab6e02daSJordan K. Hubbard#
935ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
936ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
937a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
938ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
939ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
940ab6e02daSJordan K. Hubbard# feature works properly.
9418dd4744eSJordan K. Hubbard#
942ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
943ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
944ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
945ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
946ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
947ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
948ffdd472dSPeter Wemm# out of sync.
949d29895dcSGarrett Wollman#
95084bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
95184bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
95293e0e116SJulian Elischer#
95361c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
954531c890bSPaolo Pisati# LIBALIAS.
95561c0e134SPaolo Pisati#
9561b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9571c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9581b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9591b968362SDag-Erling Smørgrav#
9607f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9617f7ef494SGleb Smirnoff#
9625e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9635e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9645e331acdSGarrett Wollman# using the trpt(8) utility.
96565e8111fSBruce Evans#
96686a996e6SHiren Panchasara# TCPPCAP enables code which keeps the last n packets sent and received
96786a996e6SHiren Panchasara# on a TCP socket.
96886a996e6SHiren Panchasara#
96965e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9709731596aSGleb Smirnoff#
971e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
972d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9734479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9745895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
975e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
97661c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
97793e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9789cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9799cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9800c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9818259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9821b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
9837f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
98465e8111fSBruce Evansoptions 	TCPDEBUG
98586a996e6SHiren Panchasaraoptions 	TCPPCAP
9869731596aSGleb Smirnoffoptions 	RADIX_MPATH
9876a8d6623SGarrett Wollman
98853dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
98953dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
990f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9914e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9926eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9936eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9946eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
99553dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9966eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9974a5ccac7SMike Silbersack
9989c0ef6d5SOliver Fromme# Statically link in accept filters
999a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
1000744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
1001a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
1002a79b7128SAlfred Perlstein
1003b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
1004b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
1005b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
1006b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
1007b65946c6SJohn-Mark Gurney# This requires the use of 'device crypto' and 'options IPSEC'.
10085164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
1009b52f8407SBruce M Simpson
1010f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
1011f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
1012358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
1013358f8d82SRobert Watson# a smooth scheduling of the traffic.
101468ec4eb6SLuigi Rizzooptions 	DUMMYNET
101568e9d934SLuigi Rizzo
10166a8d6623SGarrett Wollman#####################################################################
10176a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1018e3178a06SJordan K. Hubbard
10192365e64fSRodney W. Grimes#
10203f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10213f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10223f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10233f850e6aSKonstantin Belousov# filesystems as well.
10246a8d6623SGarrett Wollman#
102555793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1026534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1027534046e3SRong-En Fan# resolved.
10282365e64fSRodney W. Grimes#
1029f1a9c715SDavid Greenman
10306a8d6623SGarrett Wollman# One of these is mandatory:
10316a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1032c15882f0SRick Macklemoptions 	NFSCL			#Network File System client
10336a8d6623SGarrett Wollman
10346a8d6623SGarrett Wollman# The rest are optional:
10353914ddf8SEdward Tomasz Napieralaoptions 	AUTOFS			#Automounter filesystem
10365895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
103799d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
10385fe58019SAttilio Raooptions 	FUSE			#FUSE support module
1039dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1040dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10413e32dff5SJohn Baldwinoptions 	NFSD			#Network Filesystem Server
10429c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10431bea7c61SMaxim Sobolev
1044f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10454d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
104652ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1047bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1048237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
104978920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1050df263cbdSScott Longoptions 	UDF			#Universal Disk Format
105199d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1052bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1053bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1054f1a9c715SDavid Greenman
1055d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1056d61e6649SAlexander Langer# making abrupt shutdown less risky.
1057f8f8d7afSEivind Eklund#
10583d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1059b1897c19SJulian Elischer
1060a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
106151be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
106251be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
106349993db0SRobert Watsonoptions 	UFS_EXTATTR
106449993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1065a64ed089SRobert Watson
106651be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
106751be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
106851be6918SChris D. Faulhaber# for the underlying filesystem.
106951be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
107051be6918SChris D. Faulhaberoptions 	UFS_ACL
107151be6918SChris D. Faulhaber
10729b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10739b5ad47fSIan Dowse# directories at the expense of some memory.
10749b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10759b5ad47fSIan Dowse
1076f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1077f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1078f348204cSPawel Jakub Dawidek
107971e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
108071e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
108171e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
108271e4fff8SPoul-Henning Kamp
108371e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
108471e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
108571e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1086d52d7365SPoul-Henning Kamp
1087495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10882365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10896a8d6623SGarrett Wollman
1090276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
109145c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1092276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1093276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1094ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10956110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1096276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1097276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
10989c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1099276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1100276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1101276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1102cb800e34SJulian Elischer#
1103cb800e34SJulian Elischeroptions 	SUIDDIR
1104cb800e34SJulian Elischer
1105df394affSJohn-Mark Gurney# NFS options:
11065895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
11075895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
11085895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
11095895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
1110df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1111df394affSJohn-Mark Gurney
1112053a2b61SEivind Eklund#
1113053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1114053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1115053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1116053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1117053a2b61SEivind Eklund#
11185895e3c8SPeter Wemmoptions 	EXT2FS
1119053a2b61SEivind Eklund
1120fe98fb32SJean-Sébastien Pédron#
1121fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1122fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1123fe98fb32SJean-Sébastien Pédron#
1124fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1125fe98fb32SJean-Sébastien Pédron
1126dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
11270cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
11280cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1129dd85920aSJason Evansoptions 	VFS_AIO
1130053a2b61SEivind Eklund
11318ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1132ac519db0SMark Murraydevice		random
113315bbdecfSMark Murray
11348ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1135e83e229dSWarner Loshdevice		mem
11368ab2f5ecSMark Murray
113700a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
113800a5db46SStacey Sondevice		ksyms
113900a5db46SStacey Son
1140c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1141c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1142c4f02a89SMax Khonoptions 	CD9660_ICONV
1143c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1144126f0dfaSScott Longoptions 	UDF_ICONV
1145c4f02a89SMax Khon
11466a8d6623SGarrett Wollman
11476a8d6623SGarrett Wollman#####################################################################
1148abc97a06SBruce Evans# POSIX P1003.1B
1149abc97a06SBruce Evans
11501c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1151abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1152abc97a06SBruce Evans
11535895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11548cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11558cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11563ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1157abc97a06SBruce Evans
11585b40ce27SDavid Xu# POSIX message queue
11595b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1160abc97a06SBruce Evans
1161abc97a06SBruce Evans#####################################################################
116212e9f256SRobert Watson# SECURITY POLICY PARAMETERS
116312e9f256SRobert Watson
1164fdcba197SRobert Watson# Support for BSM audit
1165fdcba197SRobert Watsonoptions 	AUDIT
1166fdcba197SRobert Watson
1167cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1168cd6d1d76SBruce Evansoptions 	MAC
1169eae2f20cSRobert Watsonoptions 	MAC_BIBA
1170eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1171eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1172c4725737SRobert Watsonoptions 	MAC_LOMAC
1173eae2f20cSRobert Watsonoptions 	MAC_MLS
1174eae2f20cSRobert Watsonoptions 	MAC_NONE
1175eae2f20cSRobert Watsonoptions 	MAC_PARTITION
117603d03162SRobert Watsonoptions 	MAC_PORTACL
1177eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1178782f7255SRobert Watsonoptions 	MAC_STUB
1179eae2f20cSRobert Watsonoptions 	MAC_TEST
118012e9f256SRobert Watson
118196fcc75fSRobert Watson# Support for Capsicum
118255d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
118355d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
118496fcc75fSRobert Watson
118512e9f256SRobert Watson
118612e9f256SRobert Watson#####################################################################
1187000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1188000033d0SJeroen Ruigrok van der Werven
1189000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1190358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1191358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1192358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1193358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1194358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1195358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1196358f8d82SRobert Watson# actually reducing the accuracy of operation.
1197000033d0SJeroen Ruigrok van der Werven
1198000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1199000033d0SJeroen Ruigrok van der Werven
1200f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1201f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1202f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1203f309f881SJohn Baldwin
1204f309f881SJohn Baldwinoptions 	PPS_SYNC
1205f309f881SJohn Baldwin
1206b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1207b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1208b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1209b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1210b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1211b0fdc837SLawrence Stewart
1212b0fdc837SLawrence Stewartoptions 	FFCLOCK
1213b0fdc837SLawrence Stewart
1214000033d0SJeroen Ruigrok van der Werven
1215000033d0SJeroen Ruigrok van der Werven#####################################################################
1216de6a307eSPeter Dufault# SCSI DEVICES
1217de6a307eSPeter Dufault
12186a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12196a8d6623SGarrett Wollman
12206a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1221ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12226a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12236a8d6623SGarrett Wollman# device configuration sections below.
12246a8d6623SGarrett Wollman#
1225e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1226e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1227e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1228e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1229e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1230e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1231e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1232e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1233e14eb5a1SGarrett Wollman# problem.)
1234ebc1a0e2SPeter Dufault
1235ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1236ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1237700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1238700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1239ebc1a0e2SPeter Dufault
1240ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1241ebc1a0e2SPeter Dufault
1242f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1243f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1244f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1245f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1246f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1247f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1248f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1249f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1250f71c01ccSPeter Wemmhint.da.0.target="0"
1251f71c01ccSPeter Wemmhint.da.0.unit="0"
1252f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1253f71c01ccSPeter Wemmhint.da.1.target="1"
1254f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1255f71c01ccSPeter Wemmhint.da.2.target="3"
1256f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1257f71c01ccSPeter Wemmhint.sa.1.target="6"
1258ebc1a0e2SPeter Dufault
1259ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1260ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1261ebc1a0e2SPeter Dufault
1262ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1263ebc1a0e2SPeter Dufault
1264cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1265cf2458c9SMatt Jacob#
1266cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1267cf2458c9SMatt Jacob# ("WORM") devices.
1268cf2458c9SMatt Jacob#
1269cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1270cf2458c9SMatt Jacob#
1271cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1272cf2458c9SMatt Jacob#
12733c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12743c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1275cf2458c9SMatt Jacob#
1276cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1277cf2458c9SMatt Jacob#
12781eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12791eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12801eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1281d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1282cf2458c9SMatt Jacob#
1283cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1284cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1285cf2458c9SMatt Jacob#
1286cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1287cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1288cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1289cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1290cf2458c9SMatt Jacob#
1291cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1292cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1293cf2458c9SMatt Jacob# to them.
1294cf2458c9SMatt Jacob#
1295b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1296ebc1a0e2SPeter Dufault
1297c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1298c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1299c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1300c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1301c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1302dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1303cf2458c9SMatt Jacobdevice		pt		#SCSI processor
130464ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
130564ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1306cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13071eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1308130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13098909a72bSPeter Dufault
1310700daf5eSJustin T. Gibbs# CAM OPTIONS:
1311700daf5eSJustin T. Gibbs# debugging options:
1312f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1313f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1314f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1315f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1316f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1317f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1318f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1319700daf5eSJustin T. Gibbs#
1320700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1321700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1322700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
132356234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
132456234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13253a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13263a937198SBrooks Davis#             can be changed at boot and runtime with the
13273a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1328700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1329f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1330f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13315895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13325895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13335895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1334f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13355895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1336700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1337700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
133832672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
13391a7c583cSGarrett Wollman
1340700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1341700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1342700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1343700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1344700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1345700daf5eSJustin T. Gibbs# respectively.
134693063432SJoerg Wunsch#
1347700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1348700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1349700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
135093063432SJoerg Wunsch#
13515895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13525895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
135393063432SJoerg Wunsch
13549dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1355b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13569dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13579dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13589dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13599f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
136025388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
136125388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
136225388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
136325388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13649f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13659dfb4471SKenneth D. Merry
13663ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13673ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
136825388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13693ece1bd2SKenneth D. Merry
13708904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13718904e70bSMatt Jacob#
13728904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13738904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13749c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13758904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13768904e70bSMatt Jacob
13776a8d6623SGarrett Wollman
13786a8d6623SGarrett Wollman#####################################################################
13796a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13806a8d6623SGarrett Wollman
1381bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13826d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1383f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1384932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1385efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13866aec1278SMax Laierdevice		firmware	#firmware(9) support
1387be174c7eSGreg Lehey
13886f2d8adbSBoris Popov# Kernel side iconv library
13896f2d8adbSBoris Popovoptions 	LIBICONV
13906f2d8adbSBoris Popov
139158067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13925895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
139358067a99SPoul-Henning Kamp
13946a8d6623SGarrett Wollman
13956a8d6623SGarrett Wollman#####################################################################
1396d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1397d61e6649SAlexander Langer
1398d61e6649SAlexander Langer# For ISA the required hints are listed.
13995bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
14005bcb64f2SWarner Losh# no hints are needed.
1401d61e6649SAlexander Langer
1402d61e6649SAlexander Langer#
1403d61e6649SAlexander Langer# Mandatory devices:
1404d61e6649SAlexander Langer#
1405d61e6649SAlexander Langer
14066e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
14076e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
14086e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
14096e818956SDavid E. O'Brien
14107f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
14117f5092f3SJohn Baldwin
1412837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1413837f167eSRuslan Ermilov
1414905e8b43SDag-Erling Smørgrav# Various screen savers.
1415905e8b43SDag-Erling Smørgravdevice		blank_saver
1416905e8b43SDag-Erling Smørgravdevice		daemon_saver
1417905e8b43SDag-Erling Smørgravdevice		dragon_saver
1418905e8b43SDag-Erling Smørgravdevice		fade_saver
1419905e8b43SDag-Erling Smørgravdevice		fire_saver
1420905e8b43SDag-Erling Smørgravdevice		green_saver
1421905e8b43SDag-Erling Smørgravdevice		logo_saver
1422905e8b43SDag-Erling Smørgravdevice		rain_saver
1423905e8b43SDag-Erling Smørgravdevice		snake_saver
1424905e8b43SDag-Erling Smørgravdevice		star_saver
1425905e8b43SDag-Erling Smørgravdevice		warp_saver
1426905e8b43SDag-Erling Smørgrav
14271c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1428f453022cSPeter Wemmdevice		sc
1429f71c01ccSPeter Wemmhint.sc.0.at="isa"
1430683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14316e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14326e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1433cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1434e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1435c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14366e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14376e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14386e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
143985e36760SJordan K. Hubbard
14407a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
144125388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
144225388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
144325388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
144425388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14457a88382dSKazutaka YOKOTA
1446d51e8487SJosh Paetzel# The following options will let you change the default behavior of
144778f45204SMaxim Sobolev# cut-n-paste feature
144878f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
144925388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
145025388b6cSBruce Evans					# (default is single space - \"x20\")
145178f45204SMaxim Sobolev
14527a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14537a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14547a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14557a88382dSKazutaka YOKOTA
14566e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14576e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14586e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14596e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14606e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14616e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1462c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14632ac8be82SAndreas Schulz
14648a28ce0eSJohn Baldwin# `flags' for sc
14658a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14668a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14678a28ce0eSJohn Baldwin
146883409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1469e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
147083409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
147183409a55SEd Schouten
1472ccbb7b5eSEd Maste# The vt video console driver.
1473ccbb7b5eSEd Mastedevice		vt
1474ccbb7b5eSEd Masteoptions		VT_ALT_TO_ESC_HACK=1	# Prepend ESC sequence to ALT keys
1475ccbb7b5eSEd Masteoptions		VT_MAXWINDOWS=16	# Number of virtual consoles
1476ccbb7b5eSEd Masteoptions		VT_TWOBUTTON_MOUSE	# Use right mouse button to paste
1477ccbb7b5eSEd Maste
1478ccbb7b5eSEd Maste# The following options set the default framebuffer size.
1479ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_HEIGHT=480
1480ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_WIDTH=640
1481ccbb7b5eSEd Maste
1482ccbb7b5eSEd Maste# The following options will let you change the default vt terminal colors.
1483ccbb7b5eSEd Masteoptions		TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)
1484ccbb7b5eSEd Masteoptions		TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)
1485ccbb7b5eSEd Maste
14861fe04850SBruce Evans#
1487d61e6649SAlexander Langer# Optional devices:
14886a8d6623SGarrett Wollman#
14896a8d6623SGarrett Wollman
14906a8d6623SGarrett Wollman#
1491d61e6649SAlexander Langer# SCSI host adapters:
14926a8d6623SGarrett Wollman#
14937f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1494859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14956e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14967f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1497d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1498d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1499cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
15007f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
15016e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
15026e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1503a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1504a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1505a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1506d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1507d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1508d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1509e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1510e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1511af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1512ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
151364fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
151464fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1515d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1516fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1517fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1518fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1519fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1520f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
15216e818956SDavid E. O'Brien# wds: WD7000
1522d61e6649SAlexander Langer
15236e818956SDavid E. O'Brien#
15246e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
15256e818956SDavid E. O'Brien# probed correctly.
15266e818956SDavid E. O'Brien#
15276e818956SDavid E. O'Briendevice		bt
15286e818956SDavid E. O'Brienhint.bt.0.at="isa"
15296e818956SDavid E. O'Brienhint.bt.0.port="0x330"
15307f5092f3SJohn Baldwindevice		adv
15317f5092f3SJohn Baldwinhint.adv.0.at="isa"
1532c9953c3bSPeter Wemmdevice		adw
15336e818956SDavid E. O'Briendevice		aha
15346e818956SDavid E. O'Brienhint.aha.0.at="isa"
15357f5092f3SJohn Baldwindevice		aic
15367f5092f3SJohn Baldwinhint.aic.0.at="isa"
15377f5092f3SJohn Baldwindevice		ahb
1538d61e6649SAlexander Langerdevice		ahc
1539cdd49e97SJustin T. Gibbsdevice		ahd
15401b946e21SScott Longdevice		esp
1541c5933b20SScott Longdevice		iscsi_initiator
1542d61e6649SAlexander Langerdevice		isp
15430787f2b8SMatt Jacobhint.isp.0.disable="1"
15440787f2b8SMatt Jacobhint.isp.0.role="3"
15450787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15460787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15470787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15480787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15490787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15500787f2b8SMatt Jacobhint.isp.0.topology="lport"
15510787f2b8SMatt Jacobhint.isp.0.topology="nport"
15520787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15530787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15540787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15550787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15560787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15570787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1558d61e6649SAlexander Langerdevice		ispfw
155964fa5108SMatt Jacobdevice		mpt
1560d61e6649SAlexander Langerdevice		ncr
1561d61e6649SAlexander Langerdevice		sym
1562f3d92b26SOlivier Houcharddevice		trm
15636e818956SDavid E. O'Briendevice		wds
15646e818956SDavid E. O'Brienhint.wds.0.at="isa"
15656e818956SDavid E. O'Brienhint.wds.0.port="0x350"
15666e818956SDavid E. O'Brienhint.wds.0.irq="11"
15676e818956SDavid E. O'Brienhint.wds.0.drq="6"
1568d61e6649SAlexander Langer
1569d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1570d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1571d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1572d61e6649SAlexander Langer# default.
1573d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1574d61e6649SAlexander Langer
1575fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1576fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1577fac70739SJeroen Ruigrok van der Werven
1578fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1579fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1580fac70739SJeroen Ruigrok van der Werven
1581662d3818SScott Long# Compile in Aic7xxx Debugging code.
1582662d3818SScott Longoptions 	AHC_DEBUG
1583662d3818SScott Long
1584662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1585662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1586662d3818SScott Long
1587f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1588f8f8803bSBruce Evans# See ahc(4).
1589662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1590662d3818SScott Long
1591cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1592cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1593cdd49e97SJustin T. Gibbs
1594f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1595cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1596cdd49e97SJustin T. Gibbs
159743e9d8a3SScott Long# Print human-readable register definitions when debugging
159843e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
159943e9d8a3SScott Long
1600662d3818SScott Long# Bitmap of units to enable targetmode operations.
1601662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1602662d3818SScott Long
1603d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1604d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1605d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1606d61e6649SAlexander Langer
1607c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1608c5933b20SScott Long#
1609c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1610c5933b20SScott Long
1611d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1612d61e6649SAlexander Langer#
1613d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1614d61e6649SAlexander Langer#
161564fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1616af606348SMatt Jacob#
16179a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
16189a1b0d43SMatt Jacob#		none=0
16199a1b0d43SMatt Jacob#		target=1
16209a1b0d43SMatt Jacob#		initiator=2
16219a1b0d43SMatt Jacob#		both=3			(not supported currently)
1622af606348SMatt Jacob#
162315f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
162415f0f952SMatt Jacob#
1625e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1626d61e6649SAlexander Langer
1627d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1628d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1629d61e6649SAlexander Langer					# Allows the ncr to take precedence
1630d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1631d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1632d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1633d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1634d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1635d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1636d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1637d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1638d61e6649SAlexander Langer					# default:8, range:[1..64]
16396a8d6623SGarrett Wollman
16406e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16416e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16426e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16436e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16446e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16456e818956SDavid E. O'Brien#
16466e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16476e818956SDavid E. O'Brien#  DPT_MEASURE_PERFORMANCE  Enables a set of (semi)invasive metrics. Various
16486e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16496e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16506e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16516e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16526e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16536e818956SDavid E. O'Brien#			    are 100% certain you need it.
16546e818956SDavid E. O'Brien
16556e818956SDavid E. O'Briendevice		dpt
16566e818956SDavid E. O'Brien
16576e818956SDavid E. O'Brien# DPT options
16586e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16596e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16606e818956SDavid E. O'Brien
16616e818956SDavid E. O'Brien#
16626e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16636e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16646e818956SDavid E. O'Brien# CAM infrastructure.
16656e818956SDavid E. O'Brien#
16666e818956SDavid E. O'Briendevice		ciss
16676e818956SDavid E. O'Brien
16686e818956SDavid E. O'Brien#
16696e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16706e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16716e818956SDavid E. O'Brien# at Intel for this driver are
16726e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16736e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16746e818956SDavid E. O'Brien#
16756e818956SDavid E. O'Briendevice		iir
16766e818956SDavid E. O'Brien
16776e818956SDavid E. O'Brien#
16786e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16796e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16806e818956SDavid E. O'Brien# the CAM infrastructure.
16816e818956SDavid E. O'Brien#
16826e818956SDavid E. O'Briendevice		mly
16836e818956SDavid E. O'Brien
16846e818956SDavid E. O'Brien#
16856e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16866e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16876e818956SDavid E. O'Brien# controllers.
16886e818956SDavid E. O'Brien#
16896e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16906e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16916e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
169264c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16937f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1694f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16956b31d3f7SScott Longoptions 	MFI_DEBUG
1696a58b4afaSMark Johnstondevice		mrsas		# LSI/Avago MegaRAID SAS/SATA, 6Gb/s and 12Gb/s
16976e818956SDavid E. O'Brien
16986e818956SDavid E. O'Brien#
16996e818956SDavid E. O'Brien# 3ware ATA RAID
17006e818956SDavid E. O'Brien#
17016e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
17026e818956SDavid E. O'Brien
170390d3341eSPeter Wemm#
1704e19ef875SAlexander Motin# Serial ATA host controllers:
1705e19ef875SAlexander Motin#
1706e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1707dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1708e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
17091a00526bSAlexander Motin#
17101a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
17111a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1712e19ef875SAlexander Motin
1713e19ef875SAlexander Motindevice		ahci
1714dd48af36SAlexander Motindevice		mvs
1715e19ef875SAlexander Motindevice		siis
1716e19ef875SAlexander Motin
1717e19ef875SAlexander Motin#
171845f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
171945f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
17206d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1721c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1722c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1723c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1724c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1725c9953c3bSPeter Wemmdevice		ata
1726c4bda3c6SAlexander Motin
1727c4bda3c6SAlexander Motin# Modular ATA
1728c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1729c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1730c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1731c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1732c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1733c4bda3c6SAlexander Motin
1734c4bda3c6SAlexander Motin# PCI ATA chipsets
1735c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1736c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1737c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1738c4bda3c6SAlexander Motin#device		ataati		# ATI
1739c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1740c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1741c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1742c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1743c4bda3c6SAlexander Motin#device		ataintel	# Intel
1744c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1745c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1746c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1747c4bda3c6SAlexander Motin#device		atamicron	# Micron
1748c4bda3c6SAlexander Motin#device		atanational	# National
1749c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1750c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1751c4bda3c6SAlexander Motin#device		atapromise	# Promise
1752c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1753c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1754c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1755c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1756c4bda3c6SAlexander Motin
17578b89ef0aSSøren Schmidt#
17586d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17596d04301dSAlexander Langerhint.ata.0.at="isa"
17606d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17616d04301dSAlexander Langerhint.ata.0.irq="14"
17626d04301dSAlexander Langerhint.ata.1.at="isa"
17636d04301dSAlexander Langerhint.ata.1.port="0x170"
17646d04301dSAlexander Langerhint.ata.1.irq="15"
17656d04301dSAlexander Langer
17666d04301dSAlexander Langer#
1767000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1768000da71aSSøren Schmidt#
17696fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17706fb5300bSAlexander Motin#			before timing out.
177174d8e840SSøren Schmidt
17726fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
177374d8e840SSøren Schmidt
17748b89ef0aSSøren Schmidt#
17756d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17766d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17776a8d6623SGarrett Wollman#
1778f71c01ccSPeter Wemmdevice		fdc
1779f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1780f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1781f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1782f71c01ccSPeter Wemmhint.fdc.0.drq="2"
178385827d9cSJoerg Wunsch#
1784d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1785d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1786d2fb4892SJoerg Wunsch# however.
1787d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1788d2fb4892SJoerg Wunsch#
1789f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1790f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1791f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1792f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
179385827d9cSJoerg Wunsch
1794f71c01ccSPeter Wemm# Specify floppy devices
1795f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1796f71c01ccSPeter Wemmhint.fd.0.drive="0"
1797f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1798f71c01ccSPeter Wemmhint.fd.1.drive="1"
179985827d9cSJoerg Wunsch
18006a8d6623SGarrett Wollman#
1801501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1802501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1803c8956b36SMarcel Moolenaar#
1804501ef98fSMarcel Moolenaardevice		uart
1805501ef98fSMarcel Moolenaar
18068194412bSMarcel Moolenaar# Options for uart(4)
18078194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
18088194412bSMarcel Moolenaar					# instead of DCD.
18091662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
18101662b008SIan Lepore					# no interrupt support (50 Hz default).
18118194412bSMarcel Moolenaar
1812501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1813501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1814501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1815501ef98fSMarcel Moolenaar
1816c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1817c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1818c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1819c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1820c8956b36SMarcel Moolenaar# unit number of the probed UART.
1821501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1822501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1823501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1824501ef98fSMarcel Moolenaar
1825501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1826c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1827c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1828c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1829c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1830c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1831c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1832c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1833d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1834c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1835c8956b36SMarcel Moolenaar#		as debug port.
18369546766aSBruce Evans#
18379546766aSBruce Evans
1838501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
183991ed2fecSJohn-Mark Gurneyoptions 	BREAK_TO_DEBUGGER	# A BREAK/DBG on the console goes to
1840c8956b36SMarcel Moolenaar					# ddb, if available.
18416a8d6623SGarrett Wollman
184226b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
184326b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18449c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1845c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
184626b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
184726b6ea69SPaul Saab
1848af2e25a6SMarcel Moolenaar# Serial Communications Controller
1849af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1850af2e25a6SMarcel Moolenaar# communications controllers.
1851af2e25a6SMarcel Moolenaardevice		scc
1852af2e25a6SMarcel Moolenaar
18539c564b6cSJohn Hay# PCI Universal Communications driver
185464220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18559c564b6cSJohn Haydevice		puc
18569c564b6cSJohn Hay
18576a8d6623SGarrett Wollman#
1858d61e6649SAlexander Langer# Network interfaces:
18596a8d6623SGarrett Wollman#
1860dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1861d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18623c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18638c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
18648c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
18658c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18668c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18678c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
18688c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1869dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
18708c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
18718c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1872dfd77572SJohn Baldwin
1873dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1874dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1875dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1876dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1877dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1878dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1879dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1880dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1881dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1882dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1883dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1884dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1885dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1886dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1887dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1888dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1889dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1890dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1891dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1892e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1893dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1894dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1895dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1896dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1897dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1898dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1899dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1900dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1901d61e6649SAlexander Langer
19027f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
19037f5092f3SJohn Baldwin#       PCI and ISA varieties.
1904ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1905ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1906cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1907cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1908d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
19093c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1910390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1911343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1912343ed0a8SJohn Baldwin#       adapters.
1913343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
191495d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1915586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1916586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1917586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
19184e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1919dd46ab31SDavid Christensen#       adapters.
19203132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1921eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1922119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
19237f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19247f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
1925ca7fe84aSNavdeep Parhar# cxgb: Chelsio T3 based 1GbE/10GbE PCIe Ethernet adapters.
1926ca7fe84aSNavdeep Parhar# cxgbe:Chelsio T4 and T5 based 1GbE/10GbE/40GbE PCIe Ethernet adapters.
1927d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1928d61e6649SAlexander Langer#       and various workalikes including:
1929d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1930d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1931d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1932d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1933d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1934d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1935d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1936d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1937d61e6649SAlexander Langer#       KNE110TX.
1938d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1939a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
194096a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
19417f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19427f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19437f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19447f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19457f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19467f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1947d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1948d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1949cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19501ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
195152c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
195275a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
195344ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1954c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1955c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1956c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1957d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1958d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1959778eefa4SJohn Baldwin#	Requires the mwl firmware module
1960778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1961c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1962c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1963c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1964c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19652bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
196622f2c49aSHans Petter Selasky# mlx5:	Mellanox ConnectX-4 and ConnectX-4 LX IB and Eth shared code module.
196722f2c49aSHans Petter Selasky# mlx5en:Mellanox ConnectX-4 and ConnectX-4 LX PCIe Ethernet adapters.
1968d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1969ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1970ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1971ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1972cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1973cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
19742f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
197541f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19760fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19770fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19780fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19790fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19800fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1981390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19820587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1983d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1984d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1985d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1986d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1987d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1988d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1989d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1990d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1991d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1992d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1993d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1994d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1995d61e6649SAlexander Langer#       card which is 32-bit.
1996d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1997b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1998b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1999d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
2000d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
2001d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
2002d61e6649SAlexander Langer#       (also single mode and multimode).
2003d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
2004d61e6649SAlexander Langer#       attach each one as a separate network interface.
20057f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
20067f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
2007d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
2008d61e6649SAlexander Langer#       the D-Link DFE-550TX.
2009d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
2010d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
2011d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
2012d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
2013d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
2014c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2015c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2016d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2017d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2018d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2019d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2020d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20213c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2022362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2023d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2024d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2025e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2026e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20272608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2028d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2029d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2030d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2031d61e6649SAlexander Langer#       NE2000 clone.
20327f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20337f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20347f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20357f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20367f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20377f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2038d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2039d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2040d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2041d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2042d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2043d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2044d61e6649SAlexander Langer
20457f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20467f5092f3SJohn Baldwin
20477f5092f3SJohn Baldwindevice		cm
20487f5092f3SJohn Baldwinhint.cm.0.at="isa"
20497f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20507f5092f3SJohn Baldwinhint.cm.0.irq="9"
20517f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20527f5092f3SJohn Baldwindevice		ep
20537f5092f3SJohn Baldwindevice		ex
2054c06a3350SPeter Wemmdevice		fe
20557f5092f3SJohn Baldwinhint.fe.0.at="isa"
20567f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20577f5092f3SJohn Baldwindevice		fea
20587f5092f3SJohn Baldwindevice		sn
20597f5092f3SJohn Baldwinhint.sn.0.at="isa"
20607f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20617f5092f3SJohn Baldwinhint.sn.0.irq="10"
20627f5092f3SJohn Baldwindevice		an
20637f5092f3SJohn Baldwindevice		wi
20647f5092f3SJohn Baldwindevice		xe
20657f5092f3SJohn Baldwin
2066d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2067ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2068cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2069d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20703c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2071343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2072343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2073343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2074119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
20758090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
2076404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2077ca7fe84aSNavdeep Parhardevice		cxgbe		# Chelsio T4 and T5 1GbE/10GbE/40GbE
2078d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20794d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20804664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20814664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20821ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
208352c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20840587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2085343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
208622f2c49aSHans Petter Selaskydevice		mlx5		# Shared code module between IB and Ethernet
208722f2c49aSHans Petter Selaskydevice		mlx5en		# Mellanox ConnectX-4 and ConnectX-4 LX
20880587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2089d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2090343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
20910587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2092d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
20932e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2094d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2095d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2096d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2097343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2098d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
20990587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2100d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2101eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2102d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
21032608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2104d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2105d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2106d61e6649SAlexander Langer
2107d61e6649SAlexander Langer# PCI Ethernet NICs.
2108d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
210902f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
211002f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2111fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2112758cc3dcSJack F Vogeldevice		ix		# Intel Pro/10Gbe PCIE Ethernet
2113758cc3dcSJack F Vogeldevice		ixv		# Intel Pro/10Gbe PCIE Ethernet VF
211444ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2115f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2116fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
21172f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
21186e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
211995d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2120c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2121548d35fdSGeorge V. Neville-Neildevice		vxge		# Exar/Neterion XFrame 3100 10GbE
2122d61e6649SAlexander Langer
2123343ed0a8SJohn Baldwin# PCI FDDI NICs.
2124c06a3350SPeter Wemmdevice		fpa
2125d61e6649SAlexander Langer
21262bc6081cSScott Long# PCI WAN adapters.
21272bc6081cSScott Longdevice		lmc
21282bc6081cSScott Long
2129390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2130390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2131390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2132390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2133390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2134390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2135390cee87SJohn Baldwin#device		ath_rf2413
2136390cee87SJohn Baldwin#device		ath_rf2417
2137390cee87SJohn Baldwin#device		ath_rf2425
2138390cee87SJohn Baldwin#device		ath_rf5111
2139390cee87SJohn Baldwin#device		ath_rf5112
2140390cee87SJohn Baldwin#device		ath_rf5413
2141390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2142390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2143bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2144bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2145bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2146bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2147bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2148bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2149bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2150bc391cb2SWarner Losh# 4 are safe.
2151bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2152390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2153390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
215458c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2155390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2156390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2157eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2158d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2159d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2160778eefa4SJohn Baldwindevice		mwlfw
2161390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2162390cee87SJohn Baldwin
216310a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
216410a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
216598cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
216698cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
216710a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2168b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
216998cb733cSKenneth D. Merry
21702c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21712c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21722c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21732c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21742c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21752c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21762c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21772c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21782c8f5a28SKenneth D. Merry
217968713f97SKenjiro Cho#
218044b5247dSKenjiro Cho# ATM related options (Cranor version)
218144b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
218268713f97SKenjiro Cho#
218368713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
218468713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
218568713f97SKenjiro Cho#
2186c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2187c594298bSHartmut Brandt# ATM PCI cards.
2188c594298bSHartmut Brandt#
2189fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2190fb24f088SHartmut Brandt#
21918dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
21928dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
21938dd4275cSHartmut Brandt#
2194f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
219568713f97SKenjiro Cho# atm devices.
21963cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
219768713f97SKenjiro Cho# bypass TCP/IP.
219868713f97SKenjiro Cho#
2199fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2200fb24f088SHartmut Brandt# hatm and fatm.
22011ba46a03SHartmut Brandt#
220268713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
220368713f97SKenjiro Cho# for more details, please read the original documents at
220498a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
220568713f97SKenjiro Cho#
2206f71c01ccSPeter Wemmdevice		atm
220744b5247dSKenjiro Chodevice		en
2208fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2209c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
22108dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
22111ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
22128c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2213f4567b9cSJulian Elischer
22147e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
22157e9024cdSHartmut Brandt
2216c19da41eSPeter Wemm#
22170739ea1dSSeigo Tanimura# Sound drivers
2218c19da41eSPeter Wemm#
22190739ea1dSSeigo Tanimura# sound: The generic sound driver.
2220c7406082SJohn-Mark Gurney#
22210739ea1dSSeigo Tanimura
22220739ea1dSSeigo Tanimuradevice		sound
22230739ea1dSSeigo Tanimura
22240739ea1dSSeigo Tanimura#
22250739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2226c7406082SJohn-Mark Gurney#
22279c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22287f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22297f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22307f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22317f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22327f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22337f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22347f5092f3SJohn Baldwin#
2235c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22360739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2237d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2238903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2239903b2fb9SJoel Dahl#			for sparc64.
22400739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22410739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22420739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22430739ea1dSSeigo Tanimura#			4281)
22440739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22450739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22460fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22479f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22489f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22490739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2250727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2251727ded3aSJoel Dahl#			conjunction with snd_sbc.
22520739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22530739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22544b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22554b8939a1SAriff Abdullah#			compatible.
2256e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
225717470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2258903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2259903b2fb9SJoel Dahl#			nForce controllers.
22600739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22610739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22620739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22630739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22640739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22651c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22660739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22671c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22680739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22697f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22700739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2271de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2272903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22730739ea1dSSeigo Tanimura#			M5451 PCI.
2274de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22750739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22760739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22770739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
227881bb901eSPeter Wemm
2279f37a929cSPeter Wemmdevice		snd_ad1816
2280f37a929cSPeter Wemmdevice		snd_als4000
2281d9bde1adSAriff Abdullahdevice		snd_atiixp
22827a7386a3SPyun YongHyeon#device		snd_audiocs
22830739ea1dSSeigo Tanimuradevice		snd_cmi
2284f37a929cSPeter Wemmdevice		snd_cs4281
22850739ea1dSSeigo Tanimuradevice		snd_csa
2286f37a929cSPeter Wemmdevice		snd_ds1
2287f37a929cSPeter Wemmdevice		snd_emu10k1
22880fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2289b1ff0220SAlexander Leidingerdevice		snd_envy24
22909f548240SAlexander Leidingerdevice		snd_envy24ht
2291f37a929cSPeter Wemmdevice		snd_es137x
22920739ea1dSSeigo Tanimuradevice		snd_ess
2293f37a929cSPeter Wemmdevice		snd_fm801
22940739ea1dSSeigo Tanimuradevice		snd_gusc
22954b8939a1SAriff Abdullahdevice		snd_hda
2296e4afd792SAlexander Motindevice		snd_hdspe
22970739ea1dSSeigo Tanimuradevice		snd_ich
22980739ea1dSSeigo Tanimuradevice		snd_maestro
2299f37a929cSPeter Wemmdevice		snd_maestro3
23000739ea1dSSeigo Tanimuradevice		snd_mss
23010739ea1dSSeigo Tanimuradevice		snd_neomagic
2302f37a929cSPeter Wemmdevice		snd_sb16
2303f37a929cSPeter Wemmdevice		snd_sb8
23040739ea1dSSeigo Tanimuradevice		snd_sbc
23050739ea1dSSeigo Tanimuradevice		snd_solo
23069f548240SAlexander Leidingerdevice		snd_spicds
2307f37a929cSPeter Wemmdevice		snd_t4dwave
2308de8d750fSJoel Dahldevice		snd_uaudio
2309f37a929cSPeter Wemmdevice		snd_via8233
2310f37a929cSPeter Wemmdevice		snd_via82c686
23110739ea1dSSeigo Tanimuradevice		snd_vibes
2312c19da41eSPeter Wemm
23131c9c6382SRuslan Ermilov# For non-PnP sound cards:
2314673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2315673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2316673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2317673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2318673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2319673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2320673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2321673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2322673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2323673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2324673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2325673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2326673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2327673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23287f5092f3SJohn Baldwin
23296a8d6623SGarrett Wollman#
233018fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
233118fe4678SAriff Abdullah#
233218fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
233318fe4678SAriff Abdullah#                              sanity checking and possible increase of
233418fe4678SAriff Abdullah#                              verbosity.
233518fe4678SAriff Abdullah#
2336d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
233718fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
233818fe4678SAriff Abdullah#
233918fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
234018fe4678SAriff Abdullah#                              in. This options enable most feeder converters
234118fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
234218fe4678SAriff Abdullah#
234318fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
234418fe4678SAriff Abdullah#
234518fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
234618fe4678SAriff Abdullah#                              as much as possible (the default trying to
234718fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
234818fe4678SAriff Abdullah#
234918fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
235018fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
235118fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
235218fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
235318fe4678SAriff Abdullah#
235418fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
235518fe4678SAriff Abdullah#                              disabling multichannel processing.
235618fe4678SAriff Abdullah#
235718fe4678SAriff Abdullahoptions		SND_DEBUG
235818fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
235918fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
236018fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
236118fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
236218fe4678SAriff Abdullahoptions		SND_PCM_64
236318fe4678SAriff Abdullahoptions		SND_OLDSTEREO
236418fe4678SAriff Abdullah
236518fe4678SAriff Abdullah#
2366567e21c2SBruce Evans# Miscellaneous hardware:
23676a8d6623SGarrett Wollman#
23686fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
23693ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
23701c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23717f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2372603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2373657e73c4SPeter Dufault
23743ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
23753ae5b532SMatthew N. Dodddevice		mcd
23763ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
23773ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
23786fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
23796fe8789dSMatthew N. Dodddevice		scd
23806fe8789dSMatthew N. Doddhint.scd.0.at="isa"
23816fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
23821c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23837f5092f3SJohn Baldwinhint.joy.0.at="isa"
23847f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2385603d67aeSRink Springerdevice		cmx
2386a800f455SJulian Elischer
2387eeb706c0SJustin T. Gibbs#
2388a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23891c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2390a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
23911c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
23921c2b5939SRoger Hardiman#
2393a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2394a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2395a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2396a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
23971c2b5939SRoger Hardiman# These options can be used to override the auto detection
239898a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
23991c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
24009ff07e32SAmancio Hasty#
24014f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
24021c2b5939SRoger Hardiman# or
24031c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
24043c7c6c12SMike Pritchard# Specifies the default video capture mode.
24051748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2406d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2407a9c5b8d0SSøren Schmidt#
24084f5f3f07SBrian Somers# options 	BKTR_USE_PLL
24091748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2410a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2411a9c5b8d0SSøren Schmidt#
24121c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24139c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24141c2b5939SRoger Hardiman#
24151c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2416d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
24171c2b5939SRoger Hardiman#
24181c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24191c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24201c2b5939SRoger Hardiman#
24211c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24221c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24231c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24241c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24251c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24261c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24271c2b5939SRoger Hardiman#
242830e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
242930e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
243030e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
243130e27d96SAlexander Langer# mono sound.
2432017b0edcSMatt Jacob
2433c17d4340SNicolas Souchu#
2434c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2435c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2436c17d4340SNicolas Souchu#
243728ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24380f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
243937973e86SPeter Wemm#     device smbus
244037973e86SPeter Wemm#     device iicbus
244137973e86SPeter Wemm#     device iicbb
2442c17d4340SNicolas Souchu#     device iicsmb
24430f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24440f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
244528ebb692SNicolas Souchu#
2446c06a3350SPeter Wemmdevice		bktr
2447446cee6eSJoerg Wunsch
2448dc9deb29SPoul-Henning Kamp#
24496e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24506e818956SDavid E. O'Brien#
24515bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24526e818956SDavid E. O'Brien# pccard: pccard slots
24536e818956SDavid E. O'Brien# cardbus: cardbus slots
24546e818956SDavid E. O'Briendevice		cbb
24556e818956SDavid E. O'Briendevice		pccard
24566e818956SDavid E. O'Briendevice		cardbus
24576e818956SDavid E. O'Brien
24586e818956SDavid E. O'Brien#
24595bcb64f2SWarner Losh# MMC/SD
24605bcb64f2SWarner Losh#
2461831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2462831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2463831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2464831f5dcfSAlexander Motin#
2465831f5dcfSAlexander Motindevice		mmc
2466831f5dcfSAlexander Motindevice		mmcsd
2467831f5dcfSAlexander Motindevice		sdhci
24685bcb64f2SWarner Losh
24695bcb64f2SWarner Losh#
24708afa373cSNicolas Souchu# SMB bus
24718afa373cSNicolas Souchu#
24723c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24733c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24743c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24758afa373cSNicolas Souchu#
24768afa373cSNicolas Souchu# Supported devices:
24774d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24788afa373cSNicolas Souchu#
24793c5656bfSArchie Cobbs# Supported SMB interfaces:
248028ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
248128ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24827f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24837f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24847f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24857f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2486b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24874d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
248844e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24894d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
24900572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
24918afa373cSNicolas Souchu#
2492c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
24933c5656bfSArchie Cobbs
24947f5092f3SJohn Baldwindevice		intpm
24957f5092f3SJohn Baldwindevice		alpm
24967f5092f3SJohn Baldwindevice		ichsmb
24977f5092f3SJohn Baldwindevice		viapm
249844e6ce01SNicolas Souchudevice		amdpm
24994d5f30e0SRuslan Ermilovdevice		amdsmb
250044e6ce01SNicolas Souchudevice		nfpm
25014d5f30e0SRuslan Ermilovdevice		nfsmb
25020572ccaaSJim Harrisdevice		ismt
25037f5092f3SJohn Baldwin
2504c9953c3bSPeter Wemmdevice		smb
25058afa373cSNicolas Souchu
25068afa373cSNicolas Souchu#
25078afa373cSNicolas Souchu# I2C Bus
25088afa373cSNicolas Souchu#
25098afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
25108afa373cSNicolas Souchu#
25118afa373cSNicolas Souchu# Supported devices:
25128afa373cSNicolas Souchu# ic	i2c network interface
25138afa373cSNicolas Souchu# iic	i2c standard io
2514f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25151ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
25168afa373cSNicolas Souchu#
25178afa373cSNicolas Souchu# Supported interfaces:
251828ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
251928ebb692SNicolas Souchu#
252028ebb692SNicolas Souchu# Other:
252128ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25228afa373cSNicolas Souchu#
2523c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2524c9953c3bSPeter Wemmdevice		iicbb
25258afa373cSNicolas Souchu
2526c9953c3bSPeter Wemmdevice		ic
2527c9953c3bSPeter Wemmdevice		iic
2528c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25291ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
25308afa373cSNicolas Souchu
2531286fa445SRafal Jaworowski# I2C peripheral devices
2532286fa445SRafal Jaworowski#
2533286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
25341513a6ffSJayachandran C.# ds1374	Dallas Semiconductor DS1374 RTC
2535286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2536f8e8af9cSHiroki Sato# s35390a	Seiko Instruments S-35390A RTC
2537286fa445SRafal Jaworowski#
2538286fa445SRafal Jaworowskidevice		ds133x
25391513a6ffSJayachandran C.device		ds1374
2540286fa445SRafal Jaworowskidevice		ds1672
2541f8e8af9cSHiroki Satodevice		s35390a
2542286fa445SRafal Jaworowski
2543ab4c624bSMike Smith# Parallel-Port Bus
2544ab4c624bSMike Smith#
2545ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2546ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2547ab4c624bSMike Smith# are automatically probed and attached when found.
2548ab4c624bSMike Smith#
2549ab4c624bSMike Smith# Supported devices:
2550ab4c624bSMike Smith# vpo	Iomega Zip Drive
2551f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2552f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2553fdf94d1aSNicolas Souchu# lpt	Parallel Printer
255446f3ff79SMike Smith# plip	Parallel network interface
2555fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2556f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
255728ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25581caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2559ab4c624bSMike Smith#
2560ab4c624bSMike Smith# Supported interfaces:
2561ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2562ab4c624bSMike Smith#
2563ef8f7626SNicolas Souchu
25640f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25650f210c92SNicolas Souchu				  # (see flags in ppc(4))
25665895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25679d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2568ef8f7626SNicolas Souchu				# compliant peripheral
25695895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25705895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25715895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25725895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25735895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25743b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25753b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2576ef8f7626SNicolas Souchu
2577f71c01ccSPeter Wemmdevice		ppc
2578f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2579f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25800d31b179SPeter Wemmdevice		ppbus
25810d31b179SPeter Wemmdevice		vpo
25820d31b179SPeter Wemmdevice		lpt
25830d31b179SPeter Wemmdevice		plip
25840d31b179SPeter Wemmdevice		ppi
25850d31b179SPeter Wemmdevice		pps
25860d31b179SPeter Wemmdevice		lpbb
25870d31b179SPeter Wemmdevice		pcfclock
2588ab4c624bSMike Smith
25890ac40133SBrian Somers# Kernel BOOTP support
25900ac40133SBrian Somers
25910ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2592c15882f0SRick Macklem				# Requires NFSCL and NFS_ROOT
25930ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
25940ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
25950ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
25960ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2597eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2598432aad0eSTor Egge
2599d94f38acSEivind Eklund#
26004103b765SPoul-Henning Kamp# Add software watchdog routines.
2601370c3cb5SSean Kelly#
26024103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2603370c3cb5SSean Kelly
2604370c3cb5SSean Kelly#
2605f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2606f7829d0dSAttilio Rao#
2607f7829d0dSAttilio Raooptions 	DEADLKRES
2608f7829d0dSAttilio Rao
2609f7829d0dSAttilio Rao#
2610b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
26114e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
26124e0ee531SMike Barcroft# it back on at run-time.
2613c796cfa1SAndrzej Bialecki#
2614c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2615c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2616c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2617c796cfa1SAndrzej Bialecki#
261819dde963SPeter Wemm#options 	NO_SWAPPING
2619c796cfa1SAndrzej Bialecki
26209dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26219dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26229dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26239dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26249dab0776SDavid Greenman#
26255895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26269dab0776SDavid Greenman
262715a1057cSEivind Eklund#
2628053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26299c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2630053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
26312c048c4aSBryan Drewery# not at all useful unless you are debugging lock code.  Note that
26322c048c4aSBryan Drewery# modules should be recompiled as this option modifies KBI.
263315a1057cSEivind Eklund#
263415a1057cSEivind Eklundoptions 	DEBUG_LOCKS
263515a1057cSEivind Eklund
263626086a03SPeter Wemm
263726086a03SPeter Wemm#####################################################################
26381d33cf3dSNick Hibma# USB support
26391d33cf3dSNick Hibma# UHCI controller
2640c9953c3bSPeter Wemmdevice		uhci
26411d33cf3dSNick Hibma# OHCI controller
2642c9953c3bSPeter Wemmdevice		ohci
2643ca3acad1SBernd Walter# EHCI controller
2644ca3acad1SBernd Walterdevice		ehci
2645857508a3SAndrew Thompson# XHCI controller
2646857508a3SAndrew Thompsondevice		xhci
264739e5901eSTakanori Watanabe# SL811 Controller
2648b92755d1SAndrew Thompson#device		slhci
26491d33cf3dSNick Hibma# General USB code (mandatory for USB)
2650c9953c3bSPeter Wemmdevice		usb
26511d33cf3dSNick Hibma#
2652b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2653b5ea1f0cSNick Hibmadevice		udbp
2654d1233ab3SBruce Evans# USB Fm Radio
2655d1233ab3SBruce Evansdevice		ufm
26562d45d793SHans Petter Selasky# USB temperature meter
26572d45d793SHans Petter Selaskydevice		ugold
26586bd03b20SKevin Lo# USB LED
26596bd03b20SKevin Lodevice		uled
2660f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2661c9953c3bSPeter Wemmdevice		uhid
26621d33cf3dSNick Hibma# USB keyboard
2663c9953c3bSPeter Wemmdevice		ukbd
26641d33cf3dSNick Hibma# USB printer
2665c9953c3bSPeter Wemmdevice		ulpt
266631615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2667c9953c3bSPeter Wemmdevice		umass
266831615ef7SRebecca Cran# USB mass storage driver for device-side mode
266931615ef7SRebecca Crandevice		usfs
2670ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2671ce17576aSScott Longdevice		umct
2672e9fb12d3SNick Hibma# USB modem support
2673e9fb12d3SNick Hibmadevice		umodem
2674f26c33d2SNick Hibma# USB mouse
2675c9953c3bSPeter Wemmdevice		ums
2676eed447b5SHans Petter Selasky# USB touchpad(s)
2677eed447b5SHans Petter Selaskydevice		atp
2678eed447b5SHans Petter Selaskydevice		wsp
2679f25a8a01SGleb Smirnoff# eGalax USB touch screen
2680f25a8a01SGleb Smirnoffdevice		uep
26811c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2682e2dbd15fSNick Hibmadevice		urio
2683d1233ab3SBruce Evans#
2684916e6e02SJosef Karthauser# USB serial support
2685916e6e02SJosef Karthauserdevice		ucom
2686fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2687483b9e47SNick Hibmadevice		u3g
26889aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
26899aab0d96SMaxim Konovalovdevice		uark
2690d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2691d1233ab3SBruce Evansdevice		ubsa
269248b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
269348b68edfSJosef Karthauserdevice		uftdi
2694c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2695c5286e11STakanori Watanabedevice		uipaq
269648b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2697916e6e02SJosef Karthauserdevice		uplcom
26982e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
26992e7328e7SRink Springerdevice		uslcom
270048b68edfSJosef Karthauser# USB Visor and Palm devices
270148b68edfSJosef Karthauserdevice		uvisor
2702d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2703d1233ab3SBruce Evansdevice		uvscom
2704f26c33d2SNick Hibma#
2705ff6b30b9SKevin Lo# USB ethernet support
2706ff6b30b9SKevin Lodevice		uether
2707ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2708d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2709d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2710d04bb221SBill Paul# eval board.
2711c9953c3bSPeter Wemmdevice		aue
2712bf029145SRobert Watson
2713bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2714bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2715bf029145SRobert Watsondevice		axe
271679eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
271779eb99dfSLi-Wen Hsudevice		axge
2718bf029145SRobert Watson
2719dfd1e98eSBill Paul#
27206bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
27216bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
27226bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
27236bcf0032SMaxim Sobolevdevice		cdce
27246bcf0032SMaxim Sobolev#
272501779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
272601779872SBill Paul# and Netmate II, and the Belkin F5U111.
2727c9953c3bSPeter Wemmdevice		cue
272801779872SBill Paul#
2729dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2730d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2731d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
273201779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
273301779872SBill Paul# and 2104USB, and the Corega USB-T.
2734c9953c3bSPeter Wemmdevice		kue
273511e04b05SShunsuke Akiyama#
273611e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
273711e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
273811e04b05SShunsuke Akiyamadevice		rue
2739cdd40f3bSMIHIRA Sanpei Yoshiro#
2740cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2741cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2742941e2863SAndrew Thompson#
2743*e1b74f21SKevin Lo# RealTek RTL8152 USB to fast ethernet.
2744*e1b74f21SKevin Lodevice		ure
2745*e1b74f21SKevin Lo#
274622445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
274722445463SKevin Lodevice		mos
274822445463SKevin Lo#
2749941e2863SAndrew Thompson# HSxPA devices from Option N.V
2750941e2863SAndrew Thompsondevice		uhso
2751cdd40f3bSMIHIRA Sanpei Yoshiro
275231d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
275331d98677SRui Paulodevice		rsu
27548a4cd00aSWarner Losh#
275571aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
275671aa1d32SSam Lefflerdevice		rum
275793393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
275893393dfdSAndrew Thompsondevice		run
27598a4cd00aSWarner Losh#
276071aa1d32SSam Leffler# Atheros AR5523 wireless driver
276171aa1d32SSam Lefflerdevice		uath
276271aa1d32SSam Leffler#
2763d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2764d1f25d5dSBernhard Schmidtdevice		upgt
2765d1f25d5dSBernhard Schmidt#
276671aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27678a4cd00aSWarner Loshdevice		ural
27688a4cd00aSWarner Losh#
276929311227SHans Petter Selasky# RNDIS USB ethernet driver
277029311227SHans Petter Selaskydevice		urndis
27715aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27725aaea652SKevin Lodevice		urtw
27735aaea652SKevin Lo#
2774c2c2fc4dSRui Paulo# Realtek RTL8188CU/RTL8192CU wireless driver
2775c2c2fc4dSRui Paulodevice		urtwn
2776c2c2fc4dSRui Paulo#
277771aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
277871aa1d32SSam Lefflerdevice		zyd
277945b395cdSGleb Smirnoff#
278045b395cdSGleb Smirnoff# Sierra USB wireless driver
278145b395cdSGleb Smirnoffdevice		usie
2782f26c33d2SNick Hibma
27838a4cd00aSWarner Losh#
2784f26c33d2SNick Hibma# debugging options for the USB subsystem
27851d33cf3dSNick Hibma#
27861d33cf3dSNick Hibmaoptions 	USB_DEBUG
2787fe75118bSNick Hibmaoptions 	U3G_DEBUG
2788f26c33d2SNick Hibma
27896e8394b8SKazutaka YOKOTA# options for ukbd:
27906e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
279191b050b2SPoul-Henning Kampmakeoptions	UKBD_DFLT_KEYMAP=jp.pc98
27926e8394b8SKazutaka YOKOTA
2793565f53bbSShunsuke Akiyama# options for uplcom:
27943c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2795565f53bbSShunsuke Akiyama						# in milliseconds
2796565f53bbSShunsuke Akiyama
279720280807SShunsuke Akiyama# options for uvscom:
279820280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
27993c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2800565f53bbSShunsuke Akiyama						# in milliseconds
280120280807SShunsuke Akiyama
28028b7ce2ffSSam Leffler#####################################################################
2803869093b1SHidetoshi Shimokawa# FireWire support
28047d2ba89bSJohn Baldwin
2805869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
28067d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
280779acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2808869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
28091c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2810869093b1SHidetoshi Shimokawa
2811869093b1SHidetoshi Shimokawa#####################################################################
2812869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2813869093b1SHidetoshi Shimokawa
2814869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2815869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2816869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2817869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2818869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2819869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
28207d2ba89bSJohn Baldwin
28217d2ba89bSJohn Baldwin#####################################################################
28228b7ce2ffSSam Leffler# crypto subsystem
28238b7ce2ffSSam Leffler#
28241c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2825b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
28261c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
28278b7ce2ffSSam Leffler#
28281c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28291c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28308b7ce2ffSSam Leffler
28318b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
2832b65946c6SJohn-Mark Gurney
2833b65946c6SJohn-Mark Gurney# Only install the cryptodev device if you are running tests, or know
2834e0b231cbSJohn-Mark Gurney# specifically why you need it.  In most cases, it is not needed and
2835e0b231cbSJohn-Mark Gurney# will make things slower.
28368b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28378b7ce2ffSSam Leffler
2838ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28398b7ce2ffSSam Leffler
2840b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2841b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2842b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2843b7c4858fSSam Leffler
2844b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2845b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2846b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2847b7c4858fSSam Leffler
28488b7ce2ffSSam Leffler#####################################################################
28498b7ce2ffSSam Leffler
28508b7ce2ffSSam Leffler
2851785d2100SJohn Birrell#
2852785d2100SJohn Birrell# Embedded system options:
2853785d2100SJohn Birrell#
2854785d2100SJohn Birrell# An embedded system might want to run something other than init.
28550fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2856bc0e3a03SJeroen Ruigrok van der Werven
2857bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2858bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28591c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2860395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
286141c1a233SGleb Smirnoffoptions 	IFMEDIA_DEBUG	# enable debugging in net/if_media.c
2862bc0e3a03SJeroen Ruigrok van der Werven
2863e2c1a4e9SBenno Rice#
2864e2c1a4e9SBenno Rice# Verbose SYSINIT
2865e2c1a4e9SBenno Rice#
2866e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2867e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2868e2c1a4e9SBenno Rice# will print function names instead of addresses.
2869e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2870e2c1a4e9SBenno Rice
2871446af86dSJohn Baldwin#####################################################################
2872446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2873446af86dSJohn Baldwin#
2874446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2875446af86dSJohn Baldwin# one time.
2876446af86dSJohn Baldwinoptions 	SEMMNI=11
2877446af86dSJohn Baldwin
2878446af86dSJohn Baldwin# Total number of semaphores system wide
2879446af86dSJohn Baldwinoptions 	SEMMNS=61
2880446af86dSJohn Baldwin
2881446af86dSJohn Baldwin# Total number of undo structures in system
2882446af86dSJohn Baldwinoptions 	SEMMNU=31
2883446af86dSJohn Baldwin
2884446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2885446af86dSJohn Baldwin# at one time.
2886446af86dSJohn Baldwinoptions 	SEMMSL=61
2887446af86dSJohn Baldwin
2888446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2889446af86dSJohn Baldwin# semaphore at one time.
2890446af86dSJohn Baldwinoptions 	SEMOPM=101
2891446af86dSJohn Baldwin
2892446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2893446af86dSJohn Baldwin# System V semaphore at one time.
2894446af86dSJohn Baldwinoptions 	SEMUME=11
2895446af86dSJohn Baldwin
2896446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2897446af86dSJohn Baldwinoptions 	SHMALL=1025
2898446af86dSJohn Baldwin
2899446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
290025388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2901446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2902446af86dSJohn Baldwin
2903446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2904446af86dSJohn Baldwinoptions 	SHMMIN=2
2905446af86dSJohn Baldwin
2906446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2907446af86dSJohn Baldwin# at one time.
2908446af86dSJohn Baldwinoptions 	SHMMNI=33
2909446af86dSJohn Baldwin
2910446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2911446af86dSJohn Baldwin# a single process at one time.
2912446af86dSJohn Baldwinoptions 	SHMSEG=9
2913446af86dSJohn Baldwin
2914d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2915d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2916d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2917d9282887SDima Dorfman# console.
2918d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2919d9282887SDima Dorfman
29205bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
29215bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
29225bbb8060STor Egge# file.  Both offset and length of the read operation must be
29235bbb8060STor Egge# multiples of the physical media sector size.
29245bbb8060STor Egge#
2925995356dcSDag-Erling Smørgravoptions 	DIRECTIO
29265bbb8060STor Egge
29275bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
29285bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29295bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29305bbb8060STor Egge#
2931995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29325bbb8060STor Egge
2933446af86dSJohn Baldwin#####################################################################
2934446af86dSJohn Baldwin
2935bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29369c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2937bc0e3a03SJeroen Ruigrok van der Werven
2938bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
293928d7984fSJeroen Ruigrok van der Werven
294028d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2941bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
294228d7984fSJeroen Ruigrok van der Werven
2943bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29448b6f5e65SJeroen Ruigrok van der Werven
294528d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2946bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
294728d7984fSJeroen Ruigrok van der Werven
29488b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29498b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29508b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29518b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29528b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29538b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29548b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29558b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29568b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29578b6f5e65SJeroen Ruigrok van der Werven
29588b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29598b6f5e65SJeroen Ruigrok van der Werven
2960bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2961bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2962bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2963bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29648b6f5e65SJeroen Ruigrok van der Werven
29658b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29668b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29678b6f5e65SJeroen Ruigrok van der Werven
29688b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29698b6f5e65SJeroen Ruigrok van der Werven
2970316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2971b7627840SKonstantin Belousovoptions 	KSTACK_USAGE_PROF
2972316ec49aSScott Long
2973662d3818SScott Long# Adaptec Array Controller driver options
2974662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2975662d3818SScott Long				# 0 - quiet, only emit warnings
2976662d3818SScott Long				# 1 - noisy, emit major function
2977662d3818SScott Long				#     points and things done
2978662d3818SScott Long				# 2 - extremely noisy, emit trace
2979662d3818SScott Long				#     items in loops, etc.
2980662d3818SScott Long
2981097055e2SEdward Tomasz Napierala# Resource Accounting
2982097055e2SEdward Tomasz Napieralaoptions 	RACCT
2983097055e2SEdward Tomasz Napierala
2984ec125fbbSEdward Tomasz Napierala# Resource Limits
2985ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2986ec125fbbSEdward Tomasz Napierala
29871e9ea774SBruce Evans# Yet more undocumented options for linting.
29881e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29891e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29901e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
299125388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
299225388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29931e9ea774SBruce Evansoptions 	MAXFILES=999
2994efba048eSXin LI
2995997b0a64SDag-Erling Smørgrav# Random number generator
299610cb2424SMark Murray# Only ONE of the below two may be used; they are mutually exclusive.
2997646041a8SMark Murray# If neither is present, then the Fortuna algorithm is selected.
2998646041a8SMark Murray#options 	RANDOM_YARROW	# Yarrow CSPRNG (old default)
2999646041a8SMark Murray#options 	RANDOM_LOADABLE	# Allow the algorithm to be loaded as
3000646041a8SMark Murray				# a module.
3001e866d8f0SMark Murray# Select this to allow high-rate but potentially expensive
3002e866d8f0SMark Murray# harvesting of Slab-Allocator entropy. In very high-rate
3003e866d8f0SMark Murray# situations the value of doing this is dubious at best.
3004e866d8f0SMark Murrayoptions 	RANDOM_ENABLE_UMA	# slab allocator
300581e3caafSJustin Hibbits
300681e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
300781e3caafSJustin Hibbitsoptions         IMAGACT_BINMISC
3008aa14e9b7SMark Johnston
300923c9098bSSean Bruno# Intel em(4) driver
301023c9098bSSean Brunooptions		EM_MULTIQUEUE # Activate multiqueue features/disable MSI-X
301123c9098bSSean Bruno
3012aa14e9b7SMark Johnston# zlib I/O stream support
3013aa14e9b7SMark Johnston# This enables support for compressed core dumps.
3014aa14e9b7SMark Johnstonoptions 	GZIO
3015