xref: /freebsd/sys/conf/NOTES (revision fcdb1ffc497c96f7718c43e9c1716a0ead39275a)
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
159*fcdb1ffcSAndrey 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
180*fcdb1ffcSAndrey 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
3626a8d6623SGarrett Wollman#
3636a8d6623SGarrett Wollman# These three options provide support for System V Interface
3646a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3656a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3666a8d6623SGarrett Wollman#
3676a8d6623SGarrett Wollmanoptions 	SYSVSHM
3686a8d6623SGarrett Wollmanoptions 	SYSVSEM
3696a8d6623SGarrett Wollmanoptions 	SYSVMSG
3706a8d6623SGarrett Wollman
3716a8d6623SGarrett Wollman
3726a8d6623SGarrett Wollman#####################################################################
3736a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3746a8d6623SGarrett Wollman
3756a8d6623SGarrett Wollman#
376e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3776a8d6623SGarrett Wollman#
378e2ee2173SMarcel Moolenaaroptions 	KDB
379b5d89ca8SBruce Evans
380b5d89ca8SBruce Evans#
381e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3827085e708SBruce Evans#
383e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
384e2ee2173SMarcel Moolenaar
385e2ee2173SMarcel Moolenaar#
386e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
387e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
388e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
389e2ee2173SMarcel Moolenaar#
390e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
391e2ee2173SMarcel Moolenaar
392e2ee2173SMarcel Moolenaar#
393e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
394e2ee2173SMarcel Moolenaar#
395e2ee2173SMarcel Moolenaaroptions 	DDB
3967085e708SBruce Evans
3977085e708SBruce Evans#
398bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
399bfdd261eSBruce Evans# representation.
400bfdd261eSBruce Evans#
401bfdd261eSBruce Evansoptions 	DDB_NUMSYM
402bfdd261eSBruce Evans
403bfdd261eSBruce Evans#
404e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
4050be15decSJohn Baldwin#
406e2ee2173SMarcel Moolenaaroptions 	GDB
407562d05dfSPaul Traina
408562d05dfSPaul Traina#
409df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
410df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4111c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
412df970488SRobert Watson# interfere with serial console operation.
413df970488SRobert Watson#
414df970488SRobert Watsonoptions 	SYSCTL_DEBUG
415df970488SRobert Watson
416df970488SRobert Watson#
41721d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
41821d748a9SAlfred Perlstein#
41921d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
42021d748a9SAlfred Perlstein
42121d748a9SAlfred Perlstein#
42221d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
42321d748a9SAlfred Perlstein#
42421d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
42521d748a9SAlfred Perlstein
42621d748a9SAlfred Perlstein#
42731615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
42831615ef7SRebecca Cran# resulting kernel.
42931615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
43031615ef7SRebecca Cran
43131615ef7SRebecca Cran#
432d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
433d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
434d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
435d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
436d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
437d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
438d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
439d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
440d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
441d7854da1SMatthew D Fleming# code.
442d7854da1SMatthew D Fleming#
443d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
444d7854da1SMatthew D Fleming
445d7854da1SMatthew D Fleming#
446e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
447e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
448e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
449e4eb384bSBosko Milekic#
450e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
451e4eb384bSBosko Milekic
452e4eb384bSBosko Milekic#
453847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
454847a2a17SPawel Jakub Dawidek# malloc(9).
455847a2a17SPawel Jakub Dawidek#
456847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
457847a2a17SPawel Jakub Dawidek
458847a2a17SPawel Jakub Dawidek#
459e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
460e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
461e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
462e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
463e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
464e79f350dSWarner Losh#
465e79f350dSWarner Losh#options	EARLY_PRINTF
466e79f350dSWarner Losh
467e79f350dSWarner Losh#
468ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
469ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
470ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
471ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
472ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
473ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
474ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4756a8d6623SGarrett Wollman#
4762365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
477ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
47821c64a07SAndrey A. Chernov
4796a8d6623SGarrett Wollman#
480f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
481a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
4826e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
48336b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
48436b7dde4SAndriy Gapon# before malloc(9) is functional.
485a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
486a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
487a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
488a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
489e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
490d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
491d4a2ab8cSAttilio Rao# separated by the "," character (ie:
492d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
493a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
494a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
495f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
496c508c1b6SJohn Baldwin#
497c508c1b6SJohn Baldwinoptions 	KTR
49836b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
49936b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
5006740ed37SGleb Smirnoffoptions 	KTR_COMPILE=(KTR_ALL)
501a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
502d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
503d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
504c508c1b6SJohn Baldwin
505c508c1b6SJohn Baldwin#
5061c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
507f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
508453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
509453ffeefSRobert Watson# in a worker thread.
510453ffeefSRobert Watson#
511453ffeefSRobert Watsonoptions 	ALQ
512453ffeefSRobert Watsonoptions 	KTR_ALQ
513453ffeefSRobert Watson
514453ffeefSRobert Watson#
5155526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5166a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5176a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5186a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5196a8d6623SGarrett Wollman# programming errors.
5206a8d6623SGarrett Wollman#
5215526d2d9SEivind Eklundoptions 	INVARIANTS
5225526d2d9SEivind Eklund
5235526d2d9SEivind Eklund#
52434b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
52534b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
52634b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
52734b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
52834b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
52934b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
53034b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
53134b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
53234b15f2aSJohn Baldwin# infrastructure without the added overhead.
53334b15f2aSJohn Baldwin#
53434b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
53534b15f2aSJohn Baldwin
53634b15f2aSJohn Baldwin#
5375526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
5385526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
5395526d2d9SEivind Eklund# it is disabled by default.
5405526d2d9SEivind Eklund#
5410dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
542da59a31cSDavid Greenman
5430dd1eea1SJordan K. Hubbard#
5440b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5453c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5460b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5470b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5480b5438c6SRobert Watson# impossible) scenarios.
5490b5438c6SRobert Watson#
5500b5438c6SRobert Watsonoptions 	REGRESSION
5510b5438c6SRobert Watson
5520b5438c6SRobert Watson#
5539c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
554346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
555346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
556346ebe51SEivind Eklund# from.)
557346ebe51SEivind Eklund#
558346ebe51SEivind Eklundoptions 	COMPILING_LINT
559346ebe51SEivind Eklund
5603c90d1eaSRobert Watson#
5613c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5623c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5633c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5643c90d1eaSRobert Watson#
5653c90d1eaSRobert Watsonoptions 	STACK
5663c90d1eaSRobert Watson
5676a8d6623SGarrett Wollman
5686a8d6623SGarrett Wollman#####################################################################
569d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
570d47cce3eSMarcel Moolenaar
571d47cce3eSMarcel Moolenaar#
572d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5739c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
574d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
575d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
576d47cce3eSMarcel Moolenaar#
577ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
578ad3869b4SJoseph Koshy# please see hwpmc(4).
579ad3869b4SJoseph Koshy
580d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
581680f1afdSJohn Baldwinoptions 	HWPMC_DEBUG
582d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
583d47cce3eSMarcel Moolenaar
584d47cce3eSMarcel Moolenaar
585d47cce3eSMarcel Moolenaar#####################################################################
5866a8d6623SGarrett Wollman# NETWORKING OPTIONS
58770c0b54cSAndrey A. Chernov
5886a8d6623SGarrett Wollman#
589a22fb0daSGeorge V. Neville-Neil# Protocol families
5906a8d6623SGarrett Wollman#
5916a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
59251f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
593a22fb0daSGeorge V. Neville-Neil
5944871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
5954871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
5968b07e49aSJulian Elischer
59709fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
59809fe6320SNavdeep Parhar
599a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
600a22fb0daSGeorge V. Neville-Neil# your kernel configuration
601a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
6022cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
60314dd6717SSam Leffler#
604db2e4792SBjoern A. Zeeb# #DEPRECATED#
605db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
606db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
607db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
60814dd6717SSam Leffler# they are assumed trusted.
60914dd6717SSam Leffler#
610fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
611fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
61214dd6717SSam Leffler#
613cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
6147b495c44SVANHULLEBUS Yvan#
6157b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
6167b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
6177b495c44SVANHULLEBUS Yvan#
6187b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
619f73bbaf2SDavid Greenman
620237abf0cSDavide Italiano#
621237abf0cSDavide Italiano# SMB/CIFS requester
622237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
623237abf0cSDavide Italiano# options.
624237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
625237abf0cSDavide Italiano
626d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
627d8589bd5SBoris Popovoptions 	LIBMCHAIN
628d8589bd5SBoris Popov
6296cd047a0SGleb Smirnoff# libalias library, performing NAT
6306cd047a0SGleb Smirnoffoptions 	LIBALIAS
6316cd047a0SGleb Smirnoff
63234b07340SKip Macy# flowtable cache
63334b07340SKip Macyoptions 	FLOWTABLE
63434b07340SKip Macy
635f8829a4aSRandall Stewart#
636f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
637f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
638f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
639f8829a4aSRandall Stewart# extensions. This release supports all the extensions
640f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6419c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
642f8829a4aSRandall Stewart# and is quite well tested.
643f8829a4aSRandall Stewart#
644f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6459c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6469c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
647f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
648f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
649f8829a4aSRandall Stewart#
650f8829a4aSRandall Stewartoptions 	SCTP
651f8829a4aSRandall Stewart# There are bunches of options:
652f8829a4aSRandall Stewart# this one turns on all sorts of
653d51e8487SJosh Paetzel# nastily printing that you can
6549c0ef6d5SOliver Fromme# do. It's all controlled by a
655f8829a4aSRandall Stewart# bit mask (settable by socket opt and
656f8829a4aSRandall Stewart# by sysctl). Including will not cause
657f8829a4aSRandall Stewart# logging until you set the bits.. but it
658f8829a4aSRandall Stewart# can be quite verbose.. so without this
659f8829a4aSRandall Stewart# option we don't do any of the tests for
660f8829a4aSRandall Stewart# bits and prints.. which makes the code run
661f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
662f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
663f8829a4aSRandall Stewart#
6649c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6659c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6669c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
667f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
668f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
669f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
670f8829a4aSRandall Stewart# like with such an offload (which only exists in
671f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
672f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
673f8829a4aSRandall Stewart# to be.. but it does speed things up try only
674f8829a4aSRandall Stewart# for in a captured lab environment :-)
675f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
676f8829a4aSRandall Stewart#
677cb7a4976SRandall Stewart
678f8829a4aSRandall Stewart#
679f8829a4aSRandall Stewart# All that options after that turn on specific types of
680f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
681f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
682f8829a4aSRandall Stewart# see. I have used this to produce interesting
683f8829a4aSRandall Stewart# charts and graphs as well :->
684f8829a4aSRandall Stewart#
6859c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
686f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
687f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
688f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
689cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
690f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
6919c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
692cb7a4976SRandall Stewart# things too.
693f8829a4aSRandall Stewart#
694f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
695f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
696cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
697cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
698cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
699cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
700cb7a4976SRandall Stewart
701f8829a4aSRandall Stewart
70202b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
70302b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
704cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
705cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
706cceffdeeSAndrew Thompson# option.
70702b199f1SMax Laieroptions 	ALTQ
708755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
709c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
71002b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
71102b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
71202b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7133c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
714cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
71502b199f1SMax Laieroptions 	ALTQ_DEBUG
71602b199f1SMax Laier
7174cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7184cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7194cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7204cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
72192a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
72292a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7234cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
72473e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
72573e87266SGleb Smirnoff					# affects netgraph(4) and nodes
72673e87266SGleb Smirnoff# Node types
7274cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
728bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
729b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
730b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
731b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
732b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
733b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
734b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
735b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
736b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
73792a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
738901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7397d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
7404cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7419e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
74231578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7434cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7449d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
74546aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
7464cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
74737379158SBrooks Davisoptions 	NETGRAPH_GIF
74837379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7494cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7504cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
75137379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
752f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
75348e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
754901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7554cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
756a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
757a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
758a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
759cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7606cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7617d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
762d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
763991633afSMarko Zecoptions 	NETGRAPH_PIPE
764b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
765b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
766add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7679e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7684cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
769b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7704d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7710a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
772d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
773e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7744cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7754cf49a43SJulian Elischeroptions 	NETGRAPH_UI
776b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
777b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
778666ea1b6SMaksim Yevmenkin
77902152e8fSHartmut Brandt# NgATM - Netgraph ATM
78002152e8fSHartmut Brandtoptions 	NGATM_ATM
781027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
782027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
783027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
784ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
785a7e22394SHartmut Brandtoptions 	NGATM_CCATM
78602152e8fSHartmut Brandt
787c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7883cf4d0bfSPoul-Henning Kamp
7890990ef0aSKevin Lo# Network stack virtualization.
790287cd4a2SKevin Lo#options	VIMAGE
791287cd4a2SKevin Lo#options	VNET_DEBUG	# debug for VIMAGE
7920990ef0aSKevin Lo
7936a8d6623SGarrett Wollman#
7946a8d6623SGarrett Wollman# Network interfaces:
795f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
79636782d14SWojciech A. Koszekdevice		loop
79736782d14SWojciech A. Koszek
798f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
7999d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
800722012ccSJulian Elischer#  configured or token-ring is enabled.
80136782d14SWojciech A. Koszekdevice		ether
80236782d14SWojciech A. Koszek
803fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
8049d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
80536782d14SWojciech A. Koszekdevice		vlan
80636782d14SWojciech A. Koszek
807007054f0SBryan Venteicher# The `vxlan' device implements the VXLAN encapsulation of Ethernet
808007054f0SBryan Venteicher# frames in UDP packets according to RFC7348.
809007054f0SBryan Venteicherdevice		vxlan
810007054f0SBryan Venteicher
81157a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
81267e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
813f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
81436782d14SWojciech A. Koszekdevice		wlan
81536782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
81636782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
81759aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
81859aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
81936782d14SWojciech A. Koszek
82067e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
82167e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
82267e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
82336782d14SWojciech A. Koszekdevice		wlan_wep
82436782d14SWojciech A. Koszekdevice		wlan_ccmp
82536782d14SWojciech A. Koszekdevice		wlan_tkip
82636782d14SWojciech A. Koszek
82767e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
82867e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
82934341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
83036782d14SWojciech A. Koszekdevice		wlan_xauth
83136782d14SWojciech A. Koszek
83267e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
83367e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
83467e4db77SSam Leffler#  `wlan' module.
83536782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
83636782d14SWojciech A. Koszekdevice		wlan_acl
83736782d14SWojciech A. Koszekdevice		wlan_amrr
83836782d14SWojciech A. Koszek
83936782d14SWojciech A. Koszek# Generic TokenRing
84036782d14SWojciech A. Koszekdevice		token
84136782d14SWojciech A. Koszek
8421a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
84336782d14SWojciech A. Koszekdevice		fddi
84436782d14SWojciech A. Koszek
845eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
84636782d14SWojciech A. Koszekdevice		arcnet
84736782d14SWojciech A. Koszek
848f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
849e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
85036782d14SWojciech A. Koszekdevice		sppp
85136782d14SWojciech A. Koszek
852f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
853d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8549c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
85536782d14SWojciech A. Koszekdevice		bpf
85636782d14SWojciech A. Koszek
857e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
858e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
859e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
860e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
861e4b68814SLuigi Rizzodevice		netmap
862e4b68814SLuigi Rizzo
863f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
86459d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
86570e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
86636782d14SWojciech A. Koszekdevice		disc
86736782d14SWojciech A. Koszek
868d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
869d0ea4743SBjoern A. Zeeb# like interface pair.
870d0ea4743SBjoern A. Zeebdevice		epair
871d0ea4743SBjoern A. Zeeb
87263518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
87363518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
87436782d14SWojciech A. Koszekdevice		edsc
87536782d14SWojciech A. Koszek
8764c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
87736782d14SWojciech A. Koszekdevice		tap
87836782d14SWojciech A. Koszek
87936782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
88036782d14SWojciech A. Koszekdevice		tun
88136782d14SWojciech A. Koszek
882f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
883cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
884cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
885f325335cSAndrey V. Elsukov#  The `gre' device implements GRE (Generic Routing Encapsulation) tunneling,
886f325335cSAndrey V. Elsukov#  as specified in the RFC 2784 and RFC 2890.
887f325335cSAndrey V. Elsukov#  The `me' device implements Minimal Encapsulation within IPv4 as
888f325335cSAndrey V. Elsukov#  specified in the RFC 2004.
889f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
890f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
89136782d14SWojciech A. Koszekdevice		gif
89236782d14SWojciech A. Koszekdevice		gre
893f325335cSAndrey V. Elsukovdevice		me
89436782d14SWojciech A. Koszekoptions 	XBONEHACK
89536782d14SWojciech A. Koszek
896d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
89736782d14SWojciech A. Koszekdevice		stf
89836782d14SWojciech A. Koszek
8998d69c48bSMax Laier# The pf packet filter consists of three devices:
9008d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
9018d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
9028d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
9038d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
90436782d14SWojciech A. Koszekdevice		pf
90536782d14SWojciech A. Koszekdevice		pflog
90636782d14SWojciech A. Koszekdevice		pfsync
90736782d14SWojciech A. Koszek
90836782d14SWojciech A. Koszek# Bridge interface.
90936782d14SWojciech A. Koszekdevice		if_bridge
91036782d14SWojciech A. Koszek
91136782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
91236782d14SWojciech A. Koszekdevice		carp
91336782d14SWojciech A. Koszek
91436782d14SWojciech A. Koszek# IPsec interface.
91536782d14SWojciech A. Koszekdevice		enc
91636782d14SWojciech A. Koszek
91736782d14SWojciech A. Koszek# Link aggregation interface.
91836782d14SWojciech A. Koszekdevice		lagg
91936782d14SWojciech A. Koszek
9208d69c48bSMax Laier#
9216a8d6623SGarrett Wollman# Internet family options:
9226a8d6623SGarrett Wollman#
9236a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9240948f0a2SBruce M Simpson# with mrouted and XORP.
925e0f688baSJeffrey Hsu#
926d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
927ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
928ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
929ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
930ab6e02daSJordan K. Hubbard#
931ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
932ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
933a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
934ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
935ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
936ab6e02daSJordan K. Hubbard# feature works properly.
9378dd4744eSJordan K. Hubbard#
938ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
939ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
940ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
941ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
942ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
943ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
944ffdd472dSPeter Wemm# out of sync.
945d29895dcSGarrett Wollman#
94684bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
94784bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
94893e0e116SJulian Elischer#
94961c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
950531c890bSPaolo Pisati# LIBALIAS.
95161c0e134SPaolo Pisati#
9521b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9531c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9541b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9551b968362SDag-Erling Smørgrav#
9567f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9577f7ef494SGleb Smirnoff#
9585e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9595e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9605e331acdSGarrett Wollman# using the trpt(8) utility.
96165e8111fSBruce Evans#
96265e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9639731596aSGleb Smirnoff#
964e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
965d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9664479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9675895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
968e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
96961c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
97093e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9719cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9729cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9730c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9748259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9751b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
9767f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
97765e8111fSBruce Evansoptions 	TCPDEBUG
9789731596aSGleb Smirnoffoptions 	RADIX_MPATH
9796a8d6623SGarrett Wollman
98053dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
98153dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
982f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9834e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9846eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
9856eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
9866eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
98753dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
9886eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
9894a5ccac7SMike Silbersack
9909c0ef6d5SOliver Fromme# Statically link in accept filters
991a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
992744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
993a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
994a79b7128SAlfred Perlstein
995b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
996b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
997b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
998b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
999b2630c29SGeorge V. Neville-Neil# This requires the use of 'device crypto', 'options IPSEC'
1000b2630c29SGeorge V. Neville-Neil# or 'device cryptodev'.
10015164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
1002b52f8407SBruce M Simpson
1003f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
1004f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
1005358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
1006358f8d82SRobert Watson# a smooth scheduling of the traffic.
100768ec4eb6SLuigi Rizzooptions 	DUMMYNET
100868e9d934SLuigi Rizzo
10096a8d6623SGarrett Wollman#####################################################################
10106a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1011e3178a06SJordan K. Hubbard
10122365e64fSRodney W. Grimes#
10133f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10143f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10153f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10163f850e6aSKonstantin Belousov# filesystems as well.
10176a8d6623SGarrett Wollman#
101855793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1019534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1020534046e3SRong-En Fan# resolved.
10212365e64fSRodney W. Grimes#
1022f1a9c715SDavid Greenman
10236a8d6623SGarrett Wollman# One of these is mandatory:
10246a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1025c15882f0SRick Macklemoptions 	NFSCL			#Network File System client
10266a8d6623SGarrett Wollman
10276a8d6623SGarrett Wollman# The rest are optional:
10283914ddf8SEdward Tomasz Napieralaoptions 	AUTOFS			#Automounter filesystem
10295895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
103099d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
10315fe58019SAttilio Raooptions 	FUSE			#FUSE support module
1032dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1033dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10343e32dff5SJohn Baldwinoptions 	NFSD			#Network Filesystem Server
10359c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10361bea7c61SMaxim Sobolev
1037f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10384d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
103952ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1040bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1041237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
104278920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1043df263cbdSScott Longoptions 	UDF			#Universal Disk Format
104499d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1045bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1046bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1047f1a9c715SDavid Greenman
1048d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1049d61e6649SAlexander Langer# making abrupt shutdown less risky.
1050f8f8d7afSEivind Eklund#
10513d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1052b1897c19SJulian Elischer
1053a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
105451be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
105551be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
105649993db0SRobert Watsonoptions 	UFS_EXTATTR
105749993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1058a64ed089SRobert Watson
105951be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
106051be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
106151be6918SChris D. Faulhaber# for the underlying filesystem.
106251be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
106351be6918SChris D. Faulhaberoptions 	UFS_ACL
106451be6918SChris D. Faulhaber
10659b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10669b5ad47fSIan Dowse# directories at the expense of some memory.
10679b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10689b5ad47fSIan Dowse
1069f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1070f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1071f348204cSPawel Jakub Dawidek
107271e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
107371e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
107471e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
107571e4fff8SPoul-Henning Kamp
107671e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
107771e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
107871e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1079d52d7365SPoul-Henning Kamp
1080495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
10812365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
10826a8d6623SGarrett Wollman
1083276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
108445c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1085276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1086276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1087ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
10886110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1089276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1090276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
10919c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1092276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1093276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1094276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1095cb800e34SJulian Elischer#
1096cb800e34SJulian Elischeroptions 	SUIDDIR
1097cb800e34SJulian Elischer
1098df394affSJohn-Mark Gurney# NFS options:
10995895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
11005895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
11015895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
11025895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
1103df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1104df394affSJohn-Mark Gurney
1105053a2b61SEivind Eklund#
1106053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1107053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1108053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1109053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1110053a2b61SEivind Eklund#
11115895e3c8SPeter Wemmoptions 	EXT2FS
1112053a2b61SEivind Eklund
1113fe98fb32SJean-Sébastien Pédron#
1114fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1115fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1116fe98fb32SJean-Sébastien Pédron#
1117fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1118fe98fb32SJean-Sébastien Pédron
1119dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
11200cbe2ad6SRobert Watson# stability and security issues in the current aio code that make it
11210cbe2ad6SRobert Watson# unsuitable for inclusion on machines with untrusted local users.
1122dd85920aSJason Evansoptions 	VFS_AIO
1123053a2b61SEivind Eklund
11248ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1125ac519db0SMark Murraydevice		random
112615bbdecfSMark Murray
11278ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1128e83e229dSWarner Loshdevice		mem
11298ab2f5ecSMark Murray
113000a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
113100a5db46SStacey Sondevice		ksyms
113200a5db46SStacey Son
1133c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1134c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1135c4f02a89SMax Khonoptions 	CD9660_ICONV
1136c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1137126f0dfaSScott Longoptions 	UDF_ICONV
1138c4f02a89SMax Khon
11396a8d6623SGarrett Wollman
11406a8d6623SGarrett Wollman#####################################################################
1141abc97a06SBruce Evans# POSIX P1003.1B
1142abc97a06SBruce Evans
11431c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1144abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1145abc97a06SBruce Evans
11465895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11478cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11488cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11493ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1150abc97a06SBruce Evans
11515b40ce27SDavid Xu# POSIX message queue
11525b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1153abc97a06SBruce Evans
1154abc97a06SBruce Evans#####################################################################
115512e9f256SRobert Watson# SECURITY POLICY PARAMETERS
115612e9f256SRobert Watson
1157fdcba197SRobert Watson# Support for BSM audit
1158fdcba197SRobert Watsonoptions 	AUDIT
1159fdcba197SRobert Watson
1160cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1161cd6d1d76SBruce Evansoptions 	MAC
1162eae2f20cSRobert Watsonoptions 	MAC_BIBA
1163eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1164eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1165c4725737SRobert Watsonoptions 	MAC_LOMAC
1166eae2f20cSRobert Watsonoptions 	MAC_MLS
1167eae2f20cSRobert Watsonoptions 	MAC_NONE
1168eae2f20cSRobert Watsonoptions 	MAC_PARTITION
116903d03162SRobert Watsonoptions 	MAC_PORTACL
1170eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1171782f7255SRobert Watsonoptions 	MAC_STUB
1172eae2f20cSRobert Watsonoptions 	MAC_TEST
117312e9f256SRobert Watson
117496fcc75fSRobert Watson# Support for Capsicum
117555d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
117655d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
117796fcc75fSRobert Watson
117812e9f256SRobert Watson
117912e9f256SRobert Watson#####################################################################
1180000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1181000033d0SJeroen Ruigrok van der Werven
1182000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1183358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1184358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1185358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1186358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1187358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1188358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1189358f8d82SRobert Watson# actually reducing the accuracy of operation.
1190000033d0SJeroen Ruigrok van der Werven
1191000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1192000033d0SJeroen Ruigrok van der Werven
1193f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1194f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1195f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1196f309f881SJohn Baldwin
1197f309f881SJohn Baldwinoptions 	PPS_SYNC
1198f309f881SJohn Baldwin
1199b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1200b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1201b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1202b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1203b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1204b0fdc837SLawrence Stewart
1205b0fdc837SLawrence Stewartoptions 	FFCLOCK
1206b0fdc837SLawrence Stewart
1207000033d0SJeroen Ruigrok van der Werven
1208000033d0SJeroen Ruigrok van der Werven#####################################################################
1209de6a307eSPeter Dufault# SCSI DEVICES
1210de6a307eSPeter Dufault
12116a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12126a8d6623SGarrett Wollman
12136a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1214ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12156a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12166a8d6623SGarrett Wollman# device configuration sections below.
12176a8d6623SGarrett Wollman#
1218e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1219e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1220e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1221e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1222e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1223e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1224e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1225e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1226e14eb5a1SGarrett Wollman# problem.)
1227ebc1a0e2SPeter Dufault
1228ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1229ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1230700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1231700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1232ebc1a0e2SPeter Dufault
1233ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1234ebc1a0e2SPeter Dufault
1235f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1236f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1237f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1238f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1239f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1240f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1241f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1242f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1243f71c01ccSPeter Wemmhint.da.0.target="0"
1244f71c01ccSPeter Wemmhint.da.0.unit="0"
1245f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1246f71c01ccSPeter Wemmhint.da.1.target="1"
1247f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1248f71c01ccSPeter Wemmhint.da.2.target="3"
1249f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1250f71c01ccSPeter Wemmhint.sa.1.target="6"
1251ebc1a0e2SPeter Dufault
1252ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1253ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1254ebc1a0e2SPeter Dufault
1255ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1256ebc1a0e2SPeter Dufault
1257cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1258cf2458c9SMatt Jacob#
1259cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1260cf2458c9SMatt Jacob# ("WORM") devices.
1261cf2458c9SMatt Jacob#
1262cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1263cf2458c9SMatt Jacob#
1264cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1265cf2458c9SMatt Jacob#
12663c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12673c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1268cf2458c9SMatt Jacob#
1269cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1270cf2458c9SMatt Jacob#
12711eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12721eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12731eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1274d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1275cf2458c9SMatt Jacob#
1276cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1277cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1278cf2458c9SMatt Jacob#
1279cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1280cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1281cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1282cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1283cf2458c9SMatt Jacob#
1284cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1285cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1286cf2458c9SMatt Jacob# to them.
1287cf2458c9SMatt Jacob#
1288b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1289ebc1a0e2SPeter Dufault
1290c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1291c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1292c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1293c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1294c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1295dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1296cf2458c9SMatt Jacobdevice		pt		#SCSI processor
129764ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
129864ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1299cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13001eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1301130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13028909a72bSPeter Dufault
1303700daf5eSJustin T. Gibbs# CAM OPTIONS:
1304700daf5eSJustin T. Gibbs# debugging options:
1305f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1306f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1307f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1308f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1309f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1310f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1311f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1312700daf5eSJustin T. Gibbs#
1313700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1314700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1315700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
131656234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
131756234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13183a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13193a937198SBrooks Davis#             can be changed at boot and runtime with the
13203a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1321700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1322f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1323f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13245895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13255895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13265895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1327f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13285895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1329700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1330700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
133132672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
13321a7c583cSGarrett Wollman
1333700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1334700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1335700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1336700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1337700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1338700daf5eSJustin T. Gibbs# respectively.
133993063432SJoerg Wunsch#
1340700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1341700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1342700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
134393063432SJoerg Wunsch#
13445895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13455895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
134693063432SJoerg Wunsch
13479dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1348b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13499dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13509dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13519dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13529f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
135325388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
135425388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
135525388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
135625388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13579f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13589dfb4471SKenneth D. Merry
13593ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13603ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
136125388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13623ece1bd2SKenneth D. Merry
13638904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13648904e70bSMatt Jacob#
13658904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13668904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13679c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13688904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13698904e70bSMatt Jacob
13706a8d6623SGarrett Wollman
13716a8d6623SGarrett Wollman#####################################################################
13726a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13736a8d6623SGarrett Wollman
1374bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13756d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1376f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1377932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1378efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13796aec1278SMax Laierdevice		firmware	#firmware(9) support
1380be174c7eSGreg Lehey
13816f2d8adbSBoris Popov# Kernel side iconv library
13826f2d8adbSBoris Popovoptions 	LIBICONV
13836f2d8adbSBoris Popov
138458067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
13855895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
138658067a99SPoul-Henning Kamp
13876a8d6623SGarrett Wollman
13886a8d6623SGarrett Wollman#####################################################################
1389d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1390d61e6649SAlexander Langer
1391d61e6649SAlexander Langer# For ISA the required hints are listed.
13925bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
13935bcb64f2SWarner Losh# no hints are needed.
1394d61e6649SAlexander Langer
1395d61e6649SAlexander Langer#
1396d61e6649SAlexander Langer# Mandatory devices:
1397d61e6649SAlexander Langer#
1398d61e6649SAlexander Langer
13996e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
14006e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
14016e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
14026e818956SDavid E. O'Brien
14037f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
14047f5092f3SJohn Baldwin
1405837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1406837f167eSRuslan Ermilov
1407905e8b43SDag-Erling Smørgrav# Various screen savers.
1408905e8b43SDag-Erling Smørgravdevice		blank_saver
1409905e8b43SDag-Erling Smørgravdevice		daemon_saver
1410905e8b43SDag-Erling Smørgravdevice		dragon_saver
1411905e8b43SDag-Erling Smørgravdevice		fade_saver
1412905e8b43SDag-Erling Smørgravdevice		fire_saver
1413905e8b43SDag-Erling Smørgravdevice		green_saver
1414905e8b43SDag-Erling Smørgravdevice		logo_saver
1415905e8b43SDag-Erling Smørgravdevice		rain_saver
1416905e8b43SDag-Erling Smørgravdevice		snake_saver
1417905e8b43SDag-Erling Smørgravdevice		star_saver
1418905e8b43SDag-Erling Smørgravdevice		warp_saver
1419905e8b43SDag-Erling Smørgrav
14201c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1421f453022cSPeter Wemmdevice		sc
1422f71c01ccSPeter Wemmhint.sc.0.at="isa"
1423683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14246e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14256e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1426cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1427e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1428c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14296e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14306e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14316e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
143285e36760SJordan K. Hubbard
14337a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
143425388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
143525388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
143625388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
143725388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14387a88382dSKazutaka YOKOTA
1439d51e8487SJosh Paetzel# The following options will let you change the default behavior of
144078f45204SMaxim Sobolev# cut-n-paste feature
144178f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
144225388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
144325388b6cSBruce Evans					# (default is single space - \"x20\")
144478f45204SMaxim Sobolev
14457a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14467a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14477a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14487a88382dSKazutaka YOKOTA
14496e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14506e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14516e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14526e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14536e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14546e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1455c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14562ac8be82SAndreas Schulz
14578a28ce0eSJohn Baldwin# `flags' for sc
14588a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14598a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14608a28ce0eSJohn Baldwin
146183409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1462e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
146383409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
146483409a55SEd Schouten
1465ccbb7b5eSEd Maste# The vt video console driver.
1466ccbb7b5eSEd Mastedevice		vt
1467ccbb7b5eSEd Masteoptions		VT_ALT_TO_ESC_HACK=1	# Prepend ESC sequence to ALT keys
1468ccbb7b5eSEd Masteoptions		VT_MAXWINDOWS=16	# Number of virtual consoles
1469ccbb7b5eSEd Masteoptions		VT_TWOBUTTON_MOUSE	# Use right mouse button to paste
1470ccbb7b5eSEd Maste
1471ccbb7b5eSEd Maste# The following options set the default framebuffer size.
1472ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_HEIGHT=480
1473ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_WIDTH=640
1474ccbb7b5eSEd Maste
1475ccbb7b5eSEd Maste# The following options will let you change the default vt terminal colors.
1476ccbb7b5eSEd Masteoptions		TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)
1477ccbb7b5eSEd Masteoptions		TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)
1478ccbb7b5eSEd Maste
14791fe04850SBruce Evans#
1480d61e6649SAlexander Langer# Optional devices:
14816a8d6623SGarrett Wollman#
14826a8d6623SGarrett Wollman
14836a8d6623SGarrett Wollman#
1484d61e6649SAlexander Langer# SCSI host adapters:
14856a8d6623SGarrett Wollman#
14867f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1487859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
14886e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
14897f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1490d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1491d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1492cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
14937f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
14946e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
14956e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1496a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1497a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1498a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1499d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1500d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1501d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1502e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1503e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1504af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1505ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
150664fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
150764fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1508d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1509fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1510fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1511fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1512fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1513f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
15146e818956SDavid E. O'Brien# wds: WD7000
1515d61e6649SAlexander Langer
15166e818956SDavid E. O'Brien#
15176e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
15186e818956SDavid E. O'Brien# probed correctly.
15196e818956SDavid E. O'Brien#
15206e818956SDavid E. O'Briendevice		bt
15216e818956SDavid E. O'Brienhint.bt.0.at="isa"
15226e818956SDavid E. O'Brienhint.bt.0.port="0x330"
15237f5092f3SJohn Baldwindevice		adv
15247f5092f3SJohn Baldwinhint.adv.0.at="isa"
1525c9953c3bSPeter Wemmdevice		adw
15266e818956SDavid E. O'Briendevice		aha
15276e818956SDavid E. O'Brienhint.aha.0.at="isa"
15287f5092f3SJohn Baldwindevice		aic
15297f5092f3SJohn Baldwinhint.aic.0.at="isa"
15307f5092f3SJohn Baldwindevice		ahb
1531d61e6649SAlexander Langerdevice		ahc
1532cdd49e97SJustin T. Gibbsdevice		ahd
15331b946e21SScott Longdevice		esp
1534c5933b20SScott Longdevice		iscsi_initiator
1535d61e6649SAlexander Langerdevice		isp
15360787f2b8SMatt Jacobhint.isp.0.disable="1"
15370787f2b8SMatt Jacobhint.isp.0.role="3"
15380787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15390787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15400787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15410787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15420787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15430787f2b8SMatt Jacobhint.isp.0.topology="lport"
15440787f2b8SMatt Jacobhint.isp.0.topology="nport"
15450787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15460787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15470787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15480787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15490787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15500787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1551d61e6649SAlexander Langerdevice		ispfw
155264fa5108SMatt Jacobdevice		mpt
1553d61e6649SAlexander Langerdevice		ncr
1554d61e6649SAlexander Langerdevice		sym
1555f3d92b26SOlivier Houcharddevice		trm
15566e818956SDavid E. O'Briendevice		wds
15576e818956SDavid E. O'Brienhint.wds.0.at="isa"
15586e818956SDavid E. O'Brienhint.wds.0.port="0x350"
15596e818956SDavid E. O'Brienhint.wds.0.irq="11"
15606e818956SDavid E. O'Brienhint.wds.0.drq="6"
1561d61e6649SAlexander Langer
1562d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1563d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1564d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1565d61e6649SAlexander Langer# default.
1566d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1567d61e6649SAlexander Langer
1568fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1569fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1570fac70739SJeroen Ruigrok van der Werven
1571fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1572fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1573fac70739SJeroen Ruigrok van der Werven
1574662d3818SScott Long# Compile in Aic7xxx Debugging code.
1575662d3818SScott Longoptions 	AHC_DEBUG
1576662d3818SScott Long
1577662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1578662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1579662d3818SScott Long
1580f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1581f8f8803bSBruce Evans# See ahc(4).
1582662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1583662d3818SScott Long
1584cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1585cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1586cdd49e97SJustin T. Gibbs
1587f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1588cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1589cdd49e97SJustin T. Gibbs
159043e9d8a3SScott Long# Print human-readable register definitions when debugging
159143e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
159243e9d8a3SScott Long
1593662d3818SScott Long# Bitmap of units to enable targetmode operations.
1594662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1595662d3818SScott Long
1596d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1597d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1598d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1599d61e6649SAlexander Langer
1600c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1601c5933b20SScott Long#
1602c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1603c5933b20SScott Long
1604d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1605d61e6649SAlexander Langer#
1606d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1607d61e6649SAlexander Langer#
160864fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1609af606348SMatt Jacob#
16109a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
16119a1b0d43SMatt Jacob#		none=0
16129a1b0d43SMatt Jacob#		target=1
16139a1b0d43SMatt Jacob#		initiator=2
16149a1b0d43SMatt Jacob#		both=3			(not supported currently)
1615af606348SMatt Jacob#
161615f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
161715f0f952SMatt Jacob#
1618e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1619d61e6649SAlexander Langer
1620d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1621d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1622d61e6649SAlexander Langer					# Allows the ncr to take precedence
1623d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1624d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1625d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1626d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1627d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1628d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1629d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1630d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1631d61e6649SAlexander Langer					# default:8, range:[1..64]
16326a8d6623SGarrett Wollman
16336e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16346e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16356e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16366e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16376e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16386e818956SDavid E. O'Brien#
16396e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16406e818956SDavid E. O'Brien#  DPT_MEASURE_PERFORMANCE  Enables a set of (semi)invasive metrics. Various
16416e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16426e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16436e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16446e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16456e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16466e818956SDavid E. O'Brien#			    are 100% certain you need it.
16476e818956SDavid E. O'Brien
16486e818956SDavid E. O'Briendevice		dpt
16496e818956SDavid E. O'Brien
16506e818956SDavid E. O'Brien# DPT options
16516e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16526e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16536e818956SDavid E. O'Brien
16546e818956SDavid E. O'Brien#
16556e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16566e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16576e818956SDavid E. O'Brien# CAM infrastructure.
16586e818956SDavid E. O'Brien#
16596e818956SDavid E. O'Briendevice		ciss
16606e818956SDavid E. O'Brien
16616e818956SDavid E. O'Brien#
16626e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16636e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16646e818956SDavid E. O'Brien# at Intel for this driver are
16656e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16666e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16676e818956SDavid E. O'Brien#
16686e818956SDavid E. O'Briendevice		iir
16696e818956SDavid E. O'Brien
16706e818956SDavid E. O'Brien#
16716e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16726e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16736e818956SDavid E. O'Brien# the CAM infrastructure.
16746e818956SDavid E. O'Brien#
16756e818956SDavid E. O'Briendevice		mly
16766e818956SDavid E. O'Brien
16776e818956SDavid E. O'Brien#
16786e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
16796e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
16806e818956SDavid E. O'Brien# controllers.
16816e818956SDavid E. O'Brien#
16826e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
16836e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
16846e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
168564c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
16867f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1687f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
16886b31d3f7SScott Longoptions 	MFI_DEBUG
1689a58b4afaSMark Johnstondevice		mrsas		# LSI/Avago MegaRAID SAS/SATA, 6Gb/s and 12Gb/s
16906e818956SDavid E. O'Brien
16916e818956SDavid E. O'Brien#
16926e818956SDavid E. O'Brien# 3ware ATA RAID
16936e818956SDavid E. O'Brien#
16946e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
16956e818956SDavid E. O'Brien
169690d3341eSPeter Wemm#
1697e19ef875SAlexander Motin# Serial ATA host controllers:
1698e19ef875SAlexander Motin#
1699e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1700dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1701e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
17021a00526bSAlexander Motin#
17031a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
17041a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1705e19ef875SAlexander Motin
1706e19ef875SAlexander Motindevice		ahci
1707dd48af36SAlexander Motindevice		mvs
1708e19ef875SAlexander Motindevice		siis
1709e19ef875SAlexander Motin
1710e19ef875SAlexander Motin#
171145f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
171245f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
17136d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1714c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1715c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1716c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1717c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1718c9953c3bSPeter Wemmdevice		ata
1719c4bda3c6SAlexander Motin
1720c4bda3c6SAlexander Motin# Modular ATA
1721c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1722c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1723c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1724c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1725c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1726c4bda3c6SAlexander Motin
1727c4bda3c6SAlexander Motin# PCI ATA chipsets
1728c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1729c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1730c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1731c4bda3c6SAlexander Motin#device		ataati		# ATI
1732c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1733c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1734c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1735c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1736c4bda3c6SAlexander Motin#device		ataintel	# Intel
1737c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1738c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1739c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1740c4bda3c6SAlexander Motin#device		atamicron	# Micron
1741c4bda3c6SAlexander Motin#device		atanational	# National
1742c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1743c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1744c4bda3c6SAlexander Motin#device		atapromise	# Promise
1745c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1746c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1747c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1748c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1749c4bda3c6SAlexander Motin
17508b89ef0aSSøren Schmidt#
17516d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17526d04301dSAlexander Langerhint.ata.0.at="isa"
17536d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17546d04301dSAlexander Langerhint.ata.0.irq="14"
17556d04301dSAlexander Langerhint.ata.1.at="isa"
17566d04301dSAlexander Langerhint.ata.1.port="0x170"
17576d04301dSAlexander Langerhint.ata.1.irq="15"
17586d04301dSAlexander Langer
17596d04301dSAlexander Langer#
1760000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1761000da71aSSøren Schmidt#
1762000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
176374d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
17646fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17656fb5300bSAlexander Motin#			before timing out.
176674d8e840SSøren Schmidt
17670d307e09SAlexander Motinoptions 	ATA_STATIC_ID
17686fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
176974d8e840SSøren Schmidt
17708b89ef0aSSøren Schmidt#
17716d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17726d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17736a8d6623SGarrett Wollman#
1774f71c01ccSPeter Wemmdevice		fdc
1775f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1776f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1777f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1778f71c01ccSPeter Wemmhint.fdc.0.drq="2"
177985827d9cSJoerg Wunsch#
1780d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1781d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1782d2fb4892SJoerg Wunsch# however.
1783d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1784d2fb4892SJoerg Wunsch#
1785f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1786f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1787f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1788f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
178985827d9cSJoerg Wunsch
1790f71c01ccSPeter Wemm# Specify floppy devices
1791f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1792f71c01ccSPeter Wemmhint.fd.0.drive="0"
1793f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1794f71c01ccSPeter Wemmhint.fd.1.drive="1"
179585827d9cSJoerg Wunsch
17966a8d6623SGarrett Wollman#
1797501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1798501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1799c8956b36SMarcel Moolenaar#
1800501ef98fSMarcel Moolenaardevice		uart
1801501ef98fSMarcel Moolenaar
18028194412bSMarcel Moolenaar# Options for uart(4)
18038194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
18048194412bSMarcel Moolenaar					# instead of DCD.
18051662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
18061662b008SIan Lepore					# no interrupt support (50 Hz default).
18078194412bSMarcel Moolenaar
1808501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1809501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1810501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1811501ef98fSMarcel Moolenaar
1812c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1813c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1814c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1815c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1816c8956b36SMarcel Moolenaar# unit number of the probed UART.
1817501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1818501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1819501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1820501ef98fSMarcel Moolenaar
1821501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1822c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1823c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1824c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1825c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1826c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1827c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1828c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1829d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1830c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1831c8956b36SMarcel Moolenaar#		as debug port.
18329546766aSBruce Evans#
18339546766aSBruce Evans
1834501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
183591ed2fecSJohn-Mark Gurneyoptions 	BREAK_TO_DEBUGGER	# A BREAK/DBG on the console goes to
1836c8956b36SMarcel Moolenaar					# ddb, if available.
18376a8d6623SGarrett Wollman
183826b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
183926b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18409c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1841c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
184226b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
184326b6ea69SPaul Saab
1844af2e25a6SMarcel Moolenaar# Serial Communications Controller
1845af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1846af2e25a6SMarcel Moolenaar# communications controllers.
1847af2e25a6SMarcel Moolenaardevice		scc
1848af2e25a6SMarcel Moolenaar
18499c564b6cSJohn Hay# PCI Universal Communications driver
185064220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18519c564b6cSJohn Haydevice		puc
18529c564b6cSJohn Hay
18536a8d6623SGarrett Wollman#
1854d61e6649SAlexander Langer# Network interfaces:
18556a8d6623SGarrett Wollman#
1856dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1857d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18583c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18598c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
18608c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
18618c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18628c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18638c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
18648c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1865dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
18668c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
18678c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1868dfd77572SJohn Baldwin
1869dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1870dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1871dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1872dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1873dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1874dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1875dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1876dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1877dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1878dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1879dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1880dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1881dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1882dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1883dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1884dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1885dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1886dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1887dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1888e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1889dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1890dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1891dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1892dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1893dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1894dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1895dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1896dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1897d61e6649SAlexander Langer
18987f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
18997f5092f3SJohn Baldwin#       PCI and ISA varieties.
1900ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1901ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1902cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1903cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1904d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
19053c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1906390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1907343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1908343ed0a8SJohn Baldwin#       adapters.
1909343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
191095d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1911586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1912586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1913586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
19144e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1915dd46ab31SDavid Christensen#       adapters.
19163132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1917eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1918119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
19197f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19207f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
1921ca7fe84aSNavdeep Parhar# cxgb: Chelsio T3 based 1GbE/10GbE PCIe Ethernet adapters.
1922ca7fe84aSNavdeep Parhar# cxgbe:Chelsio T4 and T5 based 1GbE/10GbE/40GbE PCIe Ethernet adapters.
1923d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1924d61e6649SAlexander Langer#       and various workalikes including:
1925d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1926d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1927d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1928d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1929d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1930d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1931d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1932d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1933d61e6649SAlexander Langer#       KNE110TX.
1934d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1935a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
193696a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
19377f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19387f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19397f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19407f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19417f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19427f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1943d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1944d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1945cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19461ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
194752c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
194875a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
194944ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1950c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1951c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1952c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1953d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1954d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1955778eefa4SJohn Baldwin#	Requires the mwl firmware module
1956778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1957c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1958c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1959c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1960c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19612bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
1962d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1963ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1964ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1965ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1966cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1967cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
19682f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
196941f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19700fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19710fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19720fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19730fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19740fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1975390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19760587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1977d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1978d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1979d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1980d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1981d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1982d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1983d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1984d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1985d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1986d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1987d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1988d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1989d61e6649SAlexander Langer#       card which is 32-bit.
1990d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
1991b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1992b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1993d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1994d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1995d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1996d61e6649SAlexander Langer#       (also single mode and multimode).
1997d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1998d61e6649SAlexander Langer#       attach each one as a separate network interface.
19997f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
20007f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
2001d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
2002d61e6649SAlexander Langer#       the D-Link DFE-550TX.
2003d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
2004d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
2005d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
2006d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
2007d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
2008c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2009c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2010d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2011d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2012d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2013d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2014d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20153c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2016362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2017d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2018d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2019e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2020e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20212608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2022d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2023d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2024d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2025d61e6649SAlexander Langer#       NE2000 clone.
20267f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20277f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20287f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20297f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20307f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20317f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2032d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2033d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2034d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2035d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2036d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2037d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2038d61e6649SAlexander Langer
20397f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20407f5092f3SJohn Baldwin
20417f5092f3SJohn Baldwindevice		cm
20427f5092f3SJohn Baldwinhint.cm.0.at="isa"
20437f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20447f5092f3SJohn Baldwinhint.cm.0.irq="9"
20457f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20467f5092f3SJohn Baldwindevice		ep
20477f5092f3SJohn Baldwindevice		ex
2048c06a3350SPeter Wemmdevice		fe
20497f5092f3SJohn Baldwinhint.fe.0.at="isa"
20507f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20517f5092f3SJohn Baldwindevice		fea
20527f5092f3SJohn Baldwindevice		sn
20537f5092f3SJohn Baldwinhint.sn.0.at="isa"
20547f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20557f5092f3SJohn Baldwinhint.sn.0.irq="10"
20567f5092f3SJohn Baldwindevice		an
20577f5092f3SJohn Baldwindevice		wi
20587f5092f3SJohn Baldwindevice		xe
20597f5092f3SJohn Baldwin
2060d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2061ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2062cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2063d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20643c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2065343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2066343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2067343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2068119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
20698090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
2070404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2071ca7fe84aSNavdeep Parhardevice		cxgbe		# Chelsio T4 and T5 1GbE/10GbE/40GbE
2072d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20734d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20744664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20754664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20761ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
207752c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20780587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2079343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
20800587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2081d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2082343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
20830587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2084d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
20852e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2086d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2087d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2088d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2089343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2090d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
20910587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2092d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2093eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2094d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
20952608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2096d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2097d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2098d61e6649SAlexander Langer
2099d61e6649SAlexander Langer# PCI Ethernet NICs.
2100d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
210102f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
210202f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2103fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2104758cc3dcSJack F Vogeldevice		ix		# Intel Pro/10Gbe PCIE Ethernet
2105758cc3dcSJack F Vogeldevice		ixv		# Intel Pro/10Gbe PCIE Ethernet VF
210644ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2107f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2108fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
21092f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
21106e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
211195d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2112c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2113548d35fdSGeorge V. Neville-Neildevice		vxge		# Exar/Neterion XFrame 3100 10GbE
2114d61e6649SAlexander Langer
2115343ed0a8SJohn Baldwin# PCI FDDI NICs.
2116c06a3350SPeter Wemmdevice		fpa
2117d61e6649SAlexander Langer
21182bc6081cSScott Long# PCI WAN adapters.
21192bc6081cSScott Longdevice		lmc
21202bc6081cSScott Long
2121390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2122390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2123390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2124390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2125390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2126390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2127390cee87SJohn Baldwin#device		ath_rf2413
2128390cee87SJohn Baldwin#device		ath_rf2417
2129390cee87SJohn Baldwin#device		ath_rf2425
2130390cee87SJohn Baldwin#device		ath_rf5111
2131390cee87SJohn Baldwin#device		ath_rf5112
2132390cee87SJohn Baldwin#device		ath_rf5413
2133390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2134390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2135bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2136bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2137bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2138bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2139bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2140bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2141bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2142bc391cb2SWarner Losh# 4 are safe.
2143bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2144390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2145390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
214658c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2147390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2148390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2149eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2150d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2151d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2152778eefa4SJohn Baldwindevice		mwlfw
2153390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2154390cee87SJohn Baldwin
215510a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
215610a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
215798cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
215898cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
215910a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2160b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
216198cb733cSKenneth D. Merry
21622c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21632c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21642c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21652c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21662c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21672c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21682c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21692c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21702c8f5a28SKenneth D. Merry
217168713f97SKenjiro Cho#
217244b5247dSKenjiro Cho# ATM related options (Cranor version)
217344b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
217468713f97SKenjiro Cho#
217568713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
217668713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
217768713f97SKenjiro Cho#
2178c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2179c594298bSHartmut Brandt# ATM PCI cards.
2180c594298bSHartmut Brandt#
2181fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2182fb24f088SHartmut Brandt#
21838dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
21848dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
21858dd4275cSHartmut Brandt#
2186f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
218768713f97SKenjiro Cho# atm devices.
21883cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
218968713f97SKenjiro Cho# bypass TCP/IP.
219068713f97SKenjiro Cho#
2191fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2192fb24f088SHartmut Brandt# hatm and fatm.
21931ba46a03SHartmut Brandt#
219468713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
219568713f97SKenjiro Cho# for more details, please read the original documents at
219698a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
219768713f97SKenjiro Cho#
2198f71c01ccSPeter Wemmdevice		atm
219944b5247dSKenjiro Chodevice		en
2200fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2201c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
22028dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
22031ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
22048c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2205f4567b9cSJulian Elischer
22067e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
22077e9024cdSHartmut Brandt
2208c19da41eSPeter Wemm#
22090739ea1dSSeigo Tanimura# Sound drivers
2210c19da41eSPeter Wemm#
22110739ea1dSSeigo Tanimura# sound: The generic sound driver.
2212c7406082SJohn-Mark Gurney#
22130739ea1dSSeigo Tanimura
22140739ea1dSSeigo Tanimuradevice		sound
22150739ea1dSSeigo Tanimura
22160739ea1dSSeigo Tanimura#
22170739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2218c7406082SJohn-Mark Gurney#
22199c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22207f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22217f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22227f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22237f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22247f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22257f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22267f5092f3SJohn Baldwin#
2227c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22280739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2229d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2230903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2231903b2fb9SJoel Dahl#			for sparc64.
22320739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22330739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22340739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22350739ea1dSSeigo Tanimura#			4281)
22360739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22370739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22380fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22399f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22409f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22410739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2242727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2243727ded3aSJoel Dahl#			conjunction with snd_sbc.
22440739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22450739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22464b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22474b8939a1SAriff Abdullah#			compatible.
2248e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
224917470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2250903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2251903b2fb9SJoel Dahl#			nForce controllers.
22520739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22530739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22540739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22550739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22560739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22571c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22580739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22591c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22600739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22617f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22620739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2263de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2264903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22650739ea1dSSeigo Tanimura#			M5451 PCI.
2266de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22670739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22680739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22690739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
227081bb901eSPeter Wemm
2271f37a929cSPeter Wemmdevice		snd_ad1816
2272f37a929cSPeter Wemmdevice		snd_als4000
2273d9bde1adSAriff Abdullahdevice		snd_atiixp
22747a7386a3SPyun YongHyeon#device		snd_audiocs
22750739ea1dSSeigo Tanimuradevice		snd_cmi
2276f37a929cSPeter Wemmdevice		snd_cs4281
22770739ea1dSSeigo Tanimuradevice		snd_csa
2278f37a929cSPeter Wemmdevice		snd_ds1
2279f37a929cSPeter Wemmdevice		snd_emu10k1
22800fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2281b1ff0220SAlexander Leidingerdevice		snd_envy24
22829f548240SAlexander Leidingerdevice		snd_envy24ht
2283f37a929cSPeter Wemmdevice		snd_es137x
22840739ea1dSSeigo Tanimuradevice		snd_ess
2285f37a929cSPeter Wemmdevice		snd_fm801
22860739ea1dSSeigo Tanimuradevice		snd_gusc
22874b8939a1SAriff Abdullahdevice		snd_hda
2288e4afd792SAlexander Motindevice		snd_hdspe
22890739ea1dSSeigo Tanimuradevice		snd_ich
22900739ea1dSSeigo Tanimuradevice		snd_maestro
2291f37a929cSPeter Wemmdevice		snd_maestro3
22920739ea1dSSeigo Tanimuradevice		snd_mss
22930739ea1dSSeigo Tanimuradevice		snd_neomagic
2294f37a929cSPeter Wemmdevice		snd_sb16
2295f37a929cSPeter Wemmdevice		snd_sb8
22960739ea1dSSeigo Tanimuradevice		snd_sbc
22970739ea1dSSeigo Tanimuradevice		snd_solo
22989f548240SAlexander Leidingerdevice		snd_spicds
2299f37a929cSPeter Wemmdevice		snd_t4dwave
2300de8d750fSJoel Dahldevice		snd_uaudio
2301f37a929cSPeter Wemmdevice		snd_via8233
2302f37a929cSPeter Wemmdevice		snd_via82c686
23030739ea1dSSeigo Tanimuradevice		snd_vibes
2304c19da41eSPeter Wemm
23051c9c6382SRuslan Ermilov# For non-PnP sound cards:
2306673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2307673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2308673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2309673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2310673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2311673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2312673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2313673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2314673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2315673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2316673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2317673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2318673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2319673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23207f5092f3SJohn Baldwin
23216a8d6623SGarrett Wollman#
232218fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
232318fe4678SAriff Abdullah#
232418fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
232518fe4678SAriff Abdullah#                              sanity checking and possible increase of
232618fe4678SAriff Abdullah#                              verbosity.
232718fe4678SAriff Abdullah#
2328d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
232918fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
233018fe4678SAriff Abdullah#
233118fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
233218fe4678SAriff Abdullah#                              in. This options enable most feeder converters
233318fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
233418fe4678SAriff Abdullah#
233518fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
233618fe4678SAriff Abdullah#
233718fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
233818fe4678SAriff Abdullah#                              as much as possible (the default trying to
233918fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
234018fe4678SAriff Abdullah#
234118fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
234218fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
234318fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
234418fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
234518fe4678SAriff Abdullah#
234618fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
234718fe4678SAriff Abdullah#                              disabling multichannel processing.
234818fe4678SAriff Abdullah#
234918fe4678SAriff Abdullahoptions		SND_DEBUG
235018fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
235118fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
235218fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
235318fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
235418fe4678SAriff Abdullahoptions		SND_PCM_64
235518fe4678SAriff Abdullahoptions		SND_OLDSTEREO
235618fe4678SAriff Abdullah
235718fe4678SAriff Abdullah#
2358567e21c2SBruce Evans# Miscellaneous hardware:
23596a8d6623SGarrett Wollman#
23606fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
23613ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
23621c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23637f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2364603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2365657e73c4SPeter Dufault
23663ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
23673ae5b532SMatthew N. Dodddevice		mcd
23683ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
23693ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
23706fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
23716fe8789dSMatthew N. Dodddevice		scd
23726fe8789dSMatthew N. Doddhint.scd.0.at="isa"
23736fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
23741c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23757f5092f3SJohn Baldwinhint.joy.0.at="isa"
23767f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2377603d67aeSRink Springerdevice		cmx
2378a800f455SJulian Elischer
2379eeb706c0SJustin T. Gibbs#
2380a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
23811c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2382a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
23831c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
23841c2b5939SRoger Hardiman#
2385a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2386a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2387a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2388a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
23891c2b5939SRoger Hardiman# These options can be used to override the auto detection
239098a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
23911c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
23929ff07e32SAmancio Hasty#
23934f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
23941c2b5939SRoger Hardiman# or
23951c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
23963c7c6c12SMike Pritchard# Specifies the default video capture mode.
23971748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2398d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2399a9c5b8d0SSøren Schmidt#
24004f5f3f07SBrian Somers# options 	BKTR_USE_PLL
24011748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2402a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2403a9c5b8d0SSøren Schmidt#
24041c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24059c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24061c2b5939SRoger Hardiman#
24071c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2408d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
24091c2b5939SRoger Hardiman#
24101c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24111c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24121c2b5939SRoger Hardiman#
24131c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24141c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24151c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24161c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24171c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24181c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24191c2b5939SRoger Hardiman#
242030e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
242130e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
242230e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
242330e27d96SAlexander Langer# mono sound.
2424017b0edcSMatt Jacob
2425c17d4340SNicolas Souchu#
2426c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2427c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2428c17d4340SNicolas Souchu#
242928ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24300f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
243137973e86SPeter Wemm#     device smbus
243237973e86SPeter Wemm#     device iicbus
243337973e86SPeter Wemm#     device iicbb
2434c17d4340SNicolas Souchu#     device iicsmb
24350f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24360f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
243728ebb692SNicolas Souchu#
2438c06a3350SPeter Wemmdevice		bktr
2439446cee6eSJoerg Wunsch
2440dc9deb29SPoul-Henning Kamp#
24416e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24426e818956SDavid E. O'Brien#
24435bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24446e818956SDavid E. O'Brien# pccard: pccard slots
24456e818956SDavid E. O'Brien# cardbus: cardbus slots
24466e818956SDavid E. O'Briendevice		cbb
24476e818956SDavid E. O'Briendevice		pccard
24486e818956SDavid E. O'Briendevice		cardbus
24496e818956SDavid E. O'Brien
24506e818956SDavid E. O'Brien#
24515bcb64f2SWarner Losh# MMC/SD
24525bcb64f2SWarner Losh#
2453831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2454831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2455831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2456831f5dcfSAlexander Motin#
2457831f5dcfSAlexander Motindevice		mmc
2458831f5dcfSAlexander Motindevice		mmcsd
2459831f5dcfSAlexander Motindevice		sdhci
24605bcb64f2SWarner Losh
24615bcb64f2SWarner Losh#
24628afa373cSNicolas Souchu# SMB bus
24638afa373cSNicolas Souchu#
24643c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24653c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24663c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24678afa373cSNicolas Souchu#
24688afa373cSNicolas Souchu# Supported devices:
24694d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24708afa373cSNicolas Souchu#
24713c5656bfSArchie Cobbs# Supported SMB interfaces:
247228ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
247328ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24747f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24757f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24767f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24777f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2478b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
24794d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
248044e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
24814d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
24820572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
24838afa373cSNicolas Souchu#
2484c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
24853c5656bfSArchie Cobbs
24867f5092f3SJohn Baldwindevice		intpm
24877f5092f3SJohn Baldwindevice		alpm
24887f5092f3SJohn Baldwindevice		ichsmb
24897f5092f3SJohn Baldwindevice		viapm
249044e6ce01SNicolas Souchudevice		amdpm
24914d5f30e0SRuslan Ermilovdevice		amdsmb
249244e6ce01SNicolas Souchudevice		nfpm
24934d5f30e0SRuslan Ermilovdevice		nfsmb
24940572ccaaSJim Harrisdevice		ismt
24957f5092f3SJohn Baldwin
2496c9953c3bSPeter Wemmdevice		smb
24978afa373cSNicolas Souchu
24988afa373cSNicolas Souchu#
24998afa373cSNicolas Souchu# I2C Bus
25008afa373cSNicolas Souchu#
25018afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
25028afa373cSNicolas Souchu#
25038afa373cSNicolas Souchu# Supported devices:
25048afa373cSNicolas Souchu# ic	i2c network interface
25058afa373cSNicolas Souchu# iic	i2c standard io
2506f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25071ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
25088afa373cSNicolas Souchu#
25098afa373cSNicolas Souchu# Supported interfaces:
251028ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
251128ebb692SNicolas Souchu#
251228ebb692SNicolas Souchu# Other:
251328ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25148afa373cSNicolas Souchu#
2515c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2516c9953c3bSPeter Wemmdevice		iicbb
25178afa373cSNicolas Souchu
2518c9953c3bSPeter Wemmdevice		ic
2519c9953c3bSPeter Wemmdevice		iic
2520c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25211ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
25228afa373cSNicolas Souchu
2523286fa445SRafal Jaworowski# I2C peripheral devices
2524286fa445SRafal Jaworowski#
2525286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
25261513a6ffSJayachandran C.# ds1374	Dallas Semiconductor DS1374 RTC
2527286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2528f8e8af9cSHiroki Sato# s35390a	Seiko Instruments S-35390A RTC
2529286fa445SRafal Jaworowski#
2530286fa445SRafal Jaworowskidevice		ds133x
25311513a6ffSJayachandran C.device		ds1374
2532286fa445SRafal Jaworowskidevice		ds1672
2533f8e8af9cSHiroki Satodevice		s35390a
2534286fa445SRafal Jaworowski
2535ab4c624bSMike Smith# Parallel-Port Bus
2536ab4c624bSMike Smith#
2537ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2538ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2539ab4c624bSMike Smith# are automatically probed and attached when found.
2540ab4c624bSMike Smith#
2541ab4c624bSMike Smith# Supported devices:
2542ab4c624bSMike Smith# vpo	Iomega Zip Drive
2543f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2544f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2545fdf94d1aSNicolas Souchu# lpt	Parallel Printer
254646f3ff79SMike Smith# plip	Parallel network interface
2547fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2548f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
254928ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25501caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2551ab4c624bSMike Smith#
2552ab4c624bSMike Smith# Supported interfaces:
2553ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2554ab4c624bSMike Smith#
2555ef8f7626SNicolas Souchu
25560f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25570f210c92SNicolas Souchu				  # (see flags in ppc(4))
25585895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25599d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2560ef8f7626SNicolas Souchu				# compliant peripheral
25615895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25625895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25635895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25645895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25655895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25663b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25673b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2568ef8f7626SNicolas Souchu
2569f71c01ccSPeter Wemmdevice		ppc
2570f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2571f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25720d31b179SPeter Wemmdevice		ppbus
25730d31b179SPeter Wemmdevice		vpo
25740d31b179SPeter Wemmdevice		lpt
25750d31b179SPeter Wemmdevice		plip
25760d31b179SPeter Wemmdevice		ppi
25770d31b179SPeter Wemmdevice		pps
25780d31b179SPeter Wemmdevice		lpbb
25790d31b179SPeter Wemmdevice		pcfclock
2580ab4c624bSMike Smith
25810ac40133SBrian Somers# Kernel BOOTP support
25820ac40133SBrian Somers
25830ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2584c15882f0SRick Macklem				# Requires NFSCL and NFS_ROOT
25850ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
25860ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
25870ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
25880ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2589eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2590432aad0eSTor Egge
2591d94f38acSEivind Eklund#
25924103b765SPoul-Henning Kamp# Add software watchdog routines.
2593370c3cb5SSean Kelly#
25944103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2595370c3cb5SSean Kelly
2596370c3cb5SSean Kelly#
2597f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2598f7829d0dSAttilio Rao#
2599f7829d0dSAttilio Raooptions 	DEADLKRES
2600f7829d0dSAttilio Rao
2601f7829d0dSAttilio Rao#
2602b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
26034e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
26044e0ee531SMike Barcroft# it back on at run-time.
2605c796cfa1SAndrzej Bialecki#
2606c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2607c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2608c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2609c796cfa1SAndrzej Bialecki#
261019dde963SPeter Wemm#options 	NO_SWAPPING
2611c796cfa1SAndrzej Bialecki
26129dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26139dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26149dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26159dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26169dab0776SDavid Greenman#
26175895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26189dab0776SDavid Greenman
261915a1057cSEivind Eklund#
2620053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26219c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2622053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
26232c048c4aSBryan Drewery# not at all useful unless you are debugging lock code.  Note that
26242c048c4aSBryan Drewery# modules should be recompiled as this option modifies KBI.
262515a1057cSEivind Eklund#
262615a1057cSEivind Eklundoptions 	DEBUG_LOCKS
262715a1057cSEivind Eklund
262826086a03SPeter Wemm
262926086a03SPeter Wemm#####################################################################
26301d33cf3dSNick Hibma# USB support
26311d33cf3dSNick Hibma# UHCI controller
2632c9953c3bSPeter Wemmdevice		uhci
26331d33cf3dSNick Hibma# OHCI controller
2634c9953c3bSPeter Wemmdevice		ohci
2635ca3acad1SBernd Walter# EHCI controller
2636ca3acad1SBernd Walterdevice		ehci
2637857508a3SAndrew Thompson# XHCI controller
2638857508a3SAndrew Thompsondevice		xhci
263939e5901eSTakanori Watanabe# SL811 Controller
2640b92755d1SAndrew Thompson#device		slhci
26411d33cf3dSNick Hibma# General USB code (mandatory for USB)
2642c9953c3bSPeter Wemmdevice		usb
26431d33cf3dSNick Hibma#
2644b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2645b5ea1f0cSNick Hibmadevice		udbp
2646d1233ab3SBruce Evans# USB Fm Radio
2647d1233ab3SBruce Evansdevice		ufm
26486bd03b20SKevin Lo# USB LED
26496bd03b20SKevin Lodevice		uled
2650f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2651c9953c3bSPeter Wemmdevice		uhid
26521d33cf3dSNick Hibma# USB keyboard
2653c9953c3bSPeter Wemmdevice		ukbd
26541d33cf3dSNick Hibma# USB printer
2655c9953c3bSPeter Wemmdevice		ulpt
265631615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2657c9953c3bSPeter Wemmdevice		umass
265831615ef7SRebecca Cran# USB mass storage driver for device-side mode
265931615ef7SRebecca Crandevice		usfs
2660ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2661ce17576aSScott Longdevice		umct
2662e9fb12d3SNick Hibma# USB modem support
2663e9fb12d3SNick Hibmadevice		umodem
2664f26c33d2SNick Hibma# USB mouse
2665c9953c3bSPeter Wemmdevice		ums
2666eed447b5SHans Petter Selasky# USB touchpad(s)
2667eed447b5SHans Petter Selaskydevice		atp
2668eed447b5SHans Petter Selaskydevice		wsp
2669f25a8a01SGleb Smirnoff# eGalax USB touch screen
2670f25a8a01SGleb Smirnoffdevice		uep
26711c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2672e2dbd15fSNick Hibmadevice		urio
2673d1233ab3SBruce Evans#
2674916e6e02SJosef Karthauser# USB serial support
2675916e6e02SJosef Karthauserdevice		ucom
2676fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2677483b9e47SNick Hibmadevice		u3g
26789aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
26799aab0d96SMaxim Konovalovdevice		uark
2680d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2681d1233ab3SBruce Evansdevice		ubsa
268248b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
268348b68edfSJosef Karthauserdevice		uftdi
2684c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2685c5286e11STakanori Watanabedevice		uipaq
268648b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2687916e6e02SJosef Karthauserdevice		uplcom
26882e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
26892e7328e7SRink Springerdevice		uslcom
269048b68edfSJosef Karthauser# USB Visor and Palm devices
269148b68edfSJosef Karthauserdevice		uvisor
2692d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2693d1233ab3SBruce Evansdevice		uvscom
2694f26c33d2SNick Hibma#
2695ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2696d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2697d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2698d04bb221SBill Paul# eval board.
2699c9953c3bSPeter Wemmdevice		aue
2700bf029145SRobert Watson
2701bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2702bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2703bf029145SRobert Watsondevice		axe
270479eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
270579eb99dfSLi-Wen Hsudevice		axge
2706bf029145SRobert Watson
2707dfd1e98eSBill Paul#
27086bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
27096bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
27106bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
27116bcf0032SMaxim Sobolevdevice		cdce
27126bcf0032SMaxim Sobolev#
271301779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
271401779872SBill Paul# and Netmate II, and the Belkin F5U111.
2715c9953c3bSPeter Wemmdevice		cue
271601779872SBill Paul#
2717dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2718d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2719d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
272001779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
272101779872SBill Paul# and 2104USB, and the Corega USB-T.
2722c9953c3bSPeter Wemmdevice		kue
272311e04b05SShunsuke Akiyama#
272411e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
272511e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
272611e04b05SShunsuke Akiyamadevice		rue
2727cdd40f3bSMIHIRA Sanpei Yoshiro#
2728cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2729cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2730941e2863SAndrew Thompson#
273122445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
273222445463SKevin Lodevice		mos
273322445463SKevin Lo#
2734941e2863SAndrew Thompson# HSxPA devices from Option N.V
2735941e2863SAndrew Thompsondevice		uhso
2736cdd40f3bSMIHIRA Sanpei Yoshiro
273731d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
273831d98677SRui Paulodevice		rsu
27398a4cd00aSWarner Losh#
274071aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
274171aa1d32SSam Lefflerdevice		rum
274293393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
274393393dfdSAndrew Thompsondevice		run
27448a4cd00aSWarner Losh#
274571aa1d32SSam Leffler# Atheros AR5523 wireless driver
274671aa1d32SSam Lefflerdevice		uath
274771aa1d32SSam Leffler#
2748d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2749d1f25d5dSBernhard Schmidtdevice		upgt
2750d1f25d5dSBernhard Schmidt#
275171aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
27528a4cd00aSWarner Loshdevice		ural
27538a4cd00aSWarner Losh#
275429311227SHans Petter Selasky# RNDIS USB ethernet driver
275529311227SHans Petter Selaskydevice		urndis
27565aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
27575aaea652SKevin Lodevice		urtw
27585aaea652SKevin Lo#
2759c2c2fc4dSRui Paulo# Realtek RTL8188CU/RTL8192CU wireless driver
2760c2c2fc4dSRui Paulodevice		urtwn
2761c2c2fc4dSRui Paulo#
276271aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
276371aa1d32SSam Lefflerdevice		zyd
276445b395cdSGleb Smirnoff#
276545b395cdSGleb Smirnoff# Sierra USB wireless driver
276645b395cdSGleb Smirnoffdevice		usie
2767f26c33d2SNick Hibma
27688a4cd00aSWarner Losh#
2769f26c33d2SNick Hibma# debugging options for the USB subsystem
27701d33cf3dSNick Hibma#
27711d33cf3dSNick Hibmaoptions 	USB_DEBUG
2772fe75118bSNick Hibmaoptions 	U3G_DEBUG
2773f26c33d2SNick Hibma
27746e8394b8SKazutaka YOKOTA# options for ukbd:
27756e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
277691b050b2SPoul-Henning Kampmakeoptions	UKBD_DFLT_KEYMAP=jp.pc98
27776e8394b8SKazutaka YOKOTA
2778565f53bbSShunsuke Akiyama# options for uplcom:
27793c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2780565f53bbSShunsuke Akiyama						# in milliseconds
2781565f53bbSShunsuke Akiyama
278220280807SShunsuke Akiyama# options for uvscom:
278320280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
27843c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2785565f53bbSShunsuke Akiyama						# in milliseconds
278620280807SShunsuke Akiyama
27878b7ce2ffSSam Leffler#####################################################################
2788869093b1SHidetoshi Shimokawa# FireWire support
27897d2ba89bSJohn Baldwin
2790869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
27917d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
279279acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2793869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
27941c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2795869093b1SHidetoshi Shimokawa
2796869093b1SHidetoshi Shimokawa#####################################################################
2797869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2798869093b1SHidetoshi Shimokawa
2799869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2800869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2801869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2802869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2803869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2804869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
28057d2ba89bSJohn Baldwin
28067d2ba89bSJohn Baldwin#####################################################################
28078b7ce2ffSSam Leffler# crypto subsystem
28088b7ce2ffSSam Leffler#
28091c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2810b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
28111c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
28128b7ce2ffSSam Leffler#
28131c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28141c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28158b7ce2ffSSam Leffler
28168b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
28178b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28188b7ce2ffSSam Leffler
2819ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28208b7ce2ffSSam Leffler
2821b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2822b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2823b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2824b7c4858fSSam Leffler
2825b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2826b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2827b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2828b7c4858fSSam Leffler
28298b7ce2ffSSam Leffler#####################################################################
28308b7ce2ffSSam Leffler
28318b7ce2ffSSam Leffler
2832785d2100SJohn Birrell#
2833785d2100SJohn Birrell# Embedded system options:
2834785d2100SJohn Birrell#
2835785d2100SJohn Birrell# An embedded system might want to run something other than init.
28360fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2837bc0e3a03SJeroen Ruigrok van der Werven
2838bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2839bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28401c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2841395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
284241c1a233SGleb Smirnoffoptions 	IFMEDIA_DEBUG	# enable debugging in net/if_media.c
2843bc0e3a03SJeroen Ruigrok van der Werven
2844e2c1a4e9SBenno Rice#
2845e2c1a4e9SBenno Rice# Verbose SYSINIT
2846e2c1a4e9SBenno Rice#
2847e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2848e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2849e2c1a4e9SBenno Rice# will print function names instead of addresses.
2850e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2851e2c1a4e9SBenno Rice
2852446af86dSJohn Baldwin#####################################################################
2853446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2854446af86dSJohn Baldwin#
2855446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2856446af86dSJohn Baldwin# one time.
2857446af86dSJohn Baldwinoptions 	SEMMNI=11
2858446af86dSJohn Baldwin
2859446af86dSJohn Baldwin# Total number of semaphores system wide
2860446af86dSJohn Baldwinoptions 	SEMMNS=61
2861446af86dSJohn Baldwin
2862446af86dSJohn Baldwin# Total number of undo structures in system
2863446af86dSJohn Baldwinoptions 	SEMMNU=31
2864446af86dSJohn Baldwin
2865446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2866446af86dSJohn Baldwin# at one time.
2867446af86dSJohn Baldwinoptions 	SEMMSL=61
2868446af86dSJohn Baldwin
2869446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2870446af86dSJohn Baldwin# semaphore at one time.
2871446af86dSJohn Baldwinoptions 	SEMOPM=101
2872446af86dSJohn Baldwin
2873446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2874446af86dSJohn Baldwin# System V semaphore at one time.
2875446af86dSJohn Baldwinoptions 	SEMUME=11
2876446af86dSJohn Baldwin
2877446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2878446af86dSJohn Baldwinoptions 	SHMALL=1025
2879446af86dSJohn Baldwin
2880446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
288125388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2882446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2883446af86dSJohn Baldwin
2884446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2885446af86dSJohn Baldwinoptions 	SHMMIN=2
2886446af86dSJohn Baldwin
2887446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2888446af86dSJohn Baldwin# at one time.
2889446af86dSJohn Baldwinoptions 	SHMMNI=33
2890446af86dSJohn Baldwin
2891446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2892446af86dSJohn Baldwin# a single process at one time.
2893446af86dSJohn Baldwinoptions 	SHMSEG=9
2894446af86dSJohn Baldwin
2895d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2896d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2897d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2898d9282887SDima Dorfman# console.
2899d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2900d9282887SDima Dorfman
29015bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
29025bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
29035bbb8060STor Egge# file.  Both offset and length of the read operation must be
29045bbb8060STor Egge# multiples of the physical media sector size.
29055bbb8060STor Egge#
2906995356dcSDag-Erling Smørgravoptions 	DIRECTIO
29075bbb8060STor Egge
29085bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
29095bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29105bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29115bbb8060STor Egge#
2912995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29135bbb8060STor Egge
2914446af86dSJohn Baldwin#####################################################################
2915446af86dSJohn Baldwin
2916bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29179c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2918bc0e3a03SJeroen Ruigrok van der Werven
2919bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
292028d7984fSJeroen Ruigrok van der Werven
292128d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2922bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
292328d7984fSJeroen Ruigrok van der Werven
2924bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29258b6f5e65SJeroen Ruigrok van der Werven
292628d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2927bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
292828d7984fSJeroen Ruigrok van der Werven
29298b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29308b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29318b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29328b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29338b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29348b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29358b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29368b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29378b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29388b6f5e65SJeroen Ruigrok van der Werven
29398b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29408b6f5e65SJeroen Ruigrok van der Werven
2941bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2942bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2943bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2944bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29458b6f5e65SJeroen Ruigrok van der Werven
29468b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29478b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29488b6f5e65SJeroen Ruigrok van der Werven
29498b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29508b6f5e65SJeroen Ruigrok van der Werven
2951316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
2952b7627840SKonstantin Belousovoptions 	KSTACK_USAGE_PROF
2953316ec49aSScott Long
2954662d3818SScott Long# Adaptec Array Controller driver options
2955662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
2956662d3818SScott Long				# 0 - quiet, only emit warnings
2957662d3818SScott Long				# 1 - noisy, emit major function
2958662d3818SScott Long				#     points and things done
2959662d3818SScott Long				# 2 - extremely noisy, emit trace
2960662d3818SScott Long				#     items in loops, etc.
2961662d3818SScott Long
2962097055e2SEdward Tomasz Napierala# Resource Accounting
2963097055e2SEdward Tomasz Napieralaoptions 	RACCT
2964097055e2SEdward Tomasz Napierala
2965ec125fbbSEdward Tomasz Napierala# Resource Limits
2966ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
2967ec125fbbSEdward Tomasz Napierala
29681e9ea774SBruce Evans# Yet more undocumented options for linting.
29691e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
29701e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
29711e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
297225388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
297325388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
29741e9ea774SBruce Evansoptions 	MAXFILES=999
2975efba048eSXin LI
2976997b0a64SDag-Erling Smørgrav# Random number generator
297710cb2424SMark Murray# Only ONE of the below two may be used; they are mutually exclusive.
297810cb2424SMark Murrayoptions 	RANDOM_YARROW	# Yarrow CSPRNG (Default)
297910cb2424SMark Murray#options 	RANDOM_FORTUNA	# Fortuna CSPRNG
2980997b0a64SDag-Erling Smørgravoptions 	RANDOM_DEBUG	# Debugging messages
298181e3caafSJustin Hibbits
298281e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
298381e3caafSJustin Hibbitsoptions         IMAGACT_BINMISC
2984aa14e9b7SMark Johnston
298523c9098bSSean Bruno# Intel em(4) driver
298623c9098bSSean Brunooptions		EM_MULTIQUEUE # Activate multiqueue features/disable MSI-X
298723c9098bSSean Bruno
2988aa14e9b7SMark Johnston# zlib I/O stream support
2989aa14e9b7SMark Johnston# This enables support for compressed core dumps.
2990aa14e9b7SMark Johnstonoptions 	GZIO
2991