xref: /freebsd/sys/conf/NOTES (revision ec5753e0eb603044ff0b3aebf806a84f648c6671)
11519d15cSJohn Baldwin# $FreeBSD$
22365e64fSRodney W. Grimes#
319dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4f71c01ccSPeter Wemm#
5f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
61519d15cSJohn Baldwin# 'makeoptions', 'hints', etc. go into the kernel configuration that you
7f71c01ccSPeter Wemm# run config(8) with.
8f71c01ccSPeter Wemm#
9b147fcf9SBruce Evans# Lines that begin with 'hint.' are NOT for config(8), they go into your
10f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
112365e64fSRodney W. Grimes#
125d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
135d4850e7SAlexander Langer# do kernel test-builds.
145d4850e7SAlexander Langer#
15dd267672SJohn Baldwin# This file contains machine independent kernel configuration notes.  For
16dd267672SJohn Baldwin# machine dependent notes, look in /sys/<arch>/conf/NOTES.
17dd267672SJohn Baldwin#
181519d15cSJohn Baldwin
191519d15cSJohn Baldwin#
201519d15cSJohn Baldwin# NOTES conventions and style guide:
211519d15cSJohn Baldwin#
221519d15cSJohn Baldwin# Large block comments should begin and end with a line containing only a
231519d15cSJohn Baldwin# comment character.
241519d15cSJohn Baldwin#
251519d15cSJohn Baldwin# To describe a particular object, a block comment (if it exists) should
261519d15cSJohn Baldwin# come first.  Next should come device, options, and hints lines in that
271519d15cSJohn Baldwin# order.  All device and option lines must be described by a comment that
281519d15cSJohn Baldwin# doesn't just expand the device or option name.  Use only a concise
291519d15cSJohn Baldwin# comment on the same line if possible.  Very detailed descriptions of
301519d15cSJohn Baldwin# devices and subsystems belong in man pages.
311519d15cSJohn Baldwin#
32eb4f7a81SNate Lawson# A space followed by a tab separates 'options' from an option name.  Two
331519d15cSJohn Baldwin# spaces followed by a tab separate 'device' from a device name.  Comments
341519d15cSJohn Baldwin# after an option or device should use one space after the comment character.
351519d15cSJohn Baldwin# To comment out a negative option that disables code and thus should not be
36eb4f7a81SNate Lawson# enabled for LINT builds, precede 'options' with "#!".
372365e64fSRodney W. Grimes#
382365e64fSRodney W. Grimes
396a8d6623SGarrett Wollman#
406a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
416a8d6623SGarrett Wollman# be the same as the name of your kernel.
426a8d6623SGarrett Wollman#
436a8d6623SGarrett Wollmanident		LINT
446a8d6623SGarrett Wollman
456a8d6623SGarrett Wollman#
466a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
47ab0f83bdSRuslan Ermilov# internal system tables by a formula defined in subr_param.c.
48ab0f83bdSRuslan Ermilov# Omitting this parameter or setting it to 0 will cause the system to
49ab0f83bdSRuslan Ermilov# auto-size based on physical memory.
506a8d6623SGarrett Wollman#
516a8d6623SGarrett Wollmanmaxusers	10
526a8d6623SGarrett Wollman
5313c18821SJohn Baldwin# To statically compile in device wiring instead of /boot/device.hints
5413c18821SJohn Baldwin#hints		"LINT.hints"		# Default places to look for devices.
5513c18821SJohn Baldwin
5613c18821SJohn Baldwin# Use the following to compile in values accessible to the kernel
5713c18821SJohn Baldwin# through getenv() (or kenv(1) in userland). The format of the file
5813c18821SJohn Baldwin# is 'variable=value', see kenv(1)
5913c18821SJohn Baldwin#
6013c18821SJohn Baldwin#env		"LINT.env"
6113c18821SJohn Baldwin
626a8d6623SGarrett Wollman#
637bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
64503e6666SBruce Evans# generated Makefile in the build area.
65503e6666SBruce Evans#
66503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
67503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
681c9c6382SRuslan Ermilov# gcc built-in functions (e.g., memcmp).
69503e6666SBruce Evans#
70503e6666SBruce Evans# DEBUG happens to be magic.
717bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
727bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
737bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
747bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
757bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
767bf01a14SPeter Wemm#
772c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
782c8635c6SPeter Wemm# kernel.
792c8635c6SPeter Wemm#
800e3d06b1SWarner Losh# MODULES_OVERRIDE can be used to limit modules built to a specific list.
810e3d06b1SWarner Losh#
82503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
835895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
842c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
85f4eb4717SAlexander Leidinger# Only build ext2fs module plus those parts of the sound system I need.
86f4eb4717SAlexander Leidinger#makeoptions	MODULES_OVERRIDE="ext2fs sound/sound sound/driver/maestro3"
87fa75a3c2SPoul-Henning Kampmakeoptions	DESTDIR=/tmp
88fa75a3c2SPoul-Henning Kamp
893236b30eSGreg Lehey#
90480c6b8aSGreg Lehey# FreeBSD processes are subject to certain limits to their consumption
91480c6b8aSGreg Lehey# of system resources.  See getrlimit(2) for more details.  Each
92480c6b8aSGreg Lehey# resource limit has two values, a "soft" limit and a "hard" limit.
93480c6b8aSGreg Lehey# The soft limits can be modified during normal system operation, but
94480c6b8aSGreg Lehey# the hard limits are set at boot time.  Their default values are
95480c6b8aSGreg Lehey# in sys/<arch>/include/vmparam.h.  There are two ways to change them:
96480c6b8aSGreg Lehey#
97480c6b8aSGreg Lehey# 1.  Set the values at kernel build time.  The options below are one
98480c6b8aSGreg Lehey#     way to allow that limit to grow to 1GB.  They can be increased
99480c6b8aSGreg Lehey#     further by changing the parameters:
1003236b30eSGreg Lehey#
101480c6b8aSGreg Lehey# 2.  In /boot/loader.conf, set the tunables kern.maxswzone,
102480c6b8aSGreg Lehey#     kern.maxbcache, kern.maxtsiz, kern.dfldsiz, kern.maxdsiz,
103480c6b8aSGreg Lehey#     kern.dflssiz, kern.maxssiz and kern.sgrowsiz.
104a59d364aSMatthew Dillon#
105480c6b8aSGreg Lehey# The options in /boot/loader.conf override anything in the kernel
106480c6b8aSGreg Lehey# configuration file.  See the function init_param1 in
107480c6b8aSGreg Lehey# sys/kern/subr_param.c for more details.
1083236b30eSGreg Lehey#
109480c6b8aSGreg Lehey
1103236b30eSGreg Leheyoptions 	MAXDSIZ=(1024UL*1024*1024)
1113236b30eSGreg Leheyoptions 	MAXSSIZ=(128UL*1024*1024)
1123236b30eSGreg Leheyoptions 	DFLDSIZ=(1024UL*1024*1024)
1133236b30eSGreg Lehey
1143236b30eSGreg Lehey#
115a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
1163c7c6c12SMike Pritchard# device I/O.  Note that this value will be overridden by the label
117a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
1188b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
119a59d364aSMatthew Dillon#
120a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
121a59d364aSMatthew Dillon
122f9fbd1a4SMatt Jacob#
123f9fbd1a4SMatt Jacob# MAXPHYS and DFLTPHYS
124f9fbd1a4SMatt Jacob#
12550a8df3cSAlexander Motin# These are the maximal and safe 'raw' I/O block device access sizes.
12650a8df3cSAlexander Motin# Reads and writes will be split into MAXPHYS chunks for known good
12750a8df3cSAlexander Motin# devices and DFLTPHYS for the rest. Some applications have better
12850a8df3cSAlexander Motin# performance with larger raw I/O access sizes. Note that certain VM
129f9fbd1a4SMatt Jacob# parameters are derived from these values and making them too large
130af52cb44SSergey Kandaurov# can make an unbootable kernel.
131f9fbd1a4SMatt Jacob#
132f9fbd1a4SMatt Jacob# The defaults are 64K and 128K respectively.
133f9fbd1a4SMatt Jacoboptions 	DFLTPHYS=(64*1024)
134f9fbd1a4SMatt Jacoboptions 	MAXPHYS=(128*1024)
135f9fbd1a4SMatt Jacob
136f9fbd1a4SMatt Jacob
137827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
138272afb65SWojciech A. Koszek# the kernel binary itself. See config(8) for more details.
139827d623eSJordan K. Hubbard#
140827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
141827d623eSJordan K. Hubbard
14256fddc5dSBrooks Davis#
14356fddc5dSBrooks Davis# Compile-time defaults for various boot parameters
14456fddc5dSBrooks Davis#
14556fddc5dSBrooks Davisoptions 	BOOTVERBOSE=1
14656fddc5dSBrooks Davisoptions 	BOOTHOWTO=RB_MULTIPLE
14756fddc5dSBrooks Davis
148069accaaSPoul-Henning Kampoptions 	GEOM_AES		# Don't use, use GEOM_BDE
149069accaaSPoul-Henning Kampoptions 	GEOM_BDE		# Disk encryption.
150069accaaSPoul-Henning Kampoptions 	GEOM_BSD		# BSD disklabels
1515d9f25dcSRuslan Ermilovoptions 	GEOM_CACHE		# Disk cache.
1527226443dSPawel Jakub Dawidekoptions 	GEOM_CONCAT		# Disk concatenation.
1535ca1fcfeSPawel Jakub Dawidekoptions 	GEOM_ELI		# Disk encryption.
15422db1e9fSPoul-Henning Kampoptions 	GEOM_FOX		# Redundant path mitigation
1557226443dSPawel Jakub Dawidekoptions 	GEOM_GATE		# Userland services.
156f348204cSPawel Jakub Dawidekoptions 	GEOM_JOURNAL		# Journaling.
157e1237b28SPawel Jakub Dawidekoptions 	GEOM_LABEL		# Providers labelization.
1581669d8afSAndrew Thompsonoptions 	GEOM_LINUX_LVM		# Linux LVM2 volumes
159fcdb1ffcSAndrey V. Elsukovoptions 	GEOM_MAP		# Map based partitioning
160069accaaSPoul-Henning Kampoptions 	GEOM_MBR		# DOS/MBR partitioning
1618a8fbacaSPawel Jakub Dawidekoptions 	GEOM_MIRROR		# Disk mirroring.
162e770bc6bSMatt Jacoboptions 	GEOM_MULTIPATH		# Disk multipath
1637dc92b13SPawel Jakub Dawidekoptions 	GEOM_NOP		# Test class.
1641d3aed33SMarcel Moolenaaroptions 	GEOM_PART_APM		# Apple partitioning
1655aaa8fefSMarcel Moolenaaroptions 	GEOM_PART_BSD		# BSD disklabel
166d68d0cf5SAndrey V. Elsukovoptions 	GEOM_PART_BSD64		# BSD disklabel64
16791e1be8bSMarcel Moolenaaroptions 	GEOM_PART_EBR		# Extended Boot Records
1686ad9a99fSMarcel Moolenaaroptions 	GEOM_PART_EBR_COMPAT	# Backward compatible partition names
1691d3aed33SMarcel Moolenaaroptions 	GEOM_PART_GPT		# GPT partitioning
170e800e2e1SAndrey V. Elsukovoptions 	GEOM_PART_LDM		# Logical Disk Manager
1716bc50445SMarcel Moolenaaroptions 	GEOM_PART_MBR		# MBR partitioning
172b03fab12SMarcel Moolenaaroptions 	GEOM_PART_PC98		# PC-9800 disk partitioning
17310020e9dSMarcel Moolenaaroptions 	GEOM_PART_VTOC8		# SMI VTOC8 disk label
174069accaaSPoul-Henning Kampoptions 	GEOM_PC98		# NEC PC9800 partitioning
17589b17223SAlexander Motinoptions 	GEOM_RAID		# Soft RAID functionality.
176e81856c3SPawel Jakub Dawidekoptions 	GEOM_RAID3		# RAID3 functionality.
177560cb857SPawel Jakub Dawidekoptions 	GEOM_SHSEC		# Shared secret.
1787dc92b13SPawel Jakub Dawidekoptions 	GEOM_STRIPE		# Disk striping.
179069accaaSPoul-Henning Kampoptions 	GEOM_SUNLABEL		# Sun/Solaris partitioning
18075261008SMax Khonoptions 	GEOM_UZIP		# Read-only compressed disks
18102e17f0bSMarius Strobloptions 	GEOM_VINUM		# Vinum logical volume manager
182f854db0bSPawel Jakub Dawidekoptions 	GEOM_VIRSTOR		# Virtual storage.
183069accaaSPoul-Henning Kampoptions 	GEOM_VOL		# Volume names from UFS superblock
1841c9c6382SRuslan Ermilovoptions 	GEOM_ZERO		# Performance testing helper.
1857b03a440SPoul-Henning Kamp
1868b140d57SMike Smith#
1878b140d57SMike Smith# The root device and filesystem type can be compiled in;
1888b140d57SMike Smith# this provides a fallback option if the root device cannot
1893b6c640cSCrist J. Clark# be correctly guessed by the bootstrap code, or an override if
1908b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1918b140d57SMike Smith#
1928b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1938b140d57SMike Smith
1946a8d6623SGarrett Wollman
1956a8d6623SGarrett Wollman#####################################################################
196f5d05ac3SJeff Roberson# Scheduler options:
197f5d05ac3SJeff Roberson#
198a61617edSGiorgos Keramidas# Specifying one of SCHED_4BSD or SCHED_ULE is mandatory.  These options
199f5d05ac3SJeff Roberson# select which scheduler is compiled in.
200f5d05ac3SJeff Roberson#
201f5d05ac3SJeff Roberson# SCHED_4BSD is the historical, proven, BSD scheduler.  It has a global run
2021c9c6382SRuslan Ermilov# queue and no CPU affinity which makes it suboptimal for SMP.  It has very
203f5d05ac3SJeff Roberson# good interactivity and priority selection.
204f5d05ac3SJeff Roberson#
205bd675f58SJeff Roberson# SCHED_ULE provides significant performance advantages over 4BSD on many
206bd675f58SJeff Roberson# workloads on SMP machines.  It supports cpu-affinity, per-cpu runqueues
207bd675f58SJeff Roberson# and scheduler locks.  It also has a stronger notion of interactivity
208bd675f58SJeff Roberson# which leads to better responsiveness even on uniprocessor machines.  This
2099c0ef6d5SOliver Fromme# is the default scheduler.
210f5d05ac3SJeff Roberson#
21175a66a92SJeff Roberson# SCHED_STATS is a debugging option which keeps some stats in the sysctl
21275a66a92SJeff Roberson# tree at 'kern.sched.stats' and is useful for debugging scheduling decisions.
21375a66a92SJeff Roberson#
214b998bd92SJeff Robersonoptions 	SCHED_4BSD
21575a66a92SJeff Robersonoptions 	SCHED_STATS
216b998bd92SJeff Roberson#options 	SCHED_ULE
217f5d05ac3SJeff Roberson
218f5d05ac3SJeff Roberson#####################################################################
219477a642cSPeter Wemm# SMP OPTIONS:
220477a642cSPeter Wemm#
221477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
222477a642cSPeter Wemm
223477a642cSPeter Wemm# Mandatory:
224477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
225477a642cSPeter Wemm
226fdce57a0SJohn Baldwin# EARLY_AP_STARTUP releases the Application Processors earlier in the
227fdce57a0SJohn Baldwin# kernel startup process (before devices are probed) rather than at the
228fdce57a0SJohn Baldwin# end.  This is a temporary option for use during the transition from
229fdce57a0SJohn Baldwin# late to early AP startup.
230fdce57a0SJohn Baldwinoptions		EARLY_AP_STARTUP
231fdce57a0SJohn Baldwin
23268b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
23368b739cdSAttilio Rao# A default value should be already present, for every architecture.
23468b739cdSAttilio Raooptions 	MAXCPU=32
23568b739cdSAttilio Rao
236941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
237941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
23862d70a81SJohn Baldwinoptions 	MAXMEMDOM=2
23962d70a81SJohn Baldwin
24062d70a81SJohn Baldwin# VM_NUMA_ALLOC enables use of memory domain-aware allocation in the VM
24162d70a81SJohn Baldwin# system.
24262d70a81SJohn Baldwinoptions 	VM_NUMA_ALLOC
24362d70a81SJohn Baldwin
24462d70a81SJohn Baldwin# DEVICE_NUMA enables reporting of domain affinity of I/O devices via
24562d70a81SJohn Baldwin# bus_get_domain(), etc.
24662d70a81SJohn Baldwinoptions 	DEVICE_NUMA
247941646f5SAttilio Rao
2482498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2492498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
250d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
251701f1408SScott Long# to disable it.
252701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2532498cf8cSJohn Baldwin
254cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
255cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
256d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
257cd6e6e4eSJohn Baldwin# to disable it.
258cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
259cd6e6e4eSJohn Baldwin
2601ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2611ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
262d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2631ae1c2a3SAttilio Rao# disable it.
2641ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2654e7f640dSJohn Baldwin
266ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
267ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
268ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
269cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
270ad27c4c7SJohn Baldwin# and WITNESS options.
271ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
272ad27c4c7SJohn Baldwin
2731a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2741a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2751a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
276cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2771a5d9b15SJohn Baldwin# and WITNESS options.
2781a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2791a5d9b15SJohn Baldwin
2804e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2814e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2824e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2834e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2844e7f640dSJohn Baldwin# and WITNESS options.
2854e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2864e7f640dSJohn Baldwin
2871fe4c660SJohn Baldwin# SMP Debugging Options:
2881fe4c660SJohn Baldwin#
2895b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2905b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2915e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2925e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2935e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
29467ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2950c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2968c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2970c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2980c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2990c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
3009923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
301ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
30275a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
30375a66a92SJeff Roberson#	  frequency.
304ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
305ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
306c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
307c6111de5SDavide Italiano	  to hold active lock queues.
308aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
3091fe4c660SJohn Baldwin#         during locking operations.
310e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
3113c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
312660d1e3aSJohn Baldwin#	  sleep.
313660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
3149923b511SScott Longoptions 	PREEMPTION
3150c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
3161fe4c660SJohn Baldwinoptions 	WITNESS
317e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
318660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3191fe4c660SJohn Baldwin
320cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
32107dba937SKip Macyoptions 	LOCK_PROFILING
32200096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
32300096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
32400096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
32500096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3264db0d7f1SDag-Erling Smørgrav
3275b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3285b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3295b999a6bSDavide Italiano
330ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
331ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
332ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
333c6111de5SDavide Italianooptions 	UMTX_PROFILING
334331805a5SDavide Italiano
335ef0ebfc3SJohn Baldwin
336477a642cSPeter Wemm#####################################################################
3376a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
338690f540cSAndrey A. Chernov
3396a8d6623SGarrett Wollman#
3406a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
34156c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3427bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3437bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3447bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3457bbf05a2SJuli Mallett# signal delivery mechanism.
3466a8d6623SGarrett Wollman#
3475895e3c8SPeter Wemmoptions 	COMPAT_43
3486a8d6623SGarrett Wollman
349d3e64681SPoul-Henning Kamp# Old tty interface.
350d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
351d3e64681SPoul-Henning Kamp
352f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
353f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
354f5e4c105SJohn Baldwin
355f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
356f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
357f0eb293eSAlfred Perlstein
358a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
359a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
360a01b4125SKen Smith
3616c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3626c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3636c9fdda7SRuslan Ermilov
3645965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3655965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3665965c4b7SJohn Baldwin
3677d313e7bSJohn Baldwin# Enable FreeBSD9 compatibility syscalls
3687d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD9
3697d313e7bSJohn Baldwin
3707d313e7bSJohn Baldwin# Enable FreeBSD10 compatibility syscalls
3717d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD10
3727d313e7bSJohn Baldwin
3737f68a896SMark Johnston# Enable FreeBSD11 compatibility syscalls
3747f68a896SMark Johnstonoptions 	COMPAT_FREEBSD11
3757f68a896SMark Johnston
3768d59ecb2SHans Petter Selasky# Enable Linux Kernel Programming Interface
3778d59ecb2SHans Petter Selaskyoptions 	COMPAT_LINUXKPI
3788d59ecb2SHans Petter Selasky
3796a8d6623SGarrett Wollman#
3806a8d6623SGarrett Wollman# These three options provide support for System V Interface
3816a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3826a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3836a8d6623SGarrett Wollman#
3846a8d6623SGarrett Wollmanoptions 	SYSVSHM
3856a8d6623SGarrett Wollmanoptions 	SYSVSEM
3866a8d6623SGarrett Wollmanoptions 	SYSVMSG
3876a8d6623SGarrett Wollman
3886a8d6623SGarrett Wollman
3896a8d6623SGarrett Wollman#####################################################################
3906a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3916a8d6623SGarrett Wollman
3926a8d6623SGarrett Wollman#
393e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3946a8d6623SGarrett Wollman#
395e2ee2173SMarcel Moolenaaroptions 	KDB
396b5d89ca8SBruce Evans
397b5d89ca8SBruce Evans#
398e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3997085e708SBruce Evans#
400e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
401e2ee2173SMarcel Moolenaar
402e2ee2173SMarcel Moolenaar#
403e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
404e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
405e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
406e2ee2173SMarcel Moolenaar#
407e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
408e2ee2173SMarcel Moolenaar
409e2ee2173SMarcel Moolenaar#
410e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
411e2ee2173SMarcel Moolenaar#
412e2ee2173SMarcel Moolenaaroptions 	DDB
4137085e708SBruce Evans
4147085e708SBruce Evans#
415bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
416bfdd261eSBruce Evans# representation.
417bfdd261eSBruce Evans#
418bfdd261eSBruce Evansoptions 	DDB_NUMSYM
419bfdd261eSBruce Evans
420bfdd261eSBruce Evans#
421e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
4220be15decSJohn Baldwin#
423e2ee2173SMarcel Moolenaaroptions 	GDB
424562d05dfSPaul Traina
425562d05dfSPaul Traina#
426df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
427df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4281c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
429df970488SRobert Watson# interfere with serial console operation.
430df970488SRobert Watson#
431df970488SRobert Watsonoptions 	SYSCTL_DEBUG
432df970488SRobert Watson
433df970488SRobert Watson#
43421d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
43521d748a9SAlfred Perlstein#
43621d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
43721d748a9SAlfred Perlstein
43821d748a9SAlfred Perlstein#
43921d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
44021d748a9SAlfred Perlstein#
44121d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
44221d748a9SAlfred Perlstein
44321d748a9SAlfred Perlstein#
44431615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
44531615ef7SRebecca Cran# resulting kernel.
44631615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
44731615ef7SRebecca Cran
44831615ef7SRebecca Cran#
449d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
450d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
451d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
452d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
453d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
454d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
455d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
456d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
457d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
458d7854da1SMatthew D Fleming# code.
459d7854da1SMatthew D Fleming#
460d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
461d7854da1SMatthew D Fleming
462d7854da1SMatthew D Fleming#
463e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
464e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
465e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
466e4eb384bSBosko Milekic#
467e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
468e4eb384bSBosko Milekic
469e4eb384bSBosko Milekic#
470847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
471847a2a17SPawel Jakub Dawidek# malloc(9).
472847a2a17SPawel Jakub Dawidek#
473847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
474847a2a17SPawel Jakub Dawidek
475847a2a17SPawel Jakub Dawidek#
476e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
477e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
478e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
479e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
480e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
481e79f350dSWarner Losh#
482e79f350dSWarner Losh#options	EARLY_PRINTF
483e79f350dSWarner Losh
484e79f350dSWarner Losh#
485ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
486ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
487ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
488ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
489ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
490ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
491ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4926a8d6623SGarrett Wollman#
4932365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
494ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
49521c64a07SAndrey A. Chernov
4966a8d6623SGarrett Wollman#
497f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
498a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
4996e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
50036b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
50136b7dde4SAndriy Gapon# before malloc(9) is functional.
502a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
503a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
504a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
505a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
506e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
507d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
508d4a2ab8cSAttilio Rao# separated by the "," character (ie:
509d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
510a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
511a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
512f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
513c508c1b6SJohn Baldwin#
514c508c1b6SJohn Baldwinoptions 	KTR
51536b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
51636b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
5176740ed37SGleb Smirnoffoptions 	KTR_COMPILE=(KTR_ALL)
518a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
519d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
520d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
521c508c1b6SJohn Baldwin
522c508c1b6SJohn Baldwin#
5231c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
524f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
525453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
526453ffeefSRobert Watson# in a worker thread.
527453ffeefSRobert Watson#
528453ffeefSRobert Watsonoptions 	ALQ
529453ffeefSRobert Watsonoptions 	KTR_ALQ
530453ffeefSRobert Watson
531453ffeefSRobert Watson#
5325526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5336a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5346a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5356a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5366a8d6623SGarrett Wollman# programming errors.
5376a8d6623SGarrett Wollman#
5385526d2d9SEivind Eklundoptions 	INVARIANTS
5395526d2d9SEivind Eklund
5405526d2d9SEivind Eklund#
54134b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
54234b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
54334b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
54434b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
54534b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
54634b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
54734b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
54834b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
54934b15f2aSJohn Baldwin# infrastructure without the added overhead.
55034b15f2aSJohn Baldwin#
55134b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
55234b15f2aSJohn Baldwin
55334b15f2aSJohn Baldwin#
5545526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
5555526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
5565526d2d9SEivind Eklund# it is disabled by default.
5575526d2d9SEivind Eklund#
5580dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
559da59a31cSDavid Greenman
5600dd1eea1SJordan K. Hubbard#
5610b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5623c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5630b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5640b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5650b5438c6SRobert Watson# impossible) scenarios.
5660b5438c6SRobert Watson#
5670b5438c6SRobert Watsonoptions 	REGRESSION
5680b5438c6SRobert Watson
5690b5438c6SRobert Watson#
5709c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
571346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
572346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
573346ebe51SEivind Eklund# from.)
574346ebe51SEivind Eklund#
575346ebe51SEivind Eklundoptions 	COMPILING_LINT
576346ebe51SEivind Eklund
5773c90d1eaSRobert Watson#
5783c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5793c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5803c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5813c90d1eaSRobert Watson#
5823c90d1eaSRobert Watsonoptions 	STACK
5833c90d1eaSRobert Watson
584cc37baeaSStephen J. Kiernan#
585cc37baeaSStephen J. Kiernan# The NUM_CORE_FILES option specifies the limit for the number of core
586cc37baeaSStephen J. Kiernan# files generated by a particular process, when the core file format
587cc37baeaSStephen J. Kiernan# specifier includes the %I pattern. Since we only have 1 character for
588cc37baeaSStephen J. Kiernan# the core count in the format string, meaning the range will be 0-9, the
589cc37baeaSStephen J. Kiernan# maximum value allowed for this option is 10.
590cc37baeaSStephen J. Kiernan# This core file limit can be adjusted at runtime via the debug.ncores
591cc37baeaSStephen J. Kiernan# sysctl.
592cc37baeaSStephen J. Kiernan#
593cc37baeaSStephen J. Kiernanoptions 	NUM_CORE_FILES=5
594cc37baeaSStephen J. Kiernan
5956a8d6623SGarrett Wollman
5966a8d6623SGarrett Wollman#####################################################################
597d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
598d47cce3eSMarcel Moolenaar
599d47cce3eSMarcel Moolenaar#
600d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
6019c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
602d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
603d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
604d47cce3eSMarcel Moolenaar#
605ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
606ad3869b4SJoseph Koshy# please see hwpmc(4).
607ad3869b4SJoseph Koshy
608d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
609680f1afdSJohn Baldwinoptions 	HWPMC_DEBUG
610d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
611d47cce3eSMarcel Moolenaar
612d47cce3eSMarcel Moolenaar
613d47cce3eSMarcel Moolenaar#####################################################################
6146a8d6623SGarrett Wollman# NETWORKING OPTIONS
61570c0b54cSAndrey A. Chernov
6166a8d6623SGarrett Wollman#
617a22fb0daSGeorge V. Neville-Neil# Protocol families
6186a8d6623SGarrett Wollman#
6196a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
62051f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
621a22fb0daSGeorge V. Neville-Neil
622f3e7afe2SHans Petter Selaskyoptions		RATELIMIT		# TX rate limiting support
623f3e7afe2SHans Petter Selasky
6244871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
6254871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
6268b07e49aSJulian Elischer
62709fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
62809fe6320SNavdeep Parhar
629a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
630a22fb0daSGeorge V. Neville-Neil# your kernel configuration
631a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
6322cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
63314dd6717SSam Leffler#
6347b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
6357b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
6367b495c44SVANHULLEBUS Yvan#
6377b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
638f73bbaf2SDavid Greenman
639237abf0cSDavide Italiano#
640237abf0cSDavide Italiano# SMB/CIFS requester
641237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
642237abf0cSDavide Italiano# options.
643237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
644237abf0cSDavide Italiano
645d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
646d8589bd5SBoris Popovoptions 	LIBMCHAIN
647d8589bd5SBoris Popov
6486cd047a0SGleb Smirnoff# libalias library, performing NAT
6496cd047a0SGleb Smirnoffoptions 	LIBALIAS
6506cd047a0SGleb Smirnoff
65134b07340SKip Macy# flowtable cache
65234b07340SKip Macyoptions 	FLOWTABLE
65334b07340SKip Macy
654f8829a4aSRandall Stewart#
655f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
656f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
657f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
658f8829a4aSRandall Stewart# extensions. This release supports all the extensions
659f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6609c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
661f8829a4aSRandall Stewart# and is quite well tested.
662f8829a4aSRandall Stewart#
663f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6649c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6659c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
666f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
667f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
668f8829a4aSRandall Stewart#
669f8829a4aSRandall Stewartoptions 	SCTP
670f8829a4aSRandall Stewart# There are bunches of options:
671f8829a4aSRandall Stewart# this one turns on all sorts of
672d51e8487SJosh Paetzel# nastily printing that you can
6739c0ef6d5SOliver Fromme# do. It's all controlled by a
674f8829a4aSRandall Stewart# bit mask (settable by socket opt and
675f8829a4aSRandall Stewart# by sysctl). Including will not cause
676f8829a4aSRandall Stewart# logging until you set the bits.. but it
677f8829a4aSRandall Stewart# can be quite verbose.. so without this
678f8829a4aSRandall Stewart# option we don't do any of the tests for
679f8829a4aSRandall Stewart# bits and prints.. which makes the code run
680f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
681f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
682f8829a4aSRandall Stewart#
6839c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6849c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6859c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
686f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
687f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
688f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
689f8829a4aSRandall Stewart# like with such an offload (which only exists in
690f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
691f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
692f8829a4aSRandall Stewart# to be.. but it does speed things up try only
693f8829a4aSRandall Stewart# for in a captured lab environment :-)
694f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
695f8829a4aSRandall Stewart#
696cb7a4976SRandall Stewart
697f8829a4aSRandall Stewart#
698f8829a4aSRandall Stewart# All that options after that turn on specific types of
699f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
700f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
701f8829a4aSRandall Stewart# see. I have used this to produce interesting
702f8829a4aSRandall Stewart# charts and graphs as well :->
703f8829a4aSRandall Stewart#
7049c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
705f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
706f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
707f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
708cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
709f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
7109c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
711cb7a4976SRandall Stewart# things too.
712f8829a4aSRandall Stewart#
713f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
714f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
715cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
716cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
717cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
718cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
719cb7a4976SRandall Stewart
720f8829a4aSRandall Stewart
72102b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
72202b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
723cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
724cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
725cceffdeeSAndrew Thompson# option.
72602b199f1SMax Laieroptions 	ALTQ
727755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
728c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
72902b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
730a13bfb09SLuiz Otavio O Souzaoptions 	ALTQ_CODEL	# CoDel Active Queueing
73102b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
732a5b789f6SErmal Luçioptions 	ALTQ_FAIRQ	# Fair Packet Scheduler
73302b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7343c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
735cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
73602b199f1SMax Laieroptions 	ALTQ_DEBUG
73702b199f1SMax Laier
7384cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7394cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7404cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7414cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
74292a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
74392a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7444cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
74573e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
74673e87266SGleb Smirnoff					# affects netgraph(4) and nodes
74773e87266SGleb Smirnoff# Node types
7484cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
749bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
750b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
751b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
752b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
753b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
754b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
755b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
756b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
757b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
75892a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
759901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7607d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
7614cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7629e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
76331578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7644cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7659d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
76646aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
7674cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
76837379158SBrooks Davisoptions 	NETGRAPH_GIF
76937379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7704cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7714cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
77237379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
773f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
77448e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
775901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7764cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
777*ec5753e0SPedro F. Giffunioptions 	NETGRAPH_MPPC_COMPRESSION
778a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
779cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7806cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7817d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
782d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
783991633afSMarko Zecoptions 	NETGRAPH_PIPE
784b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
785b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
786add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7879e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7884cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
789b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7904d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7910a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
792d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
793e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7944cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7954cf49a43SJulian Elischeroptions 	NETGRAPH_UI
796b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
797b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
798666ea1b6SMaksim Yevmenkin
79902152e8fSHartmut Brandt# NgATM - Netgraph ATM
80002152e8fSHartmut Brandtoptions 	NGATM_ATM
801027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
802027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
803027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
804ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
805a7e22394SHartmut Brandtoptions 	NGATM_CCATM
80602152e8fSHartmut Brandt
807c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
8083cf4d0bfSPoul-Henning Kamp
8090990ef0aSKevin Lo# Network stack virtualization.
810287cd4a2SKevin Lo#options	VIMAGE
811287cd4a2SKevin Lo#options	VNET_DEBUG	# debug for VIMAGE
8120990ef0aSKevin Lo
8136a8d6623SGarrett Wollman#
8146a8d6623SGarrett Wollman# Network interfaces:
815f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
81636782d14SWojciech A. Koszekdevice		loop
81736782d14SWojciech A. Koszek
818f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
8199d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
820722012ccSJulian Elischer#  configured or token-ring is enabled.
82136782d14SWojciech A. Koszekdevice		ether
82236782d14SWojciech A. Koszek
823fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
8249d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
82536782d14SWojciech A. Koszekdevice		vlan
82636782d14SWojciech A. Koszek
827007054f0SBryan Venteicher# The `vxlan' device implements the VXLAN encapsulation of Ethernet
828007054f0SBryan Venteicher# frames in UDP packets according to RFC7348.
829007054f0SBryan Venteicherdevice		vxlan
830007054f0SBryan Venteicher
83157a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
83267e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
833f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
83436782d14SWojciech A. Koszekdevice		wlan
83536782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
83636782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
83759aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
83859aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
83936782d14SWojciech A. Koszek
84067e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
84167e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
84267e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
84336782d14SWojciech A. Koszekdevice		wlan_wep
84436782d14SWojciech A. Koszekdevice		wlan_ccmp
84536782d14SWojciech A. Koszekdevice		wlan_tkip
84636782d14SWojciech A. Koszek
84767e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
84867e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
84934341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
85036782d14SWojciech A. Koszekdevice		wlan_xauth
85136782d14SWojciech A. Koszek
85267e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
85367e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
85467e4db77SSam Leffler#  `wlan' module.
85536782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
85636782d14SWojciech A. Koszekdevice		wlan_acl
85736782d14SWojciech A. Koszekdevice		wlan_amrr
85836782d14SWojciech A. Koszek
85936782d14SWojciech A. Koszek# Generic TokenRing
86036782d14SWojciech A. Koszekdevice		token
86136782d14SWojciech A. Koszek
8621a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
86336782d14SWojciech A. Koszekdevice		fddi
86436782d14SWojciech A. Koszek
865eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
86636782d14SWojciech A. Koszekdevice		arcnet
86736782d14SWojciech A. Koszek
868f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
869e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
87036782d14SWojciech A. Koszekdevice		sppp
87136782d14SWojciech A. Koszek
872f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
873d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8749c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
87536782d14SWojciech A. Koszekdevice		bpf
87636782d14SWojciech A. Koszek
877e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
878e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
879e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
880e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
881e4b68814SLuigi Rizzodevice		netmap
882e4b68814SLuigi Rizzo
883f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
88459d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
88570e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
88636782d14SWojciech A. Koszekdevice		disc
88736782d14SWojciech A. Koszek
888d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
889d0ea4743SBjoern A. Zeeb# like interface pair.
890d0ea4743SBjoern A. Zeebdevice		epair
891d0ea4743SBjoern A. Zeeb
89263518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
89363518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
89436782d14SWojciech A. Koszekdevice		edsc
89536782d14SWojciech A. Koszek
8964c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
89736782d14SWojciech A. Koszekdevice		tap
89836782d14SWojciech A. Koszek
89936782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
90036782d14SWojciech A. Koszekdevice		tun
90136782d14SWojciech A. Koszek
902f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
903cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
904cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
905f325335cSAndrey V. Elsukov#  The `gre' device implements GRE (Generic Routing Encapsulation) tunneling,
906f325335cSAndrey V. Elsukov#  as specified in the RFC 2784 and RFC 2890.
907f325335cSAndrey V. Elsukov#  The `me' device implements Minimal Encapsulation within IPv4 as
908f325335cSAndrey V. Elsukov#  specified in the RFC 2004.
909f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
910f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
91136782d14SWojciech A. Koszekdevice		gif
91236782d14SWojciech A. Koszekdevice		gre
913f325335cSAndrey V. Elsukovdevice		me
91436782d14SWojciech A. Koszekoptions 	XBONEHACK
91536782d14SWojciech A. Koszek
916d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
91736782d14SWojciech A. Koszekdevice		stf
91836782d14SWojciech A. Koszek
9198d69c48bSMax Laier# The pf packet filter consists of three devices:
9208d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
9218d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
9228d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
9238d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
92436782d14SWojciech A. Koszekdevice		pf
92536782d14SWojciech A. Koszekdevice		pflog
92636782d14SWojciech A. Koszekdevice		pfsync
92736782d14SWojciech A. Koszek
92836782d14SWojciech A. Koszek# Bridge interface.
92936782d14SWojciech A. Koszekdevice		if_bridge
93036782d14SWojciech A. Koszek
93136782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
93236782d14SWojciech A. Koszekdevice		carp
93336782d14SWojciech A. Koszek
93436782d14SWojciech A. Koszek# IPsec interface.
93536782d14SWojciech A. Koszekdevice		enc
93636782d14SWojciech A. Koszek
93736782d14SWojciech A. Koszek# Link aggregation interface.
93836782d14SWojciech A. Koszekdevice		lagg
93936782d14SWojciech A. Koszek
9408d69c48bSMax Laier#
9416a8d6623SGarrett Wollman# Internet family options:
9426a8d6623SGarrett Wollman#
9436a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9440948f0a2SBruce M Simpson# with mrouted and XORP.
945e0f688baSJeffrey Hsu#
946d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
947ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
948ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
949ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
950ab6e02daSJordan K. Hubbard#
951ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
952ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
953a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
954ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
955ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
956ab6e02daSJordan K. Hubbard# feature works properly.
9578dd4744eSJordan K. Hubbard#
958ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
959ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
960ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
961ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
962ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
963ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
964ffdd472dSPeter Wemm# out of sync.
965d29895dcSGarrett Wollman#
96684bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
96784bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
96893e0e116SJulian Elischer#
96961c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
970531c890bSPaolo Pisati# LIBALIAS.
97161c0e134SPaolo Pisati#
972d8caf56eSAndrey V. Elsukov# IPFIREWALL_NAT64 adds support for in kernel NAT64 in ipfw.
973d8caf56eSAndrey V. Elsukov#
974b867e84eSAndrey V. Elsukov# IPFIREWALL_NPTV6 adds support for in kernel NPTv6 in ipfw.
975b867e84eSAndrey V. Elsukov#
9761b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9771c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9781b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9791b968362SDag-Erling Smørgrav#
9807f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9817f7ef494SGleb Smirnoff#
9825e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9835e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9845e331acdSGarrett Wollman# using the trpt(8) utility.
98565e8111fSBruce Evans#
98686a996e6SHiren Panchasara# TCPPCAP enables code which keeps the last n packets sent and received
98786a996e6SHiren Panchasara# on a TCP socket.
98886a996e6SHiren Panchasara#
989bd79708dSJonathan T. Looney# TCP_HHOOK enables the hhook(9) framework hooks for the TCP stack.
990bd79708dSJonathan T. Looney#
99165e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9929731596aSGleb Smirnoff#
993e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
994d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9954479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9965895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
997e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
99861c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
999d8caf56eSAndrey V. Elsukovoptions 	IPFIREWALL_NAT64	#ipfw kernel NAT64 support
1000b867e84eSAndrey V. Elsukovoptions 	IPFIREWALL_NPTV6	#ipfw kernel IPv6 NPT support
100193e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
10029cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
10039cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
10040c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
10058259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
10061b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
10077f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
100865e8111fSBruce Evansoptions 	TCPDEBUG
100986a996e6SHiren Panchasaraoptions 	TCPPCAP
1010bd79708dSJonathan T. Looneyoptions 	TCP_HHOOK
10119731596aSGleb Smirnoffoptions 	RADIX_MPATH
10126a8d6623SGarrett Wollman
101353dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
101453dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
1015f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
10164e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
10176eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
10186eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
10196eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
102053dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
10216eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
10224a5ccac7SMike Silbersack
10239c0ef6d5SOliver Fromme# Statically link in accept filters
1024a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
1025744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
1026a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
1027a79b7128SAlfred Perlstein
1028b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
1029b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
1030b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
1031b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
1032b65946c6SJohn-Mark Gurney# This requires the use of 'device crypto' and 'options IPSEC'.
10335164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
1034b52f8407SBruce M Simpson
1035f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
1036f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
1037358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
1038358f8d82SRobert Watson# a smooth scheduling of the traffic.
103968ec4eb6SLuigi Rizzooptions 	DUMMYNET
104068e9d934SLuigi Rizzo
10416a8d6623SGarrett Wollman#####################################################################
10426a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1043e3178a06SJordan K. Hubbard
10442365e64fSRodney W. Grimes#
10453f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10463f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10473f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10483f850e6aSKonstantin Belousov# filesystems as well.
10496a8d6623SGarrett Wollman#
105055793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1051534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1052534046e3SRong-En Fan# resolved.
10532365e64fSRodney W. Grimes#
1054f1a9c715SDavid Greenman
10556a8d6623SGarrett Wollman# One of these is mandatory:
10566a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1057c15882f0SRick Macklemoptions 	NFSCL			#Network File System client
10586a8d6623SGarrett Wollman
10596a8d6623SGarrett Wollman# The rest are optional:
10603914ddf8SEdward Tomasz Napieralaoptions 	AUTOFS			#Automounter filesystem
10615895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
106299d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
10635fe58019SAttilio Raooptions 	FUSE			#FUSE support module
1064dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1065dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10663e32dff5SJohn Baldwinoptions 	NFSD			#Network Filesystem Server
10679c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10681bea7c61SMaxim Sobolev
1069f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10704d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
107152ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1072bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1073237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
107478920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1075df263cbdSScott Longoptions 	UDF			#Universal Disk Format
107699d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1077bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1078bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1079f1a9c715SDavid Greenman
1080d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1081d61e6649SAlexander Langer# making abrupt shutdown less risky.
1082f8f8d7afSEivind Eklund#
10833d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1084b1897c19SJulian Elischer
1085a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
108651be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
108751be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
108849993db0SRobert Watsonoptions 	UFS_EXTATTR
108949993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1090a64ed089SRobert Watson
109151be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
109251be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
109351be6918SChris D. Faulhaber# for the underlying filesystem.
109451be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
109551be6918SChris D. Faulhaberoptions 	UFS_ACL
109651be6918SChris D. Faulhaber
10979b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10989b5ad47fSIan Dowse# directories at the expense of some memory.
10999b5ad47fSIan Dowseoptions 	UFS_DIRHASH
11009b5ad47fSIan Dowse
1101f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1102f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1103f348204cSPawel Jakub Dawidek
110471e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
110571e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
1106f4c1f0b9SAdrian Chadd# This is now optional.
1107f4c1f0b9SAdrian Chadd# If not defined, the root filesystem passed in as the MFS_IMAGE makeoption
1108f4c1f0b9SAdrian Chadd# will be automatically embedded in the kernel during linking. Its exact size
1109f4c1f0b9SAdrian Chadd# will be consumed within the kernel.
1110f4c1f0b9SAdrian Chadd# If defined, the old way of embedding the filesystem in the kernel will be
1111f4c1f0b9SAdrian Chadd# used. That is to say MD_ROOT_SIZE KB will be allocated in the kernel and
1112f4c1f0b9SAdrian Chadd# later, the filesystem image passed in as the MFS_IMAGE makeoption will be
1113f4c1f0b9SAdrian Chadd# dd'd into the reserved space if it fits.
111471e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
111571e4fff8SPoul-Henning Kamp
111671e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
111771e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
111871e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1119d52d7365SPoul-Henning Kamp
1120495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
11212365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
11226a8d6623SGarrett Wollman
1123276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
112445c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1125276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1126276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1127ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
11286110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1129276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1130276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
11319c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1132276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1133276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1134276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1135cb800e34SJulian Elischer#
1136cb800e34SJulian Elischeroptions 	SUIDDIR
1137cb800e34SJulian Elischer
1138df394affSJohn-Mark Gurney# NFS options:
11395895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
11405895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
11415895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
11425895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
1143df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1144df394affSJohn-Mark Gurney
1145053a2b61SEivind Eklund#
1146053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1147053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1148053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1149053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1150053a2b61SEivind Eklund#
11515895e3c8SPeter Wemmoptions 	EXT2FS
1152053a2b61SEivind Eklund
11538ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1154ac519db0SMark Murraydevice		random
115515bbdecfSMark Murray
11568ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1157e83e229dSWarner Loshdevice		mem
11588ab2f5ecSMark Murray
115900a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
116000a5db46SStacey Sondevice		ksyms
116100a5db46SStacey Son
1162c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1163c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1164c4f02a89SMax Khonoptions 	CD9660_ICONV
1165c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1166126f0dfaSScott Longoptions 	UDF_ICONV
1167c4f02a89SMax Khon
11686a8d6623SGarrett Wollman
11696a8d6623SGarrett Wollman#####################################################################
1170abc97a06SBruce Evans# POSIX P1003.1B
1171abc97a06SBruce Evans
11721c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1173abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1174abc97a06SBruce Evans
11755895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11768cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11778cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11783ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1179abc97a06SBruce Evans
11805b40ce27SDavid Xu# POSIX message queue
11815b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1182abc97a06SBruce Evans
1183abc97a06SBruce Evans#####################################################################
118412e9f256SRobert Watson# SECURITY POLICY PARAMETERS
118512e9f256SRobert Watson
1186fdcba197SRobert Watson# Support for BSM audit
1187fdcba197SRobert Watsonoptions 	AUDIT
1188fdcba197SRobert Watson
1189cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1190cd6d1d76SBruce Evansoptions 	MAC
1191eae2f20cSRobert Watsonoptions 	MAC_BIBA
1192eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1193eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1194c4725737SRobert Watsonoptions 	MAC_LOMAC
1195eae2f20cSRobert Watsonoptions 	MAC_MLS
1196eae2f20cSRobert Watsonoptions 	MAC_NONE
1197eae2f20cSRobert Watsonoptions 	MAC_PARTITION
119803d03162SRobert Watsonoptions 	MAC_PORTACL
1199eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1200782f7255SRobert Watsonoptions 	MAC_STUB
1201eae2f20cSRobert Watsonoptions 	MAC_TEST
120212e9f256SRobert Watson
120396fcc75fSRobert Watson# Support for Capsicum
120455d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
120555d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
120696fcc75fSRobert Watson
120712e9f256SRobert Watson
120812e9f256SRobert Watson#####################################################################
1209000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1210000033d0SJeroen Ruigrok van der Werven
1211000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1212358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1213358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1214358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1215358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1216358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1217358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1218358f8d82SRobert Watson# actually reducing the accuracy of operation.
1219000033d0SJeroen Ruigrok van der Werven
1220000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1221000033d0SJeroen Ruigrok van der Werven
1222f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1223f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1224f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1225f309f881SJohn Baldwin
1226f309f881SJohn Baldwinoptions 	PPS_SYNC
1227f309f881SJohn Baldwin
1228b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1229b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1230b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1231b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1232b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1233b0fdc837SLawrence Stewart
1234b0fdc837SLawrence Stewartoptions 	FFCLOCK
1235b0fdc837SLawrence Stewart
1236000033d0SJeroen Ruigrok van der Werven
1237000033d0SJeroen Ruigrok van der Werven#####################################################################
1238de6a307eSPeter Dufault# SCSI DEVICES
1239de6a307eSPeter Dufault
12406a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12416a8d6623SGarrett Wollman
12426a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1243ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12446a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12456a8d6623SGarrett Wollman# device configuration sections below.
12466a8d6623SGarrett Wollman#
1247e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1248e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1249e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1250e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1251e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1252e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1253e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1254e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1255e14eb5a1SGarrett Wollman# problem.)
1256ebc1a0e2SPeter Dufault
1257ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1258ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1259700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1260700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1261ebc1a0e2SPeter Dufault
1262ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1263ebc1a0e2SPeter Dufault
1264f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1265f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1266f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1267f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1268f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1269f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1270f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1271f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1272f71c01ccSPeter Wemmhint.da.0.target="0"
1273f71c01ccSPeter Wemmhint.da.0.unit="0"
1274f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1275f71c01ccSPeter Wemmhint.da.1.target="1"
1276f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1277f71c01ccSPeter Wemmhint.da.2.target="3"
1278f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1279f71c01ccSPeter Wemmhint.sa.1.target="6"
1280ebc1a0e2SPeter Dufault
1281ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1282ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1283ebc1a0e2SPeter Dufault
1284ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1285ebc1a0e2SPeter Dufault
1286cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1287cf2458c9SMatt Jacob#
1288cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1289cf2458c9SMatt Jacob# ("WORM") devices.
1290cf2458c9SMatt Jacob#
1291cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1292cf2458c9SMatt Jacob#
1293cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1294cf2458c9SMatt Jacob#
12953c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12963c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1297cf2458c9SMatt Jacob#
1298cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1299cf2458c9SMatt Jacob#
13001eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
13011eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
13021eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1303d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1304cf2458c9SMatt Jacob#
1305cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1306cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1307cf2458c9SMatt Jacob#
1308cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1309cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1310cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1311cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1312cf2458c9SMatt Jacob#
1313cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1314cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1315cf2458c9SMatt Jacob# to them.
1316cf2458c9SMatt Jacob#
1317b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1318ebc1a0e2SPeter Dufault
1319c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1320c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1321c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1322c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1323c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1324dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1325cf2458c9SMatt Jacobdevice		pt		#SCSI processor
132664ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
132764ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1328cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13291eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1330130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13318909a72bSPeter Dufault
1332700daf5eSJustin T. Gibbs# CAM OPTIONS:
1333700daf5eSJustin T. Gibbs# debugging options:
1334f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1335f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1336f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1337f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1338f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1339f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1340f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1341700daf5eSJustin T. Gibbs#
1342700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1343700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1344700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
134556234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
134656234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13473a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13483a937198SBrooks Davis#             can be changed at boot and runtime with the
13493a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1350700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1351f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1352f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13535895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13545895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13555895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1356f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13575895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1358700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1359700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
136032672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
1361a25d93e5SBjoern A. Zeeboptions 	CAM_IOSCHED_DYNAMIC
13621a7c583cSGarrett Wollman
1363700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1364700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1365700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1366700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1367700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1368700daf5eSJustin T. Gibbs# respectively.
136993063432SJoerg Wunsch#
1370700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1371700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1372700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
137393063432SJoerg Wunsch#
13745895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13755895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
137693063432SJoerg Wunsch
13779dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1378b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13799dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13809dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13819dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13829f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
138325388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
138425388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
138525388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
138625388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13879f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13889dfb4471SKenneth D. Merry
13893ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13903ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
139125388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13923ece1bd2SKenneth D. Merry
13938904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13948904e70bSMatt Jacob#
13958904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13968904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13979c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13988904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13998904e70bSMatt Jacob
14006a8d6623SGarrett Wollman
14016a8d6623SGarrett Wollman#####################################################################
14026a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
14036a8d6623SGarrett Wollman
1404bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
14056d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1406f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1407932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1408efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
14096aec1278SMax Laierdevice		firmware	#firmware(9) support
1410be174c7eSGreg Lehey
14116f2d8adbSBoris Popov# Kernel side iconv library
14126f2d8adbSBoris Popovoptions 	LIBICONV
14136f2d8adbSBoris Popov
141458067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
14155895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
141658067a99SPoul-Henning Kamp
14176a8d6623SGarrett Wollman
14186a8d6623SGarrett Wollman#####################################################################
1419e131ba36SJohn Baldwin# HARDWARE BUS CONFIGURATION
1420e131ba36SJohn Baldwin
1421e131ba36SJohn Baldwin#
1422e131ba36SJohn Baldwin# PCI bus & PCI options:
1423e131ba36SJohn Baldwin#
1424e131ba36SJohn Baldwindevice		pci
142582cb5c3bSJohn Baldwinoptions 	PCI_HP			# PCI-Express native HotPlug
1426c41df401SJohn Baldwinoptions 	PCI_IOV			# PCI SR-IOV support
1427e131ba36SJohn Baldwin
1428e131ba36SJohn Baldwin
1429e131ba36SJohn Baldwin#####################################################################
1430d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1431d61e6649SAlexander Langer
1432d61e6649SAlexander Langer# For ISA the required hints are listed.
14335bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
14345bcb64f2SWarner Losh# no hints are needed.
1435d61e6649SAlexander Langer
1436d61e6649SAlexander Langer#
1437d61e6649SAlexander Langer# Mandatory devices:
1438d61e6649SAlexander Langer#
1439d61e6649SAlexander Langer
14406e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
14416e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
14426e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
14436e818956SDavid E. O'Brien
144446360281SEd Mastedevice		kbdmux			# keyboard multiplexer
144546360281SEd Masteoptions		KBDMUX_DFLT_KEYMAP	# specify the built-in keymap
144646360281SEd Mastemakeoptions	KBDMUX_DFLT_KEYMAP=it.iso
144746360281SEd Maste
14487f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
14497f5092f3SJohn Baldwin
1450837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1451837f167eSRuslan Ermilov
1452905e8b43SDag-Erling Smørgrav# Various screen savers.
1453905e8b43SDag-Erling Smørgravdevice		blank_saver
1454905e8b43SDag-Erling Smørgravdevice		daemon_saver
1455905e8b43SDag-Erling Smørgravdevice		dragon_saver
1456905e8b43SDag-Erling Smørgravdevice		fade_saver
1457905e8b43SDag-Erling Smørgravdevice		fire_saver
1458905e8b43SDag-Erling Smørgravdevice		green_saver
1459905e8b43SDag-Erling Smørgravdevice		logo_saver
1460905e8b43SDag-Erling Smørgravdevice		rain_saver
1461905e8b43SDag-Erling Smørgravdevice		snake_saver
1462905e8b43SDag-Erling Smørgravdevice		star_saver
1463905e8b43SDag-Erling Smørgravdevice		warp_saver
1464905e8b43SDag-Erling Smørgrav
14651c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1466f453022cSPeter Wemmdevice		sc
1467f71c01ccSPeter Wemmhint.sc.0.at="isa"
1468683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14696e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14706e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1471cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1472e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1473c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14746e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14756e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14766e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
147785e36760SJordan K. Hubbard
14787a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
147925388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
148025388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
148125388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
148225388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14837a88382dSKazutaka YOKOTA
1484d51e8487SJosh Paetzel# The following options will let you change the default behavior of
148578f45204SMaxim Sobolev# cut-n-paste feature
148678f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
148725388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
148825388b6cSBruce Evans					# (default is single space - \"x20\")
148978f45204SMaxim Sobolev
14907a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14917a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14927a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14937a88382dSKazutaka YOKOTA
14946e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14956e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14966e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14976e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14986e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14996e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1500c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
15012ac8be82SAndreas Schulz
15028a28ce0eSJohn Baldwin# `flags' for sc
15038a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
15048a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
15058a28ce0eSJohn Baldwin
150683409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1507e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
150883409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
150983409a55SEd Schouten
1510ccbb7b5eSEd Maste# The vt video console driver.
1511ccbb7b5eSEd Mastedevice		vt
1512ccbb7b5eSEd Masteoptions		VT_ALT_TO_ESC_HACK=1	# Prepend ESC sequence to ALT keys
1513ccbb7b5eSEd Masteoptions		VT_MAXWINDOWS=16	# Number of virtual consoles
1514ccbb7b5eSEd Masteoptions		VT_TWOBUTTON_MOUSE	# Use right mouse button to paste
1515ccbb7b5eSEd Maste
1516ccbb7b5eSEd Maste# The following options set the default framebuffer size.
1517ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_HEIGHT=480
1518ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_WIDTH=640
1519ccbb7b5eSEd Maste
1520ccbb7b5eSEd Maste# The following options will let you change the default vt terminal colors.
1521ccbb7b5eSEd Masteoptions		TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)
1522ccbb7b5eSEd Masteoptions		TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)
1523ccbb7b5eSEd Maste
15241fe04850SBruce Evans#
1525d61e6649SAlexander Langer# Optional devices:
15266a8d6623SGarrett Wollman#
15276a8d6623SGarrett Wollman
15286a8d6623SGarrett Wollman#
1529d61e6649SAlexander Langer# SCSI host adapters:
15306a8d6623SGarrett Wollman#
15317f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1532859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
15336e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
15347f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1535d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1536d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1537cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
15387f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
15396e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
15406e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1541a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1542a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1543a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1544d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1545d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1546d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1547e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1548e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1549af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1550ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
155164fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
155264fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1553d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1554fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1555fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1556fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1557fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1558f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
1559d61e6649SAlexander Langer
15606e818956SDavid E. O'Brien#
15616e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
15626e818956SDavid E. O'Brien# probed correctly.
15636e818956SDavid E. O'Brien#
15646e818956SDavid E. O'Briendevice		bt
15656e818956SDavid E. O'Brienhint.bt.0.at="isa"
15666e818956SDavid E. O'Brienhint.bt.0.port="0x330"
15677f5092f3SJohn Baldwindevice		adv
15687f5092f3SJohn Baldwinhint.adv.0.at="isa"
1569c9953c3bSPeter Wemmdevice		adw
15706e818956SDavid E. O'Briendevice		aha
15716e818956SDavid E. O'Brienhint.aha.0.at="isa"
15727f5092f3SJohn Baldwindevice		aic
15737f5092f3SJohn Baldwinhint.aic.0.at="isa"
15747f5092f3SJohn Baldwindevice		ahb
1575d61e6649SAlexander Langerdevice		ahc
1576cdd49e97SJustin T. Gibbsdevice		ahd
15771b946e21SScott Longdevice		esp
1578c5933b20SScott Longdevice		iscsi_initiator
1579d61e6649SAlexander Langerdevice		isp
15800787f2b8SMatt Jacobhint.isp.0.disable="1"
15810787f2b8SMatt Jacobhint.isp.0.role="3"
15820787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15830787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15840787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15850787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15860787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15870787f2b8SMatt Jacobhint.isp.0.topology="lport"
15880787f2b8SMatt Jacobhint.isp.0.topology="nport"
15890787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15900787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15910787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15920787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15930787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15940787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1595d61e6649SAlexander Langerdevice		ispfw
159664fa5108SMatt Jacobdevice		mpt
1597d61e6649SAlexander Langerdevice		ncr
1598d61e6649SAlexander Langerdevice		sym
1599f3d92b26SOlivier Houcharddevice		trm
1600d61e6649SAlexander Langer
1601d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1602d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1603d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1604d61e6649SAlexander Langer# default.
1605d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1606d61e6649SAlexander Langer
1607fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1608fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1609fac70739SJeroen Ruigrok van der Werven
1610fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1611fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1612fac70739SJeroen Ruigrok van der Werven
1613662d3818SScott Long# Compile in Aic7xxx Debugging code.
1614662d3818SScott Longoptions 	AHC_DEBUG
1615662d3818SScott Long
1616662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1617662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1618662d3818SScott Long
1619f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1620f8f8803bSBruce Evans# See ahc(4).
1621662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1622662d3818SScott Long
1623cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1624cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1625cdd49e97SJustin T. Gibbs
1626f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1627cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1628cdd49e97SJustin T. Gibbs
162943e9d8a3SScott Long# Print human-readable register definitions when debugging
163043e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
163143e9d8a3SScott Long
1632662d3818SScott Long# Bitmap of units to enable targetmode operations.
1633662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1634662d3818SScott Long
1635d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1636d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1637d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1638d61e6649SAlexander Langer
1639c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1640c5933b20SScott Long#
1641c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1642c5933b20SScott Long
1643d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1644d61e6649SAlexander Langer#
1645d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1646d61e6649SAlexander Langer#
164764fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1648af606348SMatt Jacob#
16499a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
16509a1b0d43SMatt Jacob#		none=0
16519a1b0d43SMatt Jacob#		target=1
16529a1b0d43SMatt Jacob#		initiator=2
16539a1b0d43SMatt Jacob#		both=3			(not supported currently)
1654af606348SMatt Jacob#
165515f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
165615f0f952SMatt Jacob#
1657e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1658d61e6649SAlexander Langer
1659d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1660d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1661d61e6649SAlexander Langer					# Allows the ncr to take precedence
1662d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1663d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1664d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1665d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1666d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1667d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1668d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1669d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1670d61e6649SAlexander Langer					# default:8, range:[1..64]
16716a8d6623SGarrett Wollman
16726e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16736e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16746e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16756e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16766e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16776e818956SDavid E. O'Brien#
16786e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16796e818956SDavid E. O'Brien#  DPT_MEASURE_PERFORMANCE  Enables a set of (semi)invasive metrics. Various
16806e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16816e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16826e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16836e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16846e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16856e818956SDavid E. O'Brien#			    are 100% certain you need it.
16866e818956SDavid E. O'Brien
16876e818956SDavid E. O'Briendevice		dpt
16886e818956SDavid E. O'Brien
16896e818956SDavid E. O'Brien# DPT options
16906e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16916e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16926e818956SDavid E. O'Brien
16936e818956SDavid E. O'Brien#
16946e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16956e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16966e818956SDavid E. O'Brien# CAM infrastructure.
16976e818956SDavid E. O'Brien#
16986e818956SDavid E. O'Briendevice		ciss
16996e818956SDavid E. O'Brien
17006e818956SDavid E. O'Brien#
17016e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
17026e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
17036e818956SDavid E. O'Brien# at Intel for this driver are
17046e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
17056e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
17066e818956SDavid E. O'Brien#
17076e818956SDavid E. O'Briendevice		iir
17086e818956SDavid E. O'Brien
17096e818956SDavid E. O'Brien#
17106e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
17116e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
17126e818956SDavid E. O'Brien# the CAM infrastructure.
17136e818956SDavid E. O'Brien#
17146e818956SDavid E. O'Briendevice		mly
17156e818956SDavid E. O'Brien
17166e818956SDavid E. O'Brien#
17176e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
17186e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
17196e818956SDavid E. O'Brien# controllers.
17206e818956SDavid E. O'Brien#
17216e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
17226e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
17236e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
172464c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
17257f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1726f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
17276b31d3f7SScott Longoptions 	MFI_DEBUG
1728a58b4afaSMark Johnstondevice		mrsas		# LSI/Avago MegaRAID SAS/SATA, 6Gb/s and 12Gb/s
17296e818956SDavid E. O'Brien
17306e818956SDavid E. O'Brien#
17316e818956SDavid E. O'Brien# 3ware ATA RAID
17326e818956SDavid E. O'Brien#
17336e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
17346e818956SDavid E. O'Brien
173590d3341eSPeter Wemm#
1736e19ef875SAlexander Motin# Serial ATA host controllers:
1737e19ef875SAlexander Motin#
1738e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1739dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1740e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
17411a00526bSAlexander Motin#
17421a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
17431a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1744e19ef875SAlexander Motin
1745e19ef875SAlexander Motindevice		ahci
1746dd48af36SAlexander Motindevice		mvs
1747e19ef875SAlexander Motindevice		siis
1748e19ef875SAlexander Motin
1749e19ef875SAlexander Motin#
175045f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
175145f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
17526d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1753c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1754c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1755c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1756c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1757c9953c3bSPeter Wemmdevice		ata
1758c4bda3c6SAlexander Motin
1759c4bda3c6SAlexander Motin# Modular ATA
1760c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1761c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1762c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1763c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1764c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1765c4bda3c6SAlexander Motin
1766c4bda3c6SAlexander Motin# PCI ATA chipsets
1767c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1768c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1769c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1770c4bda3c6SAlexander Motin#device		ataati		# ATI
1771c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1772c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1773c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1774c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1775c4bda3c6SAlexander Motin#device		ataintel	# Intel
1776c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1777c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1778c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1779c4bda3c6SAlexander Motin#device		atamicron	# Micron
1780c4bda3c6SAlexander Motin#device		atanational	# National
1781c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1782c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1783c4bda3c6SAlexander Motin#device		atapromise	# Promise
1784c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1785c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1786c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1787c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1788c4bda3c6SAlexander Motin
17898b89ef0aSSøren Schmidt#
17906d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17916d04301dSAlexander Langerhint.ata.0.at="isa"
17926d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17936d04301dSAlexander Langerhint.ata.0.irq="14"
17946d04301dSAlexander Langerhint.ata.1.at="isa"
17956d04301dSAlexander Langerhint.ata.1.port="0x170"
17966d04301dSAlexander Langerhint.ata.1.irq="15"
17976d04301dSAlexander Langer
17986d04301dSAlexander Langer#
1799000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1800000da71aSSøren Schmidt#
18016fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
18026fb5300bSAlexander Motin#			before timing out.
180374d8e840SSøren Schmidt
18046fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
180574d8e840SSøren Schmidt
18068b89ef0aSSøren Schmidt#
18076d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
18086d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
18096a8d6623SGarrett Wollman#
1810f71c01ccSPeter Wemmdevice		fdc
1811f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1812f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1813f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1814f71c01ccSPeter Wemmhint.fdc.0.drq="2"
181585827d9cSJoerg Wunsch#
1816d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1817d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1818d2fb4892SJoerg Wunsch# however.
1819d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1820d2fb4892SJoerg Wunsch#
1821f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1822f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1823f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1824f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
182585827d9cSJoerg Wunsch
1826f71c01ccSPeter Wemm# Specify floppy devices
1827f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1828f71c01ccSPeter Wemmhint.fd.0.drive="0"
1829f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1830f71c01ccSPeter Wemmhint.fd.1.drive="1"
183185827d9cSJoerg Wunsch
18326a8d6623SGarrett Wollman#
1833501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1834501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1835c8956b36SMarcel Moolenaar#
1836501ef98fSMarcel Moolenaardevice		uart
1837501ef98fSMarcel Moolenaar
18388194412bSMarcel Moolenaar# Options for uart(4)
18398194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
18408194412bSMarcel Moolenaar					# instead of DCD.
18411662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
18421662b008SIan Lepore					# no interrupt support (50 Hz default).
18438194412bSMarcel Moolenaar
1844501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1845501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1846501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1847501ef98fSMarcel Moolenaar
1848c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1849c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1850c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1851c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1852c8956b36SMarcel Moolenaar# unit number of the probed UART.
1853501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1854501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1855501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1856501ef98fSMarcel Moolenaar
1857501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1858c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1859c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1860c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1861c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1862c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1863c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1864c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1865d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1866c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1867c8956b36SMarcel Moolenaar#		as debug port.
18689546766aSBruce Evans#
18699546766aSBruce Evans
1870501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
187191ed2fecSJohn-Mark Gurneyoptions 	BREAK_TO_DEBUGGER	# A BREAK/DBG on the console goes to
1872c8956b36SMarcel Moolenaar					# ddb, if available.
18736a8d6623SGarrett Wollman
187426b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
187526b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18769c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1877c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
187826b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
187926b6ea69SPaul Saab
1880af2e25a6SMarcel Moolenaar# Serial Communications Controller
1881af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1882af2e25a6SMarcel Moolenaar# communications controllers.
1883af2e25a6SMarcel Moolenaardevice		scc
1884af2e25a6SMarcel Moolenaar
18859c564b6cSJohn Hay# PCI Universal Communications driver
188664220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18879c564b6cSJohn Haydevice		puc
18889c564b6cSJohn Hay
18896a8d6623SGarrett Wollman#
1890d61e6649SAlexander Langer# Network interfaces:
18916a8d6623SGarrett Wollman#
1892dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1893d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18943c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18958c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
18968c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
18978c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18988c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18998c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
19008c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1901dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
19028c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
19038c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1904dfd77572SJohn Baldwin
1905dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1906dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1907dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1908dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1909dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1910d933e97fSStephen Hurddevice		bnxt		# Broadcom NetXtreme-C/NetXtreme-E
1911dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1912dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1913dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1914dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1915dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1916dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1917dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1918dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1919dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1920dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1921dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1922dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1923dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1924dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1925e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1926dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1927dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1928dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1929dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1930dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1931dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1932dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1933dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1934d61e6649SAlexander Langer
19357f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
19367f5092f3SJohn Baldwin#       PCI and ISA varieties.
1937ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1938ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1939cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1940cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1941d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
19423c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1943390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1944343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1945343ed0a8SJohn Baldwin#       adapters.
1946343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
194795d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1948586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1949586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1950586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
1951d933e97fSStephen Hurd# bnxt:	Broadcom NetXtreme-C and NetXtreme-E PCIe 10/25/50G Ethernet adapters.
19524e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1953dd46ab31SDavid Christensen#       adapters.
19543132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1955eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1956119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
19577f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19587f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
1959ca7fe84aSNavdeep Parhar# cxgb: Chelsio T3 based 1GbE/10GbE PCIe Ethernet adapters.
1960a74031a5SJohn Baldwin# cxgbe:Chelsio T4, T5, and T6-based 1/10/25/40/100GbE PCIe Ethernet
196124957938SJohn Baldwin#	adapters.
196224957938SJohn Baldwin# cxgbev: Chelsio T4, T5, and T6-based PCIe Virtual Functions.
1963d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1964d61e6649SAlexander Langer#       and various workalikes including:
1965d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1966d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1967d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1968d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1969d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1970d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1971d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1972d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1973d61e6649SAlexander Langer#       KNE110TX.
1974d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1975a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
19767f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19777f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19787f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19797f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19807f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19817f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1982d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1983d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1984cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19851ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
198652c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
198775a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
198844ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1989c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1990c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1991c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1992d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1993d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1994778eefa4SJohn Baldwin#	Requires the mwl firmware module
1995778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1996c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1997c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1998c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1999c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
20002bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
200122f2c49aSHans Petter Selasky# mlx5:	Mellanox ConnectX-4 and ConnectX-4 LX IB and Eth shared code module.
200222f2c49aSHans Petter Selasky# mlx5en:Mellanox ConnectX-4 and ConnectX-4 LX PCIe Ethernet adapters.
2003d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
2004ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
2005ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
2006ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
2007cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
2008cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
20092f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
201041f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
20110fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
20120fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
20130fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
20140fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
20150fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
2016390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
20170587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
2018d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
2019d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
2020d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
2021d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
2022d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
2023d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
2024d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
2025d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
2026b38b13d8SKevin Lo# rtwn: RealTek wireless adapters.
2027b38b13d8SKevin Lo# rtwnfw: RealTek wireless firmware.
2028d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
2029d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
2030d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
2031d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
2032d61e6649SAlexander Langer#       card which is 32-bit.
2033d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
2034b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
2035b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
2036d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
2037d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
2038d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
2039d61e6649SAlexander Langer#       (also single mode and multimode).
2040d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
2041d61e6649SAlexander Langer#       attach each one as a separate network interface.
20427f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
20437f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
2044d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
2045d61e6649SAlexander Langer#       the D-Link DFE-550TX.
2046d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
2047d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
2048d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
2049d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
2050d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
2051c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2052c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2053d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2054d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2055d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2056d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2057d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20583c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2059362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2060d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2061d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2062e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2063e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20642608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2065d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2066d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2067d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2068d61e6649SAlexander Langer#       NE2000 clone.
20697f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20707f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20717f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20727f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20737f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20747f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2075d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2076d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2077d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2078d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2079d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2080d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2081d61e6649SAlexander Langer
20827f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20837f5092f3SJohn Baldwin
20847f5092f3SJohn Baldwindevice		cm
20857f5092f3SJohn Baldwinhint.cm.0.at="isa"
20867f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20877f5092f3SJohn Baldwinhint.cm.0.irq="9"
20887f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20897f5092f3SJohn Baldwindevice		ep
20907f5092f3SJohn Baldwindevice		ex
2091c06a3350SPeter Wemmdevice		fe
20927f5092f3SJohn Baldwinhint.fe.0.at="isa"
20937f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20947f5092f3SJohn Baldwindevice		fea
20957f5092f3SJohn Baldwindevice		sn
20967f5092f3SJohn Baldwinhint.sn.0.at="isa"
20977f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20987f5092f3SJohn Baldwinhint.sn.0.irq="10"
20997f5092f3SJohn Baldwindevice		an
21007f5092f3SJohn Baldwindevice		wi
21017f5092f3SJohn Baldwindevice		xe
21027f5092f3SJohn Baldwin
2103d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2104ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2105cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2106d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
21073c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2108343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2109343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2110343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2111119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
2112d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
21134d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
21144664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
21154664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
21161ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
211752c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
21180587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2119343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
212022f2c49aSHans Petter Selaskydevice		mlx5		# Shared code module between IB and Ethernet
212122f2c49aSHans Petter Selaskydevice		mlx5en		# Mellanox ConnectX-4 and ConnectX-4 LX
21220587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2123d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2124343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
21250587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2126d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
21272e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2128d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2129d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2130d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2131343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2132d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
21330587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2134d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2135eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2136d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
21372608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2138d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2139d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2140d61e6649SAlexander Langer
2141d61e6649SAlexander Langer# PCI Ethernet NICs.
21427f687043SJohn Baldwindevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
21437f687043SJohn Baldwindevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2144a74031a5SJohn Baldwindevice		cxgbe		# Chelsio T4-T6 1/10/25/40/100 Gigabit Ethernet
2145a74031a5SJohn Baldwindevice		cxgbev		# Chelsio T4-T6 Virtual Functions
2146d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
214702f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
2148fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2149758cc3dcSJack F Vogeldevice		ix		# Intel Pro/10Gbe PCIE Ethernet
2150758cc3dcSJack F Vogeldevice		ixv		# Intel Pro/10Gbe PCIE Ethernet VF
215144ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2152f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2153fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
21542f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
21556e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
215695d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2157c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2158548d35fdSGeorge V. Neville-Neildevice		vxge		# Exar/Neterion XFrame 3100 10GbE
2159d61e6649SAlexander Langer
2160343ed0a8SJohn Baldwin# PCI FDDI NICs.
2161c06a3350SPeter Wemmdevice		fpa
2162d61e6649SAlexander Langer
21632bc6081cSScott Long# PCI WAN adapters.
21642bc6081cSScott Longdevice		lmc
21652bc6081cSScott Long
2166390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2167390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2168390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2169390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2170390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2171390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2172390cee87SJohn Baldwin#device		ath_rf2413
2173390cee87SJohn Baldwin#device		ath_rf2417
2174390cee87SJohn Baldwin#device		ath_rf2425
2175390cee87SJohn Baldwin#device		ath_rf5111
2176390cee87SJohn Baldwin#device		ath_rf5112
2177390cee87SJohn Baldwin#device		ath_rf5413
2178390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2179390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2180bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2181bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2182bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2183bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2184bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2185bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2186bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2187bc391cb2SWarner Losh# 4 are safe.
2188bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2189390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2190390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
219158c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2192390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2193390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2194eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2195d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2196d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2197778eefa4SJohn Baldwindevice		mwlfw
2198390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2199b38b13d8SKevin Lodevice		rtwn		# Realtek wireless NICs
2200b38b13d8SKevin Lodevice		rtwnfw
2201390cee87SJohn Baldwin
220210a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
220310a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
220498cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
220598cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
220610a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2207b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
220898cb733cSKenneth D. Merry
22092c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
22102c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
22112c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
22122c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
22132c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
22142c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
22152c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
22162c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
22172c8f5a28SKenneth D. Merry
221868713f97SKenjiro Cho#
221944b5247dSKenjiro Cho# ATM related options (Cranor version)
222044b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
222168713f97SKenjiro Cho#
222268713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
222368713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
222468713f97SKenjiro Cho#
2225c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2226c594298bSHartmut Brandt# ATM PCI cards.
2227c594298bSHartmut Brandt#
2228fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2229fb24f088SHartmut Brandt#
22308dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
22318dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
22328dd4275cSHartmut Brandt#
2233f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
223468713f97SKenjiro Cho# atm devices.
22353cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
223668713f97SKenjiro Cho# bypass TCP/IP.
223768713f97SKenjiro Cho#
2238fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2239fb24f088SHartmut Brandt# hatm and fatm.
22401ba46a03SHartmut Brandt#
224168713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
224268713f97SKenjiro Cho# for more details, please read the original documents at
224398a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
224468713f97SKenjiro Cho#
2245f71c01ccSPeter Wemmdevice		atm
224644b5247dSKenjiro Chodevice		en
2247fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2248c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
22498dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
22501ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
22518c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2252f4567b9cSJulian Elischer
22537e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
22547e9024cdSHartmut Brandt
2255c19da41eSPeter Wemm#
22560739ea1dSSeigo Tanimura# Sound drivers
2257c19da41eSPeter Wemm#
22580739ea1dSSeigo Tanimura# sound: The generic sound driver.
2259c7406082SJohn-Mark Gurney#
22600739ea1dSSeigo Tanimura
22610739ea1dSSeigo Tanimuradevice		sound
22620739ea1dSSeigo Tanimura
22630739ea1dSSeigo Tanimura#
22640739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2265c7406082SJohn-Mark Gurney#
22669c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22677f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22687f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22697f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22707f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22717f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22727f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22737f5092f3SJohn Baldwin#
2274c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22750739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2276d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2277903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2278903b2fb9SJoel Dahl#			for sparc64.
22790739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22800739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22810739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22820739ea1dSSeigo Tanimura#			4281)
22830739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22840739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22850fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22869f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22879f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22880739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2289727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2290727ded3aSJoel Dahl#			conjunction with snd_sbc.
22910739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22920739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22934b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22944b8939a1SAriff Abdullah#			compatible.
2295e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
229617470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2297903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2298903b2fb9SJoel Dahl#			nForce controllers.
22990739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
23000739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
23010739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
23020739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
23030739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
23041c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
23050739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
23061c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
23070739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
23087f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
23090739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2310de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2311903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
23120739ea1dSSeigo Tanimura#			M5451 PCI.
2313de8d750fSJoel Dahl# snd_uaudio:		USB audio.
23140739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
23150739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
23160739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
231781bb901eSPeter Wemm
2318f37a929cSPeter Wemmdevice		snd_ad1816
2319f37a929cSPeter Wemmdevice		snd_als4000
2320d9bde1adSAriff Abdullahdevice		snd_atiixp
23217a7386a3SPyun YongHyeon#device		snd_audiocs
23220739ea1dSSeigo Tanimuradevice		snd_cmi
2323f37a929cSPeter Wemmdevice		snd_cs4281
23240739ea1dSSeigo Tanimuradevice		snd_csa
2325f37a929cSPeter Wemmdevice		snd_ds1
2326f37a929cSPeter Wemmdevice		snd_emu10k1
23270fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2328b1ff0220SAlexander Leidingerdevice		snd_envy24
23299f548240SAlexander Leidingerdevice		snd_envy24ht
2330f37a929cSPeter Wemmdevice		snd_es137x
23310739ea1dSSeigo Tanimuradevice		snd_ess
2332f37a929cSPeter Wemmdevice		snd_fm801
23330739ea1dSSeigo Tanimuradevice		snd_gusc
23344b8939a1SAriff Abdullahdevice		snd_hda
2335e4afd792SAlexander Motindevice		snd_hdspe
23360739ea1dSSeigo Tanimuradevice		snd_ich
23370739ea1dSSeigo Tanimuradevice		snd_maestro
2338f37a929cSPeter Wemmdevice		snd_maestro3
23390739ea1dSSeigo Tanimuradevice		snd_mss
23400739ea1dSSeigo Tanimuradevice		snd_neomagic
2341f37a929cSPeter Wemmdevice		snd_sb16
2342f37a929cSPeter Wemmdevice		snd_sb8
23430739ea1dSSeigo Tanimuradevice		snd_sbc
23440739ea1dSSeigo Tanimuradevice		snd_solo
23459f548240SAlexander Leidingerdevice		snd_spicds
2346f37a929cSPeter Wemmdevice		snd_t4dwave
2347de8d750fSJoel Dahldevice		snd_uaudio
2348f37a929cSPeter Wemmdevice		snd_via8233
2349f37a929cSPeter Wemmdevice		snd_via82c686
23500739ea1dSSeigo Tanimuradevice		snd_vibes
2351c19da41eSPeter Wemm
23521c9c6382SRuslan Ermilov# For non-PnP sound cards:
2353673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2354673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2355673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2356673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2357673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2358673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2359673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2360673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2361673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2362673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2363673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2364673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2365673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2366673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23677f5092f3SJohn Baldwin
23686a8d6623SGarrett Wollman#
236918fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
237018fe4678SAriff Abdullah#
237118fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
237218fe4678SAriff Abdullah#                              sanity checking and possible increase of
237318fe4678SAriff Abdullah#                              verbosity.
237418fe4678SAriff Abdullah#
2375d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
237618fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
237718fe4678SAriff Abdullah#
237818fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
237918fe4678SAriff Abdullah#                              in. This options enable most feeder converters
238018fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
238118fe4678SAriff Abdullah#
238218fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
238318fe4678SAriff Abdullah#
238418fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
238518fe4678SAriff Abdullah#                              as much as possible (the default trying to
238618fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
238718fe4678SAriff Abdullah#
238818fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
238918fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
239018fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
239118fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
239218fe4678SAriff Abdullah#
239318fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
239418fe4678SAriff Abdullah#                              disabling multichannel processing.
239518fe4678SAriff Abdullah#
239618fe4678SAriff Abdullahoptions		SND_DEBUG
239718fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
239818fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
239918fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
240018fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
240118fe4678SAriff Abdullahoptions		SND_PCM_64
240218fe4678SAriff Abdullahoptions		SND_OLDSTEREO
240318fe4678SAriff Abdullah
240418fe4678SAriff Abdullah#
2405567e21c2SBruce Evans# Miscellaneous hardware:
24066a8d6623SGarrett Wollman#
24071c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
24087f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2409603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2410657e73c4SPeter Dufault
24111c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
24127f5092f3SJohn Baldwinhint.joy.0.at="isa"
24137f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2414603d67aeSRink Springerdevice		cmx
2415a800f455SJulian Elischer
2416eeb706c0SJustin T. Gibbs#
2417a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
24181c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2419a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
24201c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
24211c2b5939SRoger Hardiman#
2422a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2423a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2424a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2425a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
24261c2b5939SRoger Hardiman# These options can be used to override the auto detection
242798a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
24281c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
24299ff07e32SAmancio Hasty#
24304f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
24311c2b5939SRoger Hardiman# or
24321c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
24333c7c6c12SMike Pritchard# Specifies the default video capture mode.
24341748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2435d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2436a9c5b8d0SSøren Schmidt#
24374f5f3f07SBrian Somers# options 	BKTR_USE_PLL
24381748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2439a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2440a9c5b8d0SSøren Schmidt#
24411c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24429c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24431c2b5939SRoger Hardiman#
24441c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2445d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
24461c2b5939SRoger Hardiman#
24471c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24481c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24491c2b5939SRoger Hardiman#
24501c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24511c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24521c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24531c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24541c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24551c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24561c2b5939SRoger Hardiman#
245730e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
245830e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
245930e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
246030e27d96SAlexander Langer# mono sound.
2461017b0edcSMatt Jacob
2462c17d4340SNicolas Souchu#
2463c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2464c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2465c17d4340SNicolas Souchu#
246628ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24670f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
246837973e86SPeter Wemm#     device smbus
246937973e86SPeter Wemm#     device iicbus
247037973e86SPeter Wemm#     device iicbb
2471c17d4340SNicolas Souchu#     device iicsmb
24720f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24730f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
247428ebb692SNicolas Souchu#
2475c06a3350SPeter Wemmdevice		bktr
2476446cee6eSJoerg Wunsch
2477dc9deb29SPoul-Henning Kamp#
24786e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24796e818956SDavid E. O'Brien#
24805bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24816e818956SDavid E. O'Brien# pccard: pccard slots
24826e818956SDavid E. O'Brien# cardbus: cardbus slots
24836e818956SDavid E. O'Briendevice		cbb
24846e818956SDavid E. O'Briendevice		pccard
24856e818956SDavid E. O'Briendevice		cardbus
24866e818956SDavid E. O'Brien
24876e818956SDavid E. O'Brien#
24885bcb64f2SWarner Losh# MMC/SD
24895bcb64f2SWarner Losh#
2490831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2491831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2492831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2493831f5dcfSAlexander Motin#
2494831f5dcfSAlexander Motindevice		mmc
2495831f5dcfSAlexander Motindevice		mmcsd
2496831f5dcfSAlexander Motindevice		sdhci
24975bcb64f2SWarner Losh
24985bcb64f2SWarner Losh#
24998afa373cSNicolas Souchu# SMB bus
25008afa373cSNicolas Souchu#
25013c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
25023c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
25033c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
25048afa373cSNicolas Souchu#
25058afa373cSNicolas Souchu# Supported devices:
25064d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
25078afa373cSNicolas Souchu#
25083c5656bfSArchie Cobbs# Supported SMB interfaces:
250928ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
251028ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
25117f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
25127f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
25137f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
25147f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2515b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
25164d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
251744e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
25184d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
25190572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
25208afa373cSNicolas Souchu#
2521c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
25223c5656bfSArchie Cobbs
25237f5092f3SJohn Baldwindevice		intpm
25247f5092f3SJohn Baldwindevice		alpm
25257f5092f3SJohn Baldwindevice		ichsmb
25267f5092f3SJohn Baldwindevice		viapm
252744e6ce01SNicolas Souchudevice		amdpm
25284d5f30e0SRuslan Ermilovdevice		amdsmb
252944e6ce01SNicolas Souchudevice		nfpm
25304d5f30e0SRuslan Ermilovdevice		nfsmb
25310572ccaaSJim Harrisdevice		ismt
25327f5092f3SJohn Baldwin
2533c9953c3bSPeter Wemmdevice		smb
25348afa373cSNicolas Souchu
25354afdfe97SAndriy Gapon# SMBus peripheral devices
25368afa373cSNicolas Souchu#
25374afdfe97SAndriy Gapon# jedec_ts	Temperature Sensor compliant with JEDEC Standard 21-C
25384afdfe97SAndriy Gapon#
25394afdfe97SAndriy Gapondevice		jedec_ts
25404afdfe97SAndriy Gapon
25418afa373cSNicolas Souchu# I2C Bus
25428afa373cSNicolas Souchu#
25438afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
25448afa373cSNicolas Souchu#
25458afa373cSNicolas Souchu# Supported devices:
25468afa373cSNicolas Souchu# ic	i2c network interface
25478afa373cSNicolas Souchu# iic	i2c standard io
2548f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25491ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
25508afa373cSNicolas Souchu#
25518afa373cSNicolas Souchu# Supported interfaces:
255228ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
255328ebb692SNicolas Souchu#
255428ebb692SNicolas Souchu# Other:
255528ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25568afa373cSNicolas Souchu#
2557c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2558c9953c3bSPeter Wemmdevice		iicbb
25598afa373cSNicolas Souchu
2560c9953c3bSPeter Wemmdevice		ic
2561c9953c3bSPeter Wemmdevice		iic
2562c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25631ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
25648afa373cSNicolas Souchu
2565286fa445SRafal Jaworowski# I2C peripheral devices
2566286fa445SRafal Jaworowski#
2567286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
25681513a6ffSJayachandran C.# ds1374	Dallas Semiconductor DS1374 RTC
2569286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2570f8e8af9cSHiroki Sato# s35390a	Seiko Instruments S-35390A RTC
2571286fa445SRafal Jaworowski#
2572286fa445SRafal Jaworowskidevice		ds133x
25731513a6ffSJayachandran C.device		ds1374
2574286fa445SRafal Jaworowskidevice		ds1672
2575f8e8af9cSHiroki Satodevice		s35390a
2576286fa445SRafal Jaworowski
2577ab4c624bSMike Smith# Parallel-Port Bus
2578ab4c624bSMike Smith#
2579ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2580ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2581ab4c624bSMike Smith# are automatically probed and attached when found.
2582ab4c624bSMike Smith#
2583ab4c624bSMike Smith# Supported devices:
2584ab4c624bSMike Smith# vpo	Iomega Zip Drive
2585f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2586f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2587fdf94d1aSNicolas Souchu# lpt	Parallel Printer
258846f3ff79SMike Smith# plip	Parallel network interface
2589fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2590f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
259128ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25921caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2593ab4c624bSMike Smith#
2594ab4c624bSMike Smith# Supported interfaces:
2595ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2596ab4c624bSMike Smith#
2597ef8f7626SNicolas Souchu
25980f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25990f210c92SNicolas Souchu				  # (see flags in ppc(4))
26005895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
26019d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2602ef8f7626SNicolas Souchu				# compliant peripheral
26035895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
26045895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
26055895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
26065895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
26075895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
26083b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
26093b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2610ef8f7626SNicolas Souchu
2611f71c01ccSPeter Wemmdevice		ppc
2612f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2613f71c01ccSPeter Wemmhint.ppc.0.irq="7"
26140d31b179SPeter Wemmdevice		ppbus
26150d31b179SPeter Wemmdevice		vpo
26160d31b179SPeter Wemmdevice		lpt
26170d31b179SPeter Wemmdevice		plip
26180d31b179SPeter Wemmdevice		ppi
26190d31b179SPeter Wemmdevice		pps
26200d31b179SPeter Wemmdevice		lpbb
26210d31b179SPeter Wemmdevice		pcfclock
2622ab4c624bSMike Smith
2623f45757caSChristian Brueffer#
2624f45757caSChristian Brueffer# Etherswitch framework and drivers
2625f45757caSChristian Brueffer#
2626f45757caSChristian Brueffer# etherswitch	The etherswitch(4) framework
2627f45757caSChristian Brueffer# miiproxy	Proxy device for miibus(4) functionality
2628f45757caSChristian Brueffer#
2629f45757caSChristian Brueffer# Switch hardware support:
2630f45757caSChristian Brueffer# arswitch	Atheros switches
2631f45757caSChristian Brueffer# ip17x 	IC+ 17x family switches
2632f45757caSChristian Brueffer# rtl8366r	Realtek RTL8366 switches
2633f45757caSChristian Brueffer# ukswitch	Multi-PHY switches
2634f45757caSChristian Brueffer#
2635f45757caSChristian Bruefferdevice		etherswitch
2636f45757caSChristian Bruefferdevice		miiproxy
2637f45757caSChristian Bruefferdevice		arswitch
2638f45757caSChristian Bruefferdevice		ip17x
2639f45757caSChristian Bruefferdevice		rtl8366rb
2640f45757caSChristian Bruefferdevice		ukswitch
2641f45757caSChristian Brueffer
26420ac40133SBrian Somers# Kernel BOOTP support
26430ac40133SBrian Somers
26440ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2645c15882f0SRick Macklem				# Requires NFSCL and NFS_ROOT
26460ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
26470ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
26480ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
26490ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2650eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2651432aad0eSTor Egge
2652d94f38acSEivind Eklund#
26534103b765SPoul-Henning Kamp# Add software watchdog routines.
2654370c3cb5SSean Kelly#
26554103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2656370c3cb5SSean Kelly
2657370c3cb5SSean Kelly#
2658f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2659f7829d0dSAttilio Rao#
2660f7829d0dSAttilio Raooptions 	DEADLKRES
2661f7829d0dSAttilio Rao
2662f7829d0dSAttilio Rao#
2663b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
26644e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
26654e0ee531SMike Barcroft# it back on at run-time.
2666c796cfa1SAndrzej Bialecki#
2667c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2668c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2669c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2670c796cfa1SAndrzej Bialecki#
267119dde963SPeter Wemm#options 	NO_SWAPPING
2672c796cfa1SAndrzej Bialecki
26739dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26749dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26759dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26769dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26779dab0776SDavid Greenman#
26785895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26799dab0776SDavid Greenman
268015a1057cSEivind Eklund#
2681053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26829c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2683053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
26842c048c4aSBryan Drewery# not at all useful unless you are debugging lock code.  Note that
26852c048c4aSBryan Drewery# modules should be recompiled as this option modifies KBI.
268615a1057cSEivind Eklund#
268715a1057cSEivind Eklundoptions 	DEBUG_LOCKS
268815a1057cSEivind Eklund
268926086a03SPeter Wemm
269026086a03SPeter Wemm#####################################################################
26911d33cf3dSNick Hibma# USB support
26921d33cf3dSNick Hibma# UHCI controller
2693c9953c3bSPeter Wemmdevice		uhci
26941d33cf3dSNick Hibma# OHCI controller
2695c9953c3bSPeter Wemmdevice		ohci
2696ca3acad1SBernd Walter# EHCI controller
2697ca3acad1SBernd Walterdevice		ehci
2698857508a3SAndrew Thompson# XHCI controller
2699857508a3SAndrew Thompsondevice		xhci
270039e5901eSTakanori Watanabe# SL811 Controller
2701b92755d1SAndrew Thompson#device		slhci
27021d33cf3dSNick Hibma# General USB code (mandatory for USB)
2703c9953c3bSPeter Wemmdevice		usb
27041d33cf3dSNick Hibma#
2705b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2706b5ea1f0cSNick Hibmadevice		udbp
2707d1233ab3SBruce Evans# USB Fm Radio
2708d1233ab3SBruce Evansdevice		ufm
27092d45d793SHans Petter Selasky# USB temperature meter
27102d45d793SHans Petter Selaskydevice		ugold
27116bd03b20SKevin Lo# USB LED
27126bd03b20SKevin Lodevice		uled
2713f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2714c9953c3bSPeter Wemmdevice		uhid
27151d33cf3dSNick Hibma# USB keyboard
2716c9953c3bSPeter Wemmdevice		ukbd
27171d33cf3dSNick Hibma# USB printer
2718c9953c3bSPeter Wemmdevice		ulpt
271931615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2720c9953c3bSPeter Wemmdevice		umass
272131615ef7SRebecca Cran# USB mass storage driver for device-side mode
272231615ef7SRebecca Crandevice		usfs
2723ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2724ce17576aSScott Longdevice		umct
2725e9fb12d3SNick Hibma# USB modem support
2726e9fb12d3SNick Hibmadevice		umodem
2727f26c33d2SNick Hibma# USB mouse
2728c9953c3bSPeter Wemmdevice		ums
2729eed447b5SHans Petter Selasky# USB touchpad(s)
2730eed447b5SHans Petter Selaskydevice		atp
2731eed447b5SHans Petter Selaskydevice		wsp
2732f25a8a01SGleb Smirnoff# eGalax USB touch screen
2733f25a8a01SGleb Smirnoffdevice		uep
27341c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2735e2dbd15fSNick Hibmadevice		urio
2736d1233ab3SBruce Evans#
2737916e6e02SJosef Karthauser# USB serial support
2738916e6e02SJosef Karthauserdevice		ucom
2739fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2740483b9e47SNick Hibmadevice		u3g
27419aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
27429aab0d96SMaxim Konovalovdevice		uark
2743d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2744d1233ab3SBruce Evansdevice		ubsa
274548b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
274648b68edfSJosef Karthauserdevice		uftdi
2747c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2748c5286e11STakanori Watanabedevice		uipaq
274948b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2750916e6e02SJosef Karthauserdevice		uplcom
27512e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
27522e7328e7SRink Springerdevice		uslcom
275348b68edfSJosef Karthauser# USB Visor and Palm devices
275448b68edfSJosef Karthauserdevice		uvisor
2755d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2756d1233ab3SBruce Evansdevice		uvscom
2757f26c33d2SNick Hibma#
2758ff6b30b9SKevin Lo# USB ethernet support
2759ff6b30b9SKevin Lodevice		uether
2760ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2761d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2762d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2763d04bb221SBill Paul# eval board.
2764c9953c3bSPeter Wemmdevice		aue
2765bf029145SRobert Watson
2766bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2767bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2768bf029145SRobert Watsondevice		axe
276979eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
277079eb99dfSLi-Wen Hsudevice		axge
2771bf029145SRobert Watson
2772dfd1e98eSBill Paul#
27736bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
27746bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
27756bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
27766bcf0032SMaxim Sobolevdevice		cdce
27776bcf0032SMaxim Sobolev#
277801779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
277901779872SBill Paul# and Netmate II, and the Belkin F5U111.
2780c9953c3bSPeter Wemmdevice		cue
278101779872SBill Paul#
2782dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2783d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2784d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
278501779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
278601779872SBill Paul# and 2104USB, and the Corega USB-T.
2787c9953c3bSPeter Wemmdevice		kue
278811e04b05SShunsuke Akiyama#
278911e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
279011e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
279111e04b05SShunsuke Akiyamadevice		rue
2792cdd40f3bSMIHIRA Sanpei Yoshiro#
2793cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2794cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2795941e2863SAndrew Thompson#
2796a24d62b5SKevin Lo# RealTek RTL8152/RTL8153 USB Ethernet driver
2797e1b74f21SKevin Lodevice		ure
2798e1b74f21SKevin Lo#
279922445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
280022445463SKevin Lodevice		mos
280122445463SKevin Lo#
2802941e2863SAndrew Thompson# HSxPA devices from Option N.V
2803941e2863SAndrew Thompsondevice		uhso
2804cdd40f3bSMIHIRA Sanpei Yoshiro
280531d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
280631d98677SRui Paulodevice		rsu
28078a4cd00aSWarner Losh#
280871aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
280971aa1d32SSam Lefflerdevice		rum
281093393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
281193393dfdSAndrew Thompsondevice		run
28128a4cd00aSWarner Losh#
281371aa1d32SSam Leffler# Atheros AR5523 wireless driver
281471aa1d32SSam Lefflerdevice		uath
281571aa1d32SSam Leffler#
2816d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2817d1f25d5dSBernhard Schmidtdevice		upgt
2818d1f25d5dSBernhard Schmidt#
281971aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
28208a4cd00aSWarner Loshdevice		ural
28218a4cd00aSWarner Losh#
282229311227SHans Petter Selasky# RNDIS USB ethernet driver
282329311227SHans Petter Selaskydevice		urndis
28245aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
28255aaea652SKevin Lodevice		urtw
28265aaea652SKevin Lo#
282771aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
282871aa1d32SSam Lefflerdevice		zyd
282945b395cdSGleb Smirnoff#
283045b395cdSGleb Smirnoff# Sierra USB wireless driver
283145b395cdSGleb Smirnoffdevice		usie
2832f26c33d2SNick Hibma
28338a4cd00aSWarner Losh#
2834f26c33d2SNick Hibma# debugging options for the USB subsystem
28351d33cf3dSNick Hibma#
28361d33cf3dSNick Hibmaoptions 	USB_DEBUG
2837fe75118bSNick Hibmaoptions 	U3G_DEBUG
2838f26c33d2SNick Hibma
28396e8394b8SKazutaka YOKOTA# options for ukbd:
28406e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
284191b050b2SPoul-Henning Kampmakeoptions	UKBD_DFLT_KEYMAP=jp.pc98
28426e8394b8SKazutaka YOKOTA
2843565f53bbSShunsuke Akiyama# options for uplcom:
28443c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2845565f53bbSShunsuke Akiyama						# in milliseconds
2846565f53bbSShunsuke Akiyama
284720280807SShunsuke Akiyama# options for uvscom:
284820280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
28493c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2850565f53bbSShunsuke Akiyama						# in milliseconds
285120280807SShunsuke Akiyama
28528b7ce2ffSSam Leffler#####################################################################
2853869093b1SHidetoshi Shimokawa# FireWire support
28547d2ba89bSJohn Baldwin
2855869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
28567d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
285779acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2858869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
28591c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2860869093b1SHidetoshi Shimokawa
2861869093b1SHidetoshi Shimokawa#####################################################################
2862869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2863869093b1SHidetoshi Shimokawa
2864869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2865869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2866869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2867869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2868869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2869869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
28707d2ba89bSJohn Baldwin
28717d2ba89bSJohn Baldwin#####################################################################
28728b7ce2ffSSam Leffler# crypto subsystem
28738b7ce2ffSSam Leffler#
28741c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2875b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
28761c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
28778b7ce2ffSSam Leffler#
28781c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28791c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28808b7ce2ffSSam Leffler
28818b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
2882b65946c6SJohn-Mark Gurney
2883b65946c6SJohn-Mark Gurney# Only install the cryptodev device if you are running tests, or know
2884e0b231cbSJohn-Mark Gurney# specifically why you need it.  In most cases, it is not needed and
2885e0b231cbSJohn-Mark Gurney# will make things slower.
28868b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28878b7ce2ffSSam Leffler
2888ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28898b7ce2ffSSam Leffler
2890b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2891b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2892b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2893b7c4858fSSam Leffler
2894b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2895b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2896b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2897b7c4858fSSam Leffler
28988b7ce2ffSSam Leffler#####################################################################
28998b7ce2ffSSam Leffler
29008b7ce2ffSSam Leffler
2901785d2100SJohn Birrell#
2902785d2100SJohn Birrell# Embedded system options:
2903785d2100SJohn Birrell#
2904785d2100SJohn Birrell# An embedded system might want to run something other than init.
29050fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2906bc0e3a03SJeroen Ruigrok van der Werven
2907bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2908bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
29091c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2910395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
291141c1a233SGleb Smirnoffoptions 	IFMEDIA_DEBUG	# enable debugging in net/if_media.c
2912bc0e3a03SJeroen Ruigrok van der Werven
2913e2c1a4e9SBenno Rice#
2914e2c1a4e9SBenno Rice# Verbose SYSINIT
2915e2c1a4e9SBenno Rice#
2916e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2917e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2918e2c1a4e9SBenno Rice# will print function names instead of addresses.
2919e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2920e2c1a4e9SBenno Rice
2921446af86dSJohn Baldwin#####################################################################
2922446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2923446af86dSJohn Baldwin#
2924446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2925446af86dSJohn Baldwin# one time.
2926446af86dSJohn Baldwinoptions 	SEMMNI=11
2927446af86dSJohn Baldwin
2928446af86dSJohn Baldwin# Total number of semaphores system wide
2929446af86dSJohn Baldwinoptions 	SEMMNS=61
2930446af86dSJohn Baldwin
2931446af86dSJohn Baldwin# Total number of undo structures in system
2932446af86dSJohn Baldwinoptions 	SEMMNU=31
2933446af86dSJohn Baldwin
2934446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2935446af86dSJohn Baldwin# at one time.
2936446af86dSJohn Baldwinoptions 	SEMMSL=61
2937446af86dSJohn Baldwin
2938446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2939446af86dSJohn Baldwin# semaphore at one time.
2940446af86dSJohn Baldwinoptions 	SEMOPM=101
2941446af86dSJohn Baldwin
2942446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2943446af86dSJohn Baldwin# System V semaphore at one time.
2944446af86dSJohn Baldwinoptions 	SEMUME=11
2945446af86dSJohn Baldwin
2946446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2947446af86dSJohn Baldwinoptions 	SHMALL=1025
2948446af86dSJohn Baldwin
2949446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
295025388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2951446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2952446af86dSJohn Baldwin
2953446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2954446af86dSJohn Baldwinoptions 	SHMMIN=2
2955446af86dSJohn Baldwin
2956446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2957446af86dSJohn Baldwin# at one time.
2958446af86dSJohn Baldwinoptions 	SHMMNI=33
2959446af86dSJohn Baldwin
2960446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2961446af86dSJohn Baldwin# a single process at one time.
2962446af86dSJohn Baldwinoptions 	SHMSEG=9
2963446af86dSJohn Baldwin
2964d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2965d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2966d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2967d9282887SDima Dorfman# console.
2968d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2969d9282887SDima Dorfman
29705bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
29715bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
29725bbb8060STor Egge# file.  Both offset and length of the read operation must be
29735bbb8060STor Egge# multiples of the physical media sector size.
29745bbb8060STor Egge#
2975995356dcSDag-Erling Smørgravoptions 	DIRECTIO
29765bbb8060STor Egge
29775bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
29785bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29795bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29805bbb8060STor Egge#
2981995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29825bbb8060STor Egge
2983446af86dSJohn Baldwin#####################################################################
2984446af86dSJohn Baldwin
2985bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29869c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2987bc0e3a03SJeroen Ruigrok van der Werven
2988bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
298928d7984fSJeroen Ruigrok van der Werven
299028d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2991bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
299228d7984fSJeroen Ruigrok van der Werven
2993bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29948b6f5e65SJeroen Ruigrok van der Werven
299528d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2996bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
299728d7984fSJeroen Ruigrok van der Werven
29988b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29998b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
30008b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
30018b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
30028b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
30038b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
30048b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
30058b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
30068b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
30078b6f5e65SJeroen Ruigrok van der Werven
30088b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
30098b6f5e65SJeroen Ruigrok van der Werven
3010bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
3011bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
3012bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
3013bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
30148b6f5e65SJeroen Ruigrok van der Werven
30158b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
30168b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
30178b6f5e65SJeroen Ruigrok van der Werven
30188b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
30198b6f5e65SJeroen Ruigrok van der Werven
3020316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
3021b7627840SKonstantin Belousovoptions 	KSTACK_USAGE_PROF
3022316ec49aSScott Long
3023662d3818SScott Long# Adaptec Array Controller driver options
3024662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
3025662d3818SScott Long				# 0 - quiet, only emit warnings
3026662d3818SScott Long				# 1 - noisy, emit major function
3027662d3818SScott Long				#     points and things done
3028662d3818SScott Long				# 2 - extremely noisy, emit trace
3029662d3818SScott Long				#     items in loops, etc.
3030662d3818SScott Long
3031097055e2SEdward Tomasz Napierala# Resource Accounting
3032097055e2SEdward Tomasz Napieralaoptions 	RACCT
3033097055e2SEdward Tomasz Napierala
3034ec125fbbSEdward Tomasz Napierala# Resource Limits
3035ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
3036ec125fbbSEdward Tomasz Napierala
30371e9ea774SBruce Evans# Yet more undocumented options for linting.
30381e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
30391e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
30401e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
304125388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
304225388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
30431e9ea774SBruce Evansoptions 	MAXFILES=999
3044efba048eSXin LI
3045997b0a64SDag-Erling Smørgrav# Random number generator
304610cb2424SMark Murray# Only ONE of the below two may be used; they are mutually exclusive.
3047646041a8SMark Murray# If neither is present, then the Fortuna algorithm is selected.
3048646041a8SMark Murray#options 	RANDOM_YARROW	# Yarrow CSPRNG (old default)
3049646041a8SMark Murray#options 	RANDOM_LOADABLE	# Allow the algorithm to be loaded as
3050646041a8SMark Murray				# a module.
3051e866d8f0SMark Murray# Select this to allow high-rate but potentially expensive
3052e866d8f0SMark Murray# harvesting of Slab-Allocator entropy. In very high-rate
3053e866d8f0SMark Murray# situations the value of doing this is dubious at best.
3054e866d8f0SMark Murrayoptions 	RANDOM_ENABLE_UMA	# slab allocator
305581e3caafSJustin Hibbits
305681e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
305781e3caafSJustin Hibbitsoptions         IMAGACT_BINMISC
3058aa14e9b7SMark Johnston
3059aa14e9b7SMark Johnston# zlib I/O stream support
3060aa14e9b7SMark Johnston# This enables support for compressed core dumps.
3061aa14e9b7SMark Johnstonoptions 	GZIO
3062fb403678SAdrian Chadd
3063fb403678SAdrian Chadd# BHND(4) drivers
3064fb403678SAdrian Chaddoptions		BHND_LOGLEVEL	# Logging threshold level
30652b3f6d66SOleksandr Tymoshenko
30662b3f6d66SOleksandr Tymoshenko# evdev interface
3067a6b15a34SOleksandr Tymoshenkodevice		evdev		# input event device support
3068a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_SUPPORT	# evdev support in legacy drivers
3069a6b15a34SOleksandr Tymoshenkooptions 	EVDEV_DEBUG	# enable event debug msgs
3070a6b15a34SOleksandr Tymoshenkodevice		uinput		# install /dev/uinput cdev
3071a6b15a34SOleksandr Tymoshenkooptions 	UINPUT_DEBUG	# enable uinput debug msgs
3072480f31c2SKonrad Witaszczyk
3073480f31c2SKonrad Witaszczyk# Encrypted kernel crash dumps.
3074480f31c2SKonrad Witaszczykoptions 	EKCD
3075