xref: /freebsd/sys/conf/NOTES (revision 62d70a8174c9a78bf0caf7a405b5e7c670e28360)
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
22668b739cdSAttilio Rao# MAXCPU defines the maximum number of CPUs that can boot in the system.
22768b739cdSAttilio Rao# A default value should be already present, for every architecture.
22868b739cdSAttilio Raooptions 	MAXCPU=32
22968b739cdSAttilio Rao
230941646f5SAttilio Rao# MAXMEMDOM defines the maximum number of memory domains that can boot in the
231941646f5SAttilio Rao# system.  A default value should already be defined by every architecture.
232*62d70a81SJohn Baldwinoptions 	MAXMEMDOM=2
233*62d70a81SJohn Baldwin
234*62d70a81SJohn Baldwin# VM_NUMA_ALLOC enables use of memory domain-aware allocation in the VM
235*62d70a81SJohn Baldwin# system.
236*62d70a81SJohn Baldwinoptions 	VM_NUMA_ALLOC
237*62d70a81SJohn Baldwin
238*62d70a81SJohn Baldwin# DEVICE_NUMA enables reporting of domain affinity of I/O devices via
239*62d70a81SJohn Baldwin# bus_get_domain(), etc.
240*62d70a81SJohn Baldwinoptions 	DEVICE_NUMA
241941646f5SAttilio Rao
2422498cf8cSJohn Baldwin# ADAPTIVE_MUTEXES changes the behavior of blocking mutexes to spin
2432498cf8cSJohn Baldwin# if the thread that currently owns the mutex is executing on another
244d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
245701f1408SScott Long# to disable it.
246701f1408SScott Longoptions 	NO_ADAPTIVE_MUTEXES
2472498cf8cSJohn Baldwin
248cd6e6e4eSJohn Baldwin# ADAPTIVE_RWLOCKS changes the behavior of reader/writer locks to spin
249cd6e6e4eSJohn Baldwin# if the thread that currently owns the rwlock is executing on another
250d51e8487SJosh Paetzel# CPU.  This behavior is enabled by default, so this option can be used
251cd6e6e4eSJohn Baldwin# to disable it.
252cd6e6e4eSJohn Baldwinoptions 	NO_ADAPTIVE_RWLOCKS
253cd6e6e4eSJohn Baldwin
2541ae1c2a3SAttilio Rao# ADAPTIVE_SX changes the behavior of sx locks to spin if the thread that
2551ae1c2a3SAttilio Rao# currently owns the sx lock is executing on another CPU.
256d51e8487SJosh Paetzel# This behavior is enabled by default, so this option can be used to
2571ae1c2a3SAttilio Rao# disable it.
2581ae1c2a3SAttilio Raooptions 	NO_ADAPTIVE_SX
2594e7f640dSJohn Baldwin
260ad27c4c7SJohn Baldwin# MUTEX_NOINLINE forces mutex operations to call functions to perform each
261ad27c4c7SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
262ad27c4c7SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
263cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
264ad27c4c7SJohn Baldwin# and WITNESS options.
265ad27c4c7SJohn Baldwinoptions 	MUTEX_NOINLINE
266ad27c4c7SJohn Baldwin
2671a5d9b15SJohn Baldwin# RWLOCK_NOINLINE forces rwlock operations to call functions to perform each
2681a5d9b15SJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2691a5d9b15SJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
270cf31ff26SRuslan Ermilov# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2711a5d9b15SJohn Baldwin# and WITNESS options.
2721a5d9b15SJohn Baldwinoptions 	RWLOCK_NOINLINE
2731a5d9b15SJohn Baldwin
2744e7f640dSJohn Baldwin# SX_NOINLINE forces sx lock operations to call functions to perform each
2754e7f640dSJohn Baldwin# operation rather than inlining the simple cases.  This can be used to
2764e7f640dSJohn Baldwin# shrink the size of the kernel text segment.  Note that this behavior is
2774e7f640dSJohn Baldwin# already implied by the INVARIANT_SUPPORT, INVARIANTS, KTR, LOCK_PROFILING,
2784e7f640dSJohn Baldwin# and WITNESS options.
2794e7f640dSJohn Baldwinoptions 	SX_NOINLINE
2804e7f640dSJohn Baldwin
2811fe4c660SJohn Baldwin# SMP Debugging Options:
2821fe4c660SJohn Baldwin#
2835b999a6bSDavide Italiano# CALLOUT_PROFILING enables rudimentary profiling of the callwheel data
2845b999a6bSDavide Italiano#	  structure used as backend in callout(9).
2855e21b51bSDavid E. O'Brien# PREEMPTION allows the threads that are in the kernel to be preempted by
2865e21b51bSDavid E. O'Brien#	  higher priority [interrupt] threads.  It helps with interactivity
2875e21b51bSDavid E. O'Brien#	  and allows interrupt threads to run sooner rather than waiting.
28867ab9fd7SJohn Baldwin#	  WARNING! Only tested on amd64 and i386.
2890c0b25aeSJohn Baldwin# FULL_PREEMPTION instructs the kernel to preempt non-realtime kernel
2908c5923d9SCeri Davies#	  threads.  Its sole use is to expose race conditions and other
2910c0b25aeSJohn Baldwin#	  bugs during development.  Enabling this option will reduce
2920c0b25aeSJohn Baldwin#	  performance and increase the frequency of kernel panics by
2930c0b25aeSJohn Baldwin#	  design.  If you aren't sure that you need it then you don't.
2949923b511SScott Long#	  Relies on the PREEMPTION option.  DON'T TURN THIS ON.
295ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
296ef0ebfc3SJohn Baldwin# SLEEPQUEUE_PROFILING enables rudimentary profiling of the hash table
29775a66a92SJeff Roberson#	  used to hold active sleep queues as well as sleep wait message
29875a66a92SJeff Roberson#	  frequency.
299ef0ebfc3SJohn Baldwin# TURNSTILE_PROFILING enables rudimentary profiling of the hash table
300ef0ebfc3SJohn Baldwin#	  used to hold active lock queues.
301c6111de5SDavide Italiano# UMTX_PROFILING enables rudimentary profiling of the hash table used
302c6111de5SDavide Italiano	  to hold active lock queues.
303aa4019efSRobert Watson# WITNESS enables the witness code which detects deadlocks and cycles
3041fe4c660SJohn Baldwin#         during locking operations.
305e2ee2173SMarcel Moolenaar# WITNESS_KDB causes the witness code to drop into the kernel debugger if
3063c7c6c12SMike Pritchard#	  a lock hierarchy violation occurs or if locks are held when going to
307660d1e3aSJohn Baldwin#	  sleep.
308660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
3099923b511SScott Longoptions 	PREEMPTION
3100c0b25aeSJohn Baldwinoptions 	FULL_PREEMPTION
311ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
3121fe4c660SJohn Baldwinoptions 	WITNESS
313e2ee2173SMarcel Moolenaaroptions 	WITNESS_KDB
314660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
3151fe4c660SJohn Baldwin
316cf31ff26SRuslan Ermilov# LOCK_PROFILING - Profiling locks.  See LOCK_PROFILING(9) for details.
31707dba937SKip Macyoptions 	LOCK_PROFILING
31800096801SJohn-Mark Gurney# Set the number of buffers and the hash size.  The hash size MUST be larger
31900096801SJohn-Mark Gurney# than the number of buffers.  Hash size should be prime.
32000096801SJohn-Mark Gurneyoptions 	MPROF_BUFFERS="1536"
32100096801SJohn-Mark Gurneyoptions 	MPROF_HASH_SIZE="1543"
3224db0d7f1SDag-Erling Smørgrav
3235b999a6bSDavide Italiano# Profiling for the callout(9) backend.
3245b999a6bSDavide Italianooptions 	CALLOUT_PROFILING
3255b999a6bSDavide Italiano
326ef0ebfc3SJohn Baldwin# Profiling for internal hash tables.
327ef0ebfc3SJohn Baldwinoptions 	SLEEPQUEUE_PROFILING
328ef0ebfc3SJohn Baldwinoptions 	TURNSTILE_PROFILING
329c6111de5SDavide Italianooptions 	UMTX_PROFILING
330331805a5SDavide Italiano
331ef0ebfc3SJohn Baldwin
332477a642cSPeter Wemm#####################################################################
3336a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
334690f540cSAndrey A. Chernov
3356a8d6623SGarrett Wollman#
3366a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
33756c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
3387bbf05a2SJuli Mallett# still relies on the 4.3 emulation.  Note that some architectures that
3397bbf05a2SJuli Mallett# are supported by FreeBSD do not include support for certain important
3407bbf05a2SJuli Mallett# aspects of this compatibility option, namely those related to the
3417bbf05a2SJuli Mallett# signal delivery mechanism.
3426a8d6623SGarrett Wollman#
3435895e3c8SPeter Wemmoptions 	COMPAT_43
3446a8d6623SGarrett Wollman
345d3e64681SPoul-Henning Kamp# Old tty interface.
346d3e64681SPoul-Henning Kampoptions 	COMPAT_43TTY
347d3e64681SPoul-Henning Kamp
348f5e4c105SJohn Baldwin# Note that as a general rule, COMPAT_FREEBSD<n> depends on
349f5e4c105SJohn Baldwin# COMPAT_FREEBSD<n+1>, COMPAT_FREEBSD<n+2>, etc.
350f5e4c105SJohn Baldwin
351f0eb293eSAlfred Perlstein# Enable FreeBSD4 compatibility syscalls
352f0eb293eSAlfred Perlsteinoptions 	COMPAT_FREEBSD4
353f0eb293eSAlfred Perlstein
354a01b4125SKen Smith# Enable FreeBSD5 compatibility syscalls
355a01b4125SKen Smithoptions 	COMPAT_FREEBSD5
356a01b4125SKen Smith
3576c9fdda7SRuslan Ermilov# Enable FreeBSD6 compatibility syscalls
3586c9fdda7SRuslan Ermilovoptions 	COMPAT_FREEBSD6
3596c9fdda7SRuslan Ermilov
3605965c4b7SJohn Baldwin# Enable FreeBSD7 compatibility syscalls
3615965c4b7SJohn Baldwinoptions 	COMPAT_FREEBSD7
3625965c4b7SJohn Baldwin
3637d313e7bSJohn Baldwin# Enable FreeBSD9 compatibility syscalls
3647d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD9
3657d313e7bSJohn Baldwin
3667d313e7bSJohn Baldwin# Enable FreeBSD10 compatibility syscalls
3677d313e7bSJohn Baldwinoptions 	COMPAT_FREEBSD10
3687d313e7bSJohn Baldwin
3698d59ecb2SHans Petter Selasky# Enable Linux Kernel Programming Interface
3708d59ecb2SHans Petter Selaskyoptions 	COMPAT_LINUXKPI
3718d59ecb2SHans Petter Selasky
3726a8d6623SGarrett Wollman#
3736a8d6623SGarrett Wollman# These three options provide support for System V Interface
3746a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
3756a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
3766a8d6623SGarrett Wollman#
3776a8d6623SGarrett Wollmanoptions 	SYSVSHM
3786a8d6623SGarrett Wollmanoptions 	SYSVSEM
3796a8d6623SGarrett Wollmanoptions 	SYSVMSG
3806a8d6623SGarrett Wollman
3816a8d6623SGarrett Wollman
3826a8d6623SGarrett Wollman#####################################################################
3836a8d6623SGarrett Wollman# DEBUGGING OPTIONS
3846a8d6623SGarrett Wollman
3856a8d6623SGarrett Wollman#
386e2ee2173SMarcel Moolenaar# Compile with kernel debugger related code.
3876a8d6623SGarrett Wollman#
388e2ee2173SMarcel Moolenaaroptions 	KDB
389b5d89ca8SBruce Evans
390b5d89ca8SBruce Evans#
391e2ee2173SMarcel Moolenaar# Print a stack trace of the current thread on the console for a panic.
3927085e708SBruce Evans#
393e2ee2173SMarcel Moolenaaroptions 	KDB_TRACE
394e2ee2173SMarcel Moolenaar
395e2ee2173SMarcel Moolenaar#
396e2ee2173SMarcel Moolenaar# Don't enter the debugger for a panic. Intended for unattended operation
397e2ee2173SMarcel Moolenaar# where you may want to enter the debugger from the console, but still want
398e2ee2173SMarcel Moolenaar# the machine to recover from a panic.
399e2ee2173SMarcel Moolenaar#
400e2ee2173SMarcel Moolenaaroptions 	KDB_UNATTENDED
401e2ee2173SMarcel Moolenaar
402e2ee2173SMarcel Moolenaar#
403e2ee2173SMarcel Moolenaar# Enable the ddb debugger backend.
404e2ee2173SMarcel Moolenaar#
405e2ee2173SMarcel Moolenaaroptions 	DDB
4067085e708SBruce Evans
4077085e708SBruce Evans#
408bfdd261eSBruce Evans# Print the numerical value of symbols in addition to the symbolic
409bfdd261eSBruce Evans# representation.
410bfdd261eSBruce Evans#
411bfdd261eSBruce Evansoptions 	DDB_NUMSYM
412bfdd261eSBruce Evans
413bfdd261eSBruce Evans#
414e2ee2173SMarcel Moolenaar# Enable the remote gdb debugger backend.
4150be15decSJohn Baldwin#
416e2ee2173SMarcel Moolenaaroptions 	GDB
417562d05dfSPaul Traina
418562d05dfSPaul Traina#
419df970488SRobert Watson# SYSCTL_DEBUG enables a 'sysctl' debug tree that can be used to dump the
420df970488SRobert Watson# contents of the registered sysctl nodes on the console.  It is disabled by
4211c9c6382SRuslan Ermilov# default because it generates excessively verbose console output that can
422df970488SRobert Watson# interfere with serial console operation.
423df970488SRobert Watson#
424df970488SRobert Watsonoptions 	SYSCTL_DEBUG
425df970488SRobert Watson
426df970488SRobert Watson#
42721d748a9SAlfred Perlstein# Enable textdump by default, this disables kernel core dumps.
42821d748a9SAlfred Perlstein#
42921d748a9SAlfred Perlsteinoptions		TEXTDUMP_PREFERRED
43021d748a9SAlfred Perlstein
43121d748a9SAlfred Perlstein#
43221d748a9SAlfred Perlstein# Enable extra debug messages while performing textdumps.
43321d748a9SAlfred Perlstein#
43421d748a9SAlfred Perlsteinoptions		TEXTDUMP_VERBOSE
43521d748a9SAlfred Perlstein
43621d748a9SAlfred Perlstein#
43731615ef7SRebecca Cran# NO_SYSCTL_DESCR omits the sysctl node descriptions to save space in the
43831615ef7SRebecca Cran# resulting kernel.
43931615ef7SRebecca Cranoptions		NO_SYSCTL_DESCR
44031615ef7SRebecca Cran
44131615ef7SRebecca Cran#
442d7854da1SMatthew D Fleming# MALLOC_DEBUG_MAXZONES enables multiple uma zones for malloc(9)
443d7854da1SMatthew D Fleming# allocations that are smaller than a page.  The purpose is to isolate
444d7854da1SMatthew D Fleming# different malloc types into hash classes, so that any buffer
445d7854da1SMatthew D Fleming# overruns or use-after-free will usually only affect memory from
446d7854da1SMatthew D Fleming# malloc types in that hash class.  This is purely a debugging tool;
447d7854da1SMatthew D Fleming# by varying the hash function and tracking which hash class was
448d7854da1SMatthew D Fleming# corrupted, the intersection of the hash classes from each instance
449d7854da1SMatthew D Fleming# will point to a single malloc type that is being misused.  At this
450d7854da1SMatthew D Fleming# point inspection or memguard(9) can be used to catch the offending
451d7854da1SMatthew D Fleming# code.
452d7854da1SMatthew D Fleming#
453d7854da1SMatthew D Flemingoptions 	MALLOC_DEBUG_MAXZONES=8
454d7854da1SMatthew D Fleming
455d7854da1SMatthew D Fleming#
456e4eb384bSBosko Milekic# DEBUG_MEMGUARD builds and enables memguard(9), a replacement allocator
457e4eb384bSBosko Milekic# for the kernel used to detect modify-after-free scenarios.  See the
458e4eb384bSBosko Milekic# memguard(9) man page for more information on usage.
459e4eb384bSBosko Milekic#
460e4eb384bSBosko Milekicoptions 	DEBUG_MEMGUARD
461e4eb384bSBosko Milekic
462e4eb384bSBosko Milekic#
463847a2a17SPawel Jakub Dawidek# DEBUG_REDZONE enables buffer underflows and buffer overflows detection for
464847a2a17SPawel Jakub Dawidek# malloc(9).
465847a2a17SPawel Jakub Dawidek#
466847a2a17SPawel Jakub Dawidekoptions 	DEBUG_REDZONE
467847a2a17SPawel Jakub Dawidek
468847a2a17SPawel Jakub Dawidek#
469e79f350dSWarner Losh# EARLY_PRINTF enables support for calling a special printf (eprintf)
470e79f350dSWarner Losh# very early in the kernel (before cn_init() has been called).  This
471e79f350dSWarner Losh# should only be used for debugging purposes early in boot.  Normally,
472e79f350dSWarner Losh# it is not defined.  It is commented out here because this feature
473e79f350dSWarner Losh# isn't generally available. And the required eputc() isn't defined.
474e79f350dSWarner Losh#
475e79f350dSWarner Losh#options	EARLY_PRINTF
476e79f350dSWarner Losh
477e79f350dSWarner Losh#
478ea3fc8e4SJohn Baldwin# KTRACE enables the system-call tracing facility ktrace(2).  To be more
479ea3fc8e4SJohn Baldwin# SMP-friendly, KTRACE uses a worker thread to process most trace events
480ea3fc8e4SJohn Baldwin# asynchronously to the thread generating the event.  This requires a
481ea3fc8e4SJohn Baldwin# pre-allocated store of objects representing trace events.  The
482ea3fc8e4SJohn Baldwin# KTRACE_REQUEST_POOL option specifies the initial size of this store.
483ea3fc8e4SJohn Baldwin# The size of the pool can be adjusted both at boottime and runtime via
484ea3fc8e4SJohn Baldwin# the kern.ktrace_request_pool tunable and sysctl.
4856a8d6623SGarrett Wollman#
4862365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
487ea3fc8e4SJohn Baldwinoptions 	KTRACE_REQUEST_POOL=101
48821c64a07SAndrey A. Chernov
4896a8d6623SGarrett Wollman#
490f7e95633SRuslan Ermilov# KTR is a kernel tracing facility imported from BSD/OS.  It is
491a7bebf90SKris Kennaway# enabled with the KTR option.  KTR_ENTRIES defines the number of
4926e465ac7SDavide Italiano# entries in the circular trace buffer; it may be an arbitrary number.
49336b7dde4SAndriy Gapon# KTR_BOOT_ENTRIES defines the number of entries during the early boot,
49436b7dde4SAndriy Gapon# before malloc(9) is functional.
495a7bebf90SKris Kennaway# KTR_COMPILE defines the mask of events to compile into the kernel as
496a7bebf90SKris Kennaway# defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
497a7bebf90SKris Kennaway# initial value of the ktr_mask variable which determines at runtime
498a7bebf90SKris Kennaway# what events to trace.  KTR_CPUMASK determines which CPU's log
499e3709597SAttilio Rao# events, with bit X corresponding to CPU X.  The layout of the string
500d51e8487SJosh Paetzel# passed as KTR_CPUMASK must match a series of bitmasks each of them
501d4a2ab8cSAttilio Rao# separated by the "," character (ie:
502d4a2ab8cSAttilio Rao# KTR_CPUMASK=0xAF,0xFFFFFFFFFFFFFFFF).  KTR_VERBOSE enables
503a7bebf90SKris Kennaway# dumping of KTR events to the console by default.  This functionality
504a7bebf90SKris Kennaway# can be toggled via the debug.ktr_verbose sysctl and defaults to off
505f7e95633SRuslan Ermilov# if KTR_VERBOSE is not defined.  See ktr(4) and ktrdump(8) for details.
506c508c1b6SJohn Baldwin#
507c508c1b6SJohn Baldwinoptions 	KTR
50836b7dde4SAndriy Gaponoptions 	KTR_BOOT_ENTRIES=1024
50936b7dde4SAndriy Gaponoptions 	KTR_ENTRIES=(128*1024)
5106740ed37SGleb Smirnoffoptions 	KTR_COMPILE=(KTR_ALL)
511a9672a81SJohn Baldwinoptions 	KTR_MASK=KTR_INTR
512d4a2ab8cSAttilio Raooptions 	KTR_CPUMASK=0x3
513d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
514c508c1b6SJohn Baldwin
515c508c1b6SJohn Baldwin#
5161c9c6382SRuslan Ermilov# ALQ(9) is a facility for the asynchronous queuing of records from the kernel
517f7e95633SRuslan Ermilov# to a vnode, and is employed by services such as ktr(4) to produce trace
518453ffeefSRobert Watson# files based on a kernel event stream.  Records are written asynchronously
519453ffeefSRobert Watson# in a worker thread.
520453ffeefSRobert Watson#
521453ffeefSRobert Watsonoptions 	ALQ
522453ffeefSRobert Watsonoptions 	KTR_ALQ
523453ffeefSRobert Watson
524453ffeefSRobert Watson#
5255526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
5266a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
5276a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
5286a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
5296a8d6623SGarrett Wollman# programming errors.
5306a8d6623SGarrett Wollman#
5315526d2d9SEivind Eklundoptions 	INVARIANTS
5325526d2d9SEivind Eklund
5335526d2d9SEivind Eklund#
53434b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
53534b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
53634b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
53734b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
53834b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
53934b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
54034b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
54134b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
54234b15f2aSJohn Baldwin# infrastructure without the added overhead.
54334b15f2aSJohn Baldwin#
54434b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
54534b15f2aSJohn Baldwin
54634b15f2aSJohn Baldwin#
5475526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
5485526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
5495526d2d9SEivind Eklund# it is disabled by default.
5505526d2d9SEivind Eklund#
5510dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
552da59a31cSDavid Greenman
5530dd1eea1SJordan K. Hubbard#
5540b5438c6SRobert Watson# REGRESSION causes optional kernel interfaces necessary only for regression
5553c7c6c12SMike Pritchard# testing to be enabled.  These interfaces may constitute security risks
5560b5438c6SRobert Watson# when enabled, as they permit processes to easily modify aspects of the
5570b5438c6SRobert Watson# run-time environment to reproduce unlikely or unusual (possibly normally
5580b5438c6SRobert Watson# impossible) scenarios.
5590b5438c6SRobert Watson#
5600b5438c6SRobert Watsonoptions 	REGRESSION
5610b5438c6SRobert Watson
5620b5438c6SRobert Watson#
5639c0ef6d5SOliver Fromme# This option lets some drivers co-exist that can't co-exist in a running
564346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
565346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
566346ebe51SEivind Eklund# from.)
567346ebe51SEivind Eklund#
568346ebe51SEivind Eklundoptions 	COMPILING_LINT
569346ebe51SEivind Eklund
5703c90d1eaSRobert Watson#
5713c90d1eaSRobert Watson# STACK enables the stack(9) facility, allowing the capture of kernel stack
5723c90d1eaSRobert Watson# for the purpose of procinfo(1), etc.  stack(9) will also be compiled in
5733c90d1eaSRobert Watson# automatically if DDB(4) is compiled into the kernel.
5743c90d1eaSRobert Watson#
5753c90d1eaSRobert Watsonoptions 	STACK
5763c90d1eaSRobert Watson
5776a8d6623SGarrett Wollman
5786a8d6623SGarrett Wollman#####################################################################
579d47cce3eSMarcel Moolenaar# PERFORMANCE MONITORING OPTIONS
580d47cce3eSMarcel Moolenaar
581d47cce3eSMarcel Moolenaar#
582d47cce3eSMarcel Moolenaar# The hwpmc driver that allows the use of in-CPU performance monitoring
5839c0ef6d5SOliver Fromme# counters for performance monitoring.  The base kernel needs to be configured
584d47cce3eSMarcel Moolenaar# with the 'options' line, while the hwpmc device can be either compiled
585d47cce3eSMarcel Moolenaar# in or loaded as a loadable kernel module.
586d47cce3eSMarcel Moolenaar#
587ad3869b4SJoseph Koshy# Additional configuration options may be required on specific architectures,
588ad3869b4SJoseph Koshy# please see hwpmc(4).
589ad3869b4SJoseph Koshy
590d47cce3eSMarcel Moolenaardevice		hwpmc			# Driver (also a loadable module)
591680f1afdSJohn Baldwinoptions 	HWPMC_DEBUG
592d47cce3eSMarcel Moolenaaroptions 	HWPMC_HOOKS		# Other necessary kernel hooks
593d47cce3eSMarcel Moolenaar
594d47cce3eSMarcel Moolenaar
595d47cce3eSMarcel Moolenaar#####################################################################
5966a8d6623SGarrett Wollman# NETWORKING OPTIONS
59770c0b54cSAndrey A. Chernov
5986a8d6623SGarrett Wollman#
599a22fb0daSGeorge V. Neville-Neil# Protocol families
6006a8d6623SGarrett Wollman#
6016a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
60251f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
603a22fb0daSGeorge V. Neville-Neil
6044871fc4aSJulian Elischeroptions 	ROUTETABLES=2		# allocated fibs up to 65536. default is 1.
6054871fc4aSJulian Elischer					# but that would be a bad idea as they are large.
6068b07e49aSJulian Elischer
60709fe6320SNavdeep Parharoptions 	TCP_OFFLOAD		# TCP offload support.
60809fe6320SNavdeep Parhar
609a22fb0daSGeorge V. Neville-Neil# In order to enable IPSEC you MUST also add device crypto to
610a22fb0daSGeorge V. Neville-Neil# your kernel configuration
611a22fb0daSGeorge V. Neville-Neiloptions 	IPSEC			#IP security (requires device crypto)
6122cb64cb2SGeorge V. Neville-Neil#options 	IPSEC_DEBUG		#debug for IP security
61314dd6717SSam Leffler#
614db2e4792SBjoern A. Zeeb# #DEPRECATED#
615db2e4792SBjoern A. Zeeb# Set IPSEC_FILTERTUNNEL to change the default of the sysctl to force packets
616db2e4792SBjoern A. Zeeb# coming through a tunnel to be processed by any configured packet filtering
617db2e4792SBjoern A. Zeeb# twice. The default is that packets coming out of a tunnel are _not_ processed;
61814dd6717SSam Leffler# they are assumed trusted.
61914dd6717SSam Leffler#
620fa43ee09SBruce M Simpson# IPSEC history is preserved for such packets, and can be filtered
621fa43ee09SBruce M Simpson# using ipfw(8)'s 'ipsec' keyword, when this option is enabled.
62214dd6717SSam Leffler#
623cc977adcSBjoern A. Zeeb#options 	IPSEC_FILTERTUNNEL	#filter ipsec packets from a tunnel
6247b495c44SVANHULLEBUS Yvan#
6257b495c44SVANHULLEBUS Yvan# Set IPSEC_NAT_T to enable NAT-Traversal support.  This enables
6267b495c44SVANHULLEBUS Yvan# optional UDP encapsulation of ESP packets.
6277b495c44SVANHULLEBUS Yvan#
6287b495c44SVANHULLEBUS Yvanoptions		IPSEC_NAT_T		#NAT-T support, UDP encap of ESP
629f73bbaf2SDavid Greenman
630237abf0cSDavide Italiano#
631237abf0cSDavide Italiano# SMB/CIFS requester
632237abf0cSDavide Italiano# NETSMB enables support for SMB protocol, it requires LIBMCHAIN and LIBICONV
633237abf0cSDavide Italiano# options.
634237abf0cSDavide Italianooptions 	NETSMB			#SMB/CIFS requester
635237abf0cSDavide Italiano
636d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
637d8589bd5SBoris Popovoptions 	LIBMCHAIN
638d8589bd5SBoris Popov
6396cd047a0SGleb Smirnoff# libalias library, performing NAT
6406cd047a0SGleb Smirnoffoptions 	LIBALIAS
6416cd047a0SGleb Smirnoff
64234b07340SKip Macy# flowtable cache
64334b07340SKip Macyoptions 	FLOWTABLE
64434b07340SKip Macy
645f8829a4aSRandall Stewart#
646f8829a4aSRandall Stewart# SCTP is a NEW transport protocol defined by
647f8829a4aSRandall Stewart# RFC2960 updated by RFC3309 and RFC3758.. and
648f8829a4aSRandall Stewart# soon to have a new base RFC and many many more
649f8829a4aSRandall Stewart# extensions. This release supports all the extensions
650f8829a4aSRandall Stewart# including many drafts (most about to become RFC's).
6519c0ef6d5SOliver Fromme# It is the reference implementation of SCTP
652f8829a4aSRandall Stewart# and is quite well tested.
653f8829a4aSRandall Stewart#
654f8829a4aSRandall Stewart# Note YOU MUST have both INET and INET6 defined.
6559c0ef6d5SOliver Fromme# You don't have to enable V6, but SCTP is
6569c0ef6d5SOliver Fromme# dual stacked and so far we have not torn apart
657f8829a4aSRandall Stewart# the V6 and V4.. since an association can span
658f8829a4aSRandall Stewart# both a V6 and V4 address at the SAME time :-)
659f8829a4aSRandall Stewart#
660f8829a4aSRandall Stewartoptions 	SCTP
661f8829a4aSRandall Stewart# There are bunches of options:
662f8829a4aSRandall Stewart# this one turns on all sorts of
663d51e8487SJosh Paetzel# nastily printing that you can
6649c0ef6d5SOliver Fromme# do. It's all controlled by a
665f8829a4aSRandall Stewart# bit mask (settable by socket opt and
666f8829a4aSRandall Stewart# by sysctl). Including will not cause
667f8829a4aSRandall Stewart# logging until you set the bits.. but it
668f8829a4aSRandall Stewart# can be quite verbose.. so without this
669f8829a4aSRandall Stewart# option we don't do any of the tests for
670f8829a4aSRandall Stewart# bits and prints.. which makes the code run
671f8829a4aSRandall Stewart# faster.. if you are not debugging don't use.
672f8829a4aSRandall Stewartoptions 	SCTP_DEBUG
673f8829a4aSRandall Stewart#
6749c0ef6d5SOliver Fromme# This option turns off the CRC32c checksum. Basically,
6759c0ef6d5SOliver Fromme# you will not be able to talk to anyone else who
6769c0ef6d5SOliver Fromme# has not done this. Its more for experimentation to
677f8829a4aSRandall Stewart# see how much CPU the CRC32c really takes. Most new
678f8829a4aSRandall Stewart# cards for TCP support checksum offload.. so this
679f8829a4aSRandall Stewart# option gives you a "view" into what SCTP would be
680f8829a4aSRandall Stewart# like with such an offload (which only exists in
681f8829a4aSRandall Stewart# high in iSCSI boards so far). With the new
682f8829a4aSRandall Stewart# splitting 8's algorithm its not as bad as it used
683f8829a4aSRandall Stewart# to be.. but it does speed things up try only
684f8829a4aSRandall Stewart# for in a captured lab environment :-)
685f8829a4aSRandall Stewartoptions 	SCTP_WITH_NO_CSUM
686f8829a4aSRandall Stewart#
687cb7a4976SRandall Stewart
688f8829a4aSRandall Stewart#
689f8829a4aSRandall Stewart# All that options after that turn on specific types of
690f8829a4aSRandall Stewart# logging. You can monitor CWND growth, flight size
691f8829a4aSRandall Stewart# and all sorts of things. Go look at the code and
692f8829a4aSRandall Stewart# see. I have used this to produce interesting
693f8829a4aSRandall Stewart# charts and graphs as well :->
694f8829a4aSRandall Stewart#
6959c0ef6d5SOliver Fromme# I have not yet committed the tools to get and print
696f8829a4aSRandall Stewart# the logs, I will do that eventually .. before then
697f8829a4aSRandall Stewart# if you want them send me an email rrs@freebsd.org
698f7e95633SRuslan Ermilov# You basically must have ktr(4) enabled for these
699cb7a4976SRandall Stewart# and you then set the sysctl to turn on/off various
700f7e95633SRuslan Ermilov# logging bits. Use ktrdump(8) to pull the log and run
7019c0ef6d5SOliver Fromme# it through a display program.. and graphs and other
702cb7a4976SRandall Stewart# things too.
703f8829a4aSRandall Stewart#
704f8829a4aSRandall Stewartoptions 	SCTP_LOCK_LOGGING
705f8829a4aSRandall Stewartoptions 	SCTP_MBUF_LOGGING
706cb7a4976SRandall Stewartoptions 	SCTP_MBCNT_LOGGING
707cb7a4976SRandall Stewartoptions 	SCTP_PACKET_LOGGING
708cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_CHUNKS
709cb7a4976SRandall Stewartoptions 	SCTP_LTRACE_ERRORS
710cb7a4976SRandall Stewart
711f8829a4aSRandall Stewart
71202b199f1SMax Laier# altq(9). Enable the base part of the hooks with the ALTQ option.
71302b199f1SMax Laier# Individual disciplines must be built into the base system and can not be
714cceffdeeSAndrew Thompson# loaded as modules at this point. ALTQ requires a stable TSC so if yours is
715cceffdeeSAndrew Thompson# broken or changes with CPU throttling then you must also have the ALTQ_NOPCC
716cceffdeeSAndrew Thompson# option.
71702b199f1SMax Laieroptions 	ALTQ
718755911cdSGreg Leheyoptions 	ALTQ_CBQ	# Class Based Queueing
719c7219167SMax Laieroptions 	ALTQ_RED	# Random Early Detection
72002b199f1SMax Laieroptions 	ALTQ_RIO	# RED In/Out
72102b199f1SMax Laieroptions 	ALTQ_HFSC	# Hierarchical Packet Scheduler
722a5b789f6SErmal Luçioptions		ALTQ_FAIRQ	# Fair Packet Scheduler
72302b199f1SMax Laieroptions 	ALTQ_CDNR	# Traffic conditioner
7243c7c6c12SMike Pritchardoptions 	ALTQ_PRIQ	# Priority Queueing
725cceffdeeSAndrew Thompsonoptions 	ALTQ_NOPCC	# Required if the TSC is unusable
72602b199f1SMax Laieroptions 	ALTQ_DEBUG
72702b199f1SMax Laier
7284cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
7294cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
7304cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
7314cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
73292a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
73392a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
7344cf49a43SJulian Elischeroptions 	NETGRAPH		# netgraph(4) system
73573e87266SGleb Smirnoffoptions 	NETGRAPH_DEBUG		# enable extra debugging, this
73673e87266SGleb Smirnoff					# affects netgraph(4) and nodes
73773e87266SGleb Smirnoff# Node types
7384cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
739bde778e9SBenno Riceoptions 	NETGRAPH_ATMLLC
740b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_ATM_ATMPIF
741b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH		# ng_bluetooth(4)
742b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_BT3C		# ng_bt3c(4)
743b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_HCI		# ng_hci(4)
744b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_L2CAP	# ng_l2cap(4)
745b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_SOCKET	# ng_btsocket(4)
746b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBT		# ng_ubt(4)
747b84b10f9SMaksim Yevmenkinoptions 	NETGRAPH_BLUETOOTH_UBTBCMFW	# ubtbcmfw(4)
74892a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
749901fadf7SArchie Cobbsoptions 	NETGRAPH_BRIDGE
7507d3b4a08SAlexander Motinoptions 	NETGRAPH_CAR
7514cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
7529e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_DEFLATE
75331578ac8SGleb Smirnoffoptions 	NETGRAPH_DEVICE
7544cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
7559d564133SRobert Watsonoptions 	NETGRAPH_EIFACE
75646aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
7574cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
75837379158SBrooks Davisoptions 	NETGRAPH_GIF
75937379158SBrooks Davisoptions 	NETGRAPH_GIF_DEMUX
7604cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
7614cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
76237379158SBrooks Davisoptions 	NETGRAPH_IP_INPUT
763f2a7ef4eSGleb Smirnoffoptions 	NETGRAPH_IPFW
76448e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
765901fadf7SArchie Cobbsoptions 	NETGRAPH_L2TP
7664cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
767a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
768a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
769a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
770cec50deaSGleb Smirnoffoptions 	NETGRAPH_NETFLOW
7716cd047a0SGleb Smirnoffoptions 	NETGRAPH_NAT
7727d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
773d05181f9SAndrey V. Elsukovoptions 	NETGRAPH_PATCH
774991633afSMarko Zecoptions 	NETGRAPH_PIPE
775b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
776b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
777add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
7789e6f1d3bSGleb Smirnoffoptions 	NETGRAPH_PRED1
7794cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
780b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
7814d60fee2SBrooks Davisoptions 	NETGRAPH_SPLIT
7820a6818e2SRoman Kurakinoptions 	NETGRAPH_SPPP
783d473c9d5SGleb Smirnoffoptions 	NETGRAPH_TAG
784e9110049SGleb Smirnoffoptions 	NETGRAPH_TCPMSS
7854cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
7864cf49a43SJulian Elischeroptions 	NETGRAPH_UI
787b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
788b4263060SRuslan Ermilovoptions 	NETGRAPH_VLAN
789666ea1b6SMaksim Yevmenkin
79002152e8fSHartmut Brandt# NgATM - Netgraph ATM
79102152e8fSHartmut Brandtoptions 	NGATM_ATM
792027ebd2fSHartmut Brandtoptions 	NGATM_ATMBASE
793027ebd2fSHartmut Brandtoptions 	NGATM_SSCOP
794027ebd2fSHartmut Brandtoptions 	NGATM_SSCFU
795ed91f9a5SHartmut Brandtoptions 	NGATM_UNI
796a7e22394SHartmut Brandtoptions 	NGATM_CCATM
79702152e8fSHartmut Brandt
798c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
7993cf4d0bfSPoul-Henning Kamp
8000990ef0aSKevin Lo# Network stack virtualization.
801287cd4a2SKevin Lo#options	VIMAGE
802287cd4a2SKevin Lo#options	VNET_DEBUG	# debug for VIMAGE
8030990ef0aSKevin Lo
8046a8d6623SGarrett Wollman#
8056a8d6623SGarrett Wollman# Network interfaces:
806f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
80736782d14SWojciech A. Koszekdevice		loop
80836782d14SWojciech A. Koszek
809f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
8109d5abbddSJens Schweikhardt#  Ethernets; it is MANDATORY when an Ethernet device driver is
811722012ccSJulian Elischer#  configured or token-ring is enabled.
81236782d14SWojciech A. Koszekdevice		ether
81336782d14SWojciech A. Koszek
814fc67901fSYaroslav Tykhiy#  The `vlan' device implements the VLAN tagging of Ethernet frames
8159d9ab10eSAntoine Brodin#  according to IEEE 802.1Q.
81636782d14SWojciech A. Koszekdevice		vlan
81736782d14SWojciech A. Koszek
818007054f0SBryan Venteicher# The `vxlan' device implements the VXLAN encapsulation of Ethernet
819007054f0SBryan Venteicher# frames in UDP packets according to RFC7348.
820007054f0SBryan Venteicherdevice		vxlan
821007054f0SBryan Venteicher
82257a42501SGarrett Wollman#  The `wlan' device provides generic code to support 802.11
82367e4db77SSam Leffler#  drivers, including host AP mode; it is MANDATORY for the wi,
824f4463607SSam Leffler#  and ath drivers and will eventually be required by all 802.11 drivers.
82536782d14SWojciech A. Koszekdevice		wlan
82636782d14SWojciech A. Koszekoptions 	IEEE80211_DEBUG		#enable debugging msgs
82736782d14SWojciech A. Koszekoptions 	IEEE80211_AMPDU_AGE	#age frames in AMPDU reorder q's
82859aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_MESH	#enable 802.11s D3.0 support
82959aa14a9SRui Paulooptions 	IEEE80211_SUPPORT_TDMA	#enable TDMA support
83036782d14SWojciech A. Koszek
83167e4db77SSam Leffler#  The `wlan_wep', `wlan_tkip', and `wlan_ccmp' devices provide
83267e4db77SSam Leffler#  support for WEP, TKIP, and AES-CCMP crypto protocols optionally
83367e4db77SSam Leffler#  used with 802.11 devices that depend on the `wlan' module.
83436782d14SWojciech A. Koszekdevice		wlan_wep
83536782d14SWojciech A. Koszekdevice		wlan_ccmp
83636782d14SWojciech A. Koszekdevice		wlan_tkip
83736782d14SWojciech A. Koszek
83867e4db77SSam Leffler#  The `wlan_xauth' device provides support for external (i.e. user-mode)
83967e4db77SSam Leffler#  authenticators for use with 802.11 drivers that use the `wlan'
84034341a71SJohn Baldwin#  module and support 802.1x and/or WPA security protocols.
84136782d14SWojciech A. Koszekdevice		wlan_xauth
84236782d14SWojciech A. Koszek
84367e4db77SSam Leffler#  The `wlan_acl' device provides a MAC-based access control mechanism
84467e4db77SSam Leffler#  for use with 802.11 drivers operating in ap mode and using the
84567e4db77SSam Leffler#  `wlan' module.
84636782d14SWojciech A. Koszek#  The 'wlan_amrr' device provides AMRR transmit rate control algorithm
84736782d14SWojciech A. Koszekdevice		wlan_acl
84836782d14SWojciech A. Koszekdevice		wlan_amrr
84936782d14SWojciech A. Koszek
85036782d14SWojciech A. Koszek# Generic TokenRing
85136782d14SWojciech A. Koszekdevice		token
85236782d14SWojciech A. Koszek
8531a02faf6SGarrett Wollman#  The `fddi' device provides generic code to support FDDI.
85436782d14SWojciech A. Koszekdevice		fddi
85536782d14SWojciech A. Koszek
856eda6ecb2SMax Khon#  The `arcnet' device provides generic code to support Arcnet.
85736782d14SWojciech A. Koszekdevice		arcnet
85836782d14SWojciech A. Koszek
859f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
860e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
86136782d14SWojciech A. Koszekdevice		sppp
86236782d14SWojciech A. Koszek
863f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
864d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
8659c0ef6d5SOliver Fromme#  option.  DHCP requires bpf.
86636782d14SWojciech A. Koszekdevice		bpf
86736782d14SWojciech A. Koszek
868e4b68814SLuigi Rizzo#  The `netmap' device implements memory-mapped access to network
869e4b68814SLuigi Rizzo#  devices from userspace, enabling wire-speed packet capture and
870e4b68814SLuigi Rizzo#  generation even at 10Gbit/s. Requires support in the device
871e4b68814SLuigi Rizzo#  driver. Supported drivers are ixgbe, e1000, re.
872e4b68814SLuigi Rizzodevice		netmap
873e4b68814SLuigi Rizzo
874f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
87559d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
87670e04181SYaroslav Tykhiy#  included for testing and benchmarking purposes.
87736782d14SWojciech A. Koszekdevice		disc
87836782d14SWojciech A. Koszek
879d0ea4743SBjoern A. Zeeb# The `epair' device implements a virtual back-to-back connected Ethernet
880d0ea4743SBjoern A. Zeeb# like interface pair.
881d0ea4743SBjoern A. Zeebdevice		epair
882d0ea4743SBjoern A. Zeeb
88363518eccSYaroslav Tykhiy#  The `edsc' device implements a minimal Ethernet interface,
88463518eccSYaroslav Tykhiy#  which discards all packets sent and receives none.
88536782d14SWojciech A. Koszekdevice		edsc
88636782d14SWojciech A. Koszek
8874c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
88836782d14SWojciech A. Koszekdevice		tap
88936782d14SWojciech A. Koszek
89036782d14SWojciech A. Koszek#  The `tun' device implements (user-)ppp and nos-tun(8)
89136782d14SWojciech A. Koszekdevice		tun
89236782d14SWojciech A. Koszek
893f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
894cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
895cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
896f325335cSAndrey V. Elsukov#  The `gre' device implements GRE (Generic Routing Encapsulation) tunneling,
897f325335cSAndrey V. Elsukov#  as specified in the RFC 2784 and RFC 2890.
898f325335cSAndrey V. Elsukov#  The `me' device implements Minimal Encapsulation within IPv4 as
899f325335cSAndrey V. Elsukov#  specified in the RFC 2004.
900f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
901f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
90236782d14SWojciech A. Koszekdevice		gif
90336782d14SWojciech A. Koszekdevice		gre
904f325335cSAndrey V. Elsukovdevice		me
90536782d14SWojciech A. Koszekoptions 	XBONEHACK
90636782d14SWojciech A. Koszek
907d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
90836782d14SWojciech A. Koszekdevice		stf
90936782d14SWojciech A. Koszek
9108d69c48bSMax Laier# The pf packet filter consists of three devices:
9118d69c48bSMax Laier#  The `pf' device provides /dev/pf and the firewall code itself.
9128d69c48bSMax Laier#  The `pflog' device provides the pflog0 interface which logs packets.
9138d69c48bSMax Laier#  The `pfsync' device provides the pfsync0 interface used for
9148d69c48bSMax Laier#   synchronization of firewall state tables (over the net).
91536782d14SWojciech A. Koszekdevice		pf
91636782d14SWojciech A. Koszekdevice		pflog
91736782d14SWojciech A. Koszekdevice		pfsync
91836782d14SWojciech A. Koszek
91936782d14SWojciech A. Koszek# Bridge interface.
92036782d14SWojciech A. Koszekdevice		if_bridge
92136782d14SWojciech A. Koszek
92236782d14SWojciech A. Koszek# Common Address Redundancy Protocol. See carp(4) for more details.
92336782d14SWojciech A. Koszekdevice		carp
92436782d14SWojciech A. Koszek
92536782d14SWojciech A. Koszek# IPsec interface.
92636782d14SWojciech A. Koszekdevice		enc
92736782d14SWojciech A. Koszek
92836782d14SWojciech A. Koszek# Link aggregation interface.
92936782d14SWojciech A. Koszekdevice		lagg
93036782d14SWojciech A. Koszek
9318d69c48bSMax Laier#
9326a8d6623SGarrett Wollman# Internet family options:
9336a8d6623SGarrett Wollman#
9346a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
9350948f0a2SBruce M Simpson# with mrouted and XORP.
936e0f688baSJeffrey Hsu#
937d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
938ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
939ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
940ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
941ab6e02daSJordan K. Hubbard#
942ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
943ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
944a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
945ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
946ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
947ab6e02daSJordan K. Hubbard# feature works properly.
9488dd4744eSJordan K. Hubbard#
949ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
950ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
951ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
952ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
953ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
954ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
955ffdd472dSPeter Wemm# out of sync.
956d29895dcSGarrett Wollman#
95784bb6a2eSAndre Oppermann# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''.  It
95884bb6a2eSAndre Oppermann# depends on IPFIREWALL if compiled into the kernel.
95993e0e116SJulian Elischer#
96061c0e134SPaolo Pisati# IPFIREWALL_NAT adds support for in kernel nat in ipfw, and it requires
961531c890bSPaolo Pisati# LIBALIAS.
96261c0e134SPaolo Pisati#
9631b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
9641c9c6382SRuslan Ermilov# packets without touching the TTL).  This can be useful to hide firewalls
9651b968362SDag-Erling Smørgrav# from traceroute and similar tools.
9661b968362SDag-Erling Smørgrav#
9677f7ef494SGleb Smirnoff# PF_DEFAULT_TO_DROP causes the default pf(4) rule to deny everything.
9687f7ef494SGleb Smirnoff#
9695e331acdSGarrett Wollman# TCPDEBUG enables code which keeps traces of the TCP state machine
9705e331acdSGarrett Wollman# for sockets with the SO_DEBUG option set, which can then be examined
9715e331acdSGarrett Wollman# using the trpt(8) utility.
97265e8111fSBruce Evans#
97386a996e6SHiren Panchasara# TCPPCAP enables code which keeps the last n packets sent and received
97486a996e6SHiren Panchasara# on a TCP socket.
97586a996e6SHiren Panchasara#
97665e4e499SGleb Smirnoff# RADIX_MPATH provides support for equal-cost multi-path routing.
9779731596aSGleb Smirnoff#
978e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
979d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
9804479e72cSCrist J. Clarkoptions 	IPFIREWALL_VERBOSE	#enable logging to syslogd(8)
9815895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
982e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
98361c0e134SPaolo Pisatioptions 	IPFIREWALL_NAT		#ipfw kernel nat support
98493e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
9859cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
9869cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
9870c3757dfSDarren Reedoptions 	IPFILTER_LOOKUP		#ipfilter pools
9888259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
9891b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
9907f7ef494SGleb Smirnoffoptions 	PF_DEFAULT_TO_DROP	#drop everything by default
99165e8111fSBruce Evansoptions 	TCPDEBUG
99286a996e6SHiren Panchasaraoptions 	TCPPCAP
9939731596aSGleb Smirnoffoptions 	RADIX_MPATH
9946a8d6623SGarrett Wollman
99553dcc544SMike Silbersack# The MBUF_STRESS_TEST option enables options which create
99653dcc544SMike Silbersack# various random failures / extreme cases related to mbuf
997f8f8803bSBruce Evans# functions.  See mbuf(9) for a list of available test cases.
9984e77d255SJulian Elischer# MBUF_PROFILING enables code to profile the mbuf chains
9996eeac1d9SJulian Elischer# exiting the system (via participating interfaces) and
10006eeac1d9SJulian Elischer# return a logarithmic histogram of monitored parameters
10016eeac1d9SJulian Elischer# (e.g. packet size, wasted space, number of mbufs in chain).
100253dcc544SMike Silbersackoptions 	MBUF_STRESS_TEST
10036eeac1d9SJulian Elischeroptions 	MBUF_PROFILING
10044a5ccac7SMike Silbersack
10059c0ef6d5SOliver Fromme# Statically link in accept filters
1006a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_DATA
1007744eaff7SDavid Maloneoptions 	ACCEPT_FILTER_DNS
1008a79b7128SAlfred Perlsteinoptions 	ACCEPT_FILTER_HTTP
1009a79b7128SAlfred Perlstein
1010b52f8407SBruce M Simpson# TCP_SIGNATURE adds support for RFC 2385 (TCP-MD5) digests. These are
1011b52f8407SBruce M Simpson# carried in TCP option 19. This option is commonly used to protect
1012b52f8407SBruce M Simpson# TCP sessions (e.g. BGP) where IPSEC is not available nor desirable.
1013b52f8407SBruce M Simpson# This is enabled on a per-socket basis using the TCP_MD5SIG socket option.
1014b65946c6SJohn-Mark Gurney# This requires the use of 'device crypto' and 'options IPSEC'.
10155164136dSBjoern A. Zeeboptions 	TCP_SIGNATURE		#include support for RFC 2385
1016b52f8407SBruce M Simpson
1017f8f8803bSBruce Evans# DUMMYNET enables the "dummynet" bandwidth limiter.  You need IPFIREWALL
1018f8f8803bSBruce Evans# as well.  See dummynet(4) and ipfw(8) for more info.  When you run
1019358f8d82SRobert Watson# DUMMYNET it is advisable to also have at least "options HZ=1000" to achieve
1020358f8d82SRobert Watson# a smooth scheduling of the traffic.
102168ec4eb6SLuigi Rizzooptions 	DUMMYNET
102268e9d934SLuigi Rizzo
10236a8d6623SGarrett Wollman#####################################################################
10246a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
1025e3178a06SJordan K. Hubbard
10262365e64fSRodney W. Grimes#
10273f850e6aSKonstantin Belousov# Only the root filesystem needs to be statically compiled or preloaded
10283f850e6aSKonstantin Belousov# as module; everything else will be automatically loaded at mount
10293f850e6aSKonstantin Belousov# time.  Some people still prefer to statically compile other
10303f850e6aSKonstantin Belousov# filesystems as well.
10316a8d6623SGarrett Wollman#
103255793cdcSAttilio Rao# NB: The UNION filesystem was known to be buggy in the past.  It is now
1033534046e3SRong-En Fan# being actively maintained, although there are still some issues being
1034534046e3SRong-En Fan# resolved.
10352365e64fSRodney W. Grimes#
1036f1a9c715SDavid Greenman
10376a8d6623SGarrett Wollman# One of these is mandatory:
10386a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
1039c15882f0SRick Macklemoptions 	NFSCL			#Network File System client
10406a8d6623SGarrett Wollman
10416a8d6623SGarrett Wollman# The rest are optional:
10423914ddf8SEdward Tomasz Napieralaoptions 	AUTOFS			#Automounter filesystem
10435895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
104499d300a1SRuslan Ermilovoptions 	FDESCFS			#File descriptor filesystem
10455fe58019SAttilio Raooptions 	FUSE			#FUSE support module
1046dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
1047dfdcada3SDoug Rabsonoptions 	NFSLOCKD		#Network Lock Manager
10483e32dff5SJohn Baldwinoptions 	NFSD			#Network Filesystem Server
10499c0ef6d5SOliver Frommeoptions 	KGSSAPI			#Kernel GSSAPI implementation
10501bea7c61SMaxim Sobolev
1051f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
10524d2647f9SDag-Erling Smørgravoptions 	PROCFS			#Process filesystem (requires PSEUDOFS)
105352ebde4fSDag-Erling Smørgravoptions 	PSEUDOFS		#Pseudo-filesystem framework
1054bcc1205cSDag-Erling Smørgravoptions 	PSEUDOFS_TRACE		#Debugging support for PSEUDOFS
1055237abf0cSDavide Italianooptions 	SMBFS			#SMB/CIFS filesystem
105678920d0fSKevin Looptions 	TMPFS			#Efficient memory filesystem
1057df263cbdSScott Longoptions 	UDF			#Universal Disk Format
105899d300a1SRuslan Ermilovoptions 	UNIONFS			#Union filesystem
1059bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
1060bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
1061f1a9c715SDavid Greenman
1062d0a28bafSAlexander Langer# Soft updates is a technique for improving filesystem speed and
1063d61e6649SAlexander Langer# making abrupt shutdown less risky.
1064f8f8d7afSEivind Eklund#
10653d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
1066b1897c19SJulian Elischer
1067a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
106851be6918SChris D. Faulhaber# and is used for ACLs, Capabilities, and MAC labels.
106951be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.extattr for more information.
107049993db0SRobert Watsonoptions 	UFS_EXTATTR
107149993db0SRobert Watsonoptions 	UFS_EXTATTR_AUTOSTART
1072a64ed089SRobert Watson
107351be6918SChris D. Faulhaber# Access Control List support for UFS filesystems.  The current ACL
107451be6918SChris D. Faulhaber# implementation requires extended attribute support, UFS_EXTATTR,
107551be6918SChris D. Faulhaber# for the underlying filesystem.
107651be6918SChris D. Faulhaber# See src/sys/ufs/ufs/README.acls for more information.
107751be6918SChris D. Faulhaberoptions 	UFS_ACL
107851be6918SChris D. Faulhaber
10799b5ad47fSIan Dowse# Directory hashing improves the speed of operations on very large
10809b5ad47fSIan Dowse# directories at the expense of some memory.
10819b5ad47fSIan Dowseoptions 	UFS_DIRHASH
10829b5ad47fSIan Dowse
1083f348204cSPawel Jakub Dawidek# Gjournal-based UFS journaling support.
1084f348204cSPawel Jakub Dawidekoptions 	UFS_GJOURNAL
1085f348204cSPawel Jakub Dawidek
108671e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
108771e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
1088f4c1f0b9SAdrian Chadd# This is now optional.
1089f4c1f0b9SAdrian Chadd# If not defined, the root filesystem passed in as the MFS_IMAGE makeoption
1090f4c1f0b9SAdrian Chadd# will be automatically embedded in the kernel during linking. Its exact size
1091f4c1f0b9SAdrian Chadd# will be consumed within the kernel.
1092f4c1f0b9SAdrian Chadd# If defined, the old way of embedding the filesystem in the kernel will be
1093f4c1f0b9SAdrian Chadd# used. That is to say MD_ROOT_SIZE KB will be allocated in the kernel and
1094f4c1f0b9SAdrian Chadd# later, the filesystem image passed in as the MFS_IMAGE makeoption will be
1095f4c1f0b9SAdrian Chadd# dd'd into the reserved space if it fits.
109671e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
109771e4fff8SPoul-Henning Kamp
109871e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
109971e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
110071e4fff8SPoul-Henning Kampoptions 	MD_ROOT
1101d52d7365SPoul-Henning Kamp
1102495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
11032365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
11046a8d6623SGarrett Wollman
1105276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
110645c203fcSGleb Smirnoff# users, using SAMBA, you may consider setting this option
1107276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
1108276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
1109ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
11106110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
1111276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
1112276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
11139c0ef6d5SOliver Fromme# set on the directory as well; see chmod(1). PC owners can't see/set
1114276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
1115276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
1116276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
1117cb800e34SJulian Elischer#
1118cb800e34SJulian Elischeroptions 	SUIDDIR
1119cb800e34SJulian Elischer
1120df394affSJohn-Mark Gurney# NFS options:
11215895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
11225895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
11235895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
11245895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
1125df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
1126df394affSJohn-Mark Gurney
1127053a2b61SEivind Eklund#
1128053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
1129053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
1130053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
1131053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
1132053a2b61SEivind Eklund#
11335895e3c8SPeter Wemmoptions 	EXT2FS
1134053a2b61SEivind Eklund
1135fe98fb32SJean-Sébastien Pédron#
1136fe98fb32SJean-Sébastien Pédron# Add support for the ReiserFS filesystem (used in Linux). Currently,
1137fe98fb32SJean-Sébastien Pédron# this is limited to read-only access.
1138fe98fb32SJean-Sébastien Pédron#
1139fe98fb32SJean-Sébastien Pédronoptions 	REISERFS
1140fe98fb32SJean-Sébastien Pédron
11418ab2f5ecSMark Murray# Cryptographically secure random number generator; /dev/random
1142ac519db0SMark Murraydevice		random
114315bbdecfSMark Murray
11448ab2f5ecSMark Murray# The system memory devices; /dev/mem, /dev/kmem
1145e83e229dSWarner Loshdevice		mem
11468ab2f5ecSMark Murray
114700a5db46SStacey Son# The kernel symbol table device; /dev/ksyms
114800a5db46SStacey Sondevice		ksyms
114900a5db46SStacey Son
1150c4f02a89SMax Khon# Optional character code conversion support with LIBICONV.
1151c4f02a89SMax Khon# Each option requires their base file system and LIBICONV.
1152c4f02a89SMax Khonoptions 	CD9660_ICONV
1153c4f02a89SMax Khonoptions 	MSDOSFS_ICONV
1154126f0dfaSScott Longoptions 	UDF_ICONV
1155c4f02a89SMax Khon
11566a8d6623SGarrett Wollman
11576a8d6623SGarrett Wollman#####################################################################
1158abc97a06SBruce Evans# POSIX P1003.1B
1159abc97a06SBruce Evans
11601c9c6382SRuslan Ermilov# Real time extensions added in the 1993 POSIX
1161abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
1162abc97a06SBruce Evans
11635895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
11648cbf4973SAlfred Perlstein# p1003_1b_semaphores are very experimental,
11658cbf4973SAlfred Perlstein# user should be ready to assist in debugging if problems arise.
11663ffb9fadSAlfred Perlsteinoptions 	P1003_1B_SEMAPHORES
1167abc97a06SBruce Evans
11685b40ce27SDavid Xu# POSIX message queue
11695b40ce27SDavid Xuoptions 	P1003_1B_MQUEUE
1170abc97a06SBruce Evans
1171abc97a06SBruce Evans#####################################################################
117212e9f256SRobert Watson# SECURITY POLICY PARAMETERS
117312e9f256SRobert Watson
1174fdcba197SRobert Watson# Support for BSM audit
1175fdcba197SRobert Watsonoptions 	AUDIT
1176fdcba197SRobert Watson
1177cd6d1d76SBruce Evans# Support for Mandatory Access Control (MAC):
1178cd6d1d76SBruce Evansoptions 	MAC
1179eae2f20cSRobert Watsonoptions 	MAC_BIBA
1180eae2f20cSRobert Watsonoptions 	MAC_BSDEXTENDED
1181eae2f20cSRobert Watsonoptions 	MAC_IFOFF
1182c4725737SRobert Watsonoptions 	MAC_LOMAC
1183eae2f20cSRobert Watsonoptions 	MAC_MLS
1184eae2f20cSRobert Watsonoptions 	MAC_NONE
1185eae2f20cSRobert Watsonoptions 	MAC_PARTITION
118603d03162SRobert Watsonoptions 	MAC_PORTACL
1187eae2f20cSRobert Watsonoptions 	MAC_SEEOTHERUIDS
1188782f7255SRobert Watsonoptions 	MAC_STUB
1189eae2f20cSRobert Watsonoptions 	MAC_TEST
119012e9f256SRobert Watson
119196fcc75fSRobert Watson# Support for Capsicum
119255d4d6f4SJonathan Andersonoptions 	CAPABILITIES	# fine-grained rights on file descriptors
119355d4d6f4SJonathan Andersonoptions 	CAPABILITY_MODE	# sandboxes with no global namespace access
119496fcc75fSRobert Watson
119512e9f256SRobert Watson
119612e9f256SRobert Watson#####################################################################
1197000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
1198000033d0SJeroen Ruigrok van der Werven
1199000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
1200358f8d82SRobert Watson# default value (1000 on most architectures) means a granularity of 1ms
1201358f8d82SRobert Watson# (1s/HZ).  Historically, the default was 100, but finer granularity is
1202358f8d82SRobert Watson# required for DUMMYNET and other systems on modern hardware.  There are
1203358f8d82SRobert Watson# reasonable arguments that HZ should, in fact, be 100 still; consider,
1204358f8d82SRobert Watson# that reducing the granularity too much might cause excessive overhead in
1205358f8d82SRobert Watson# clock interrupt processing, potentially causing ticks to be missed and thus
1206358f8d82SRobert Watson# actually reducing the accuracy of operation.
1207000033d0SJeroen Ruigrok van der Werven
1208000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
1209000033d0SJeroen Ruigrok van der Werven
1210f309f881SJohn Baldwin# Enable support for the kernel PLL to use an external PPS signal,
1211f309f881SJohn Baldwin# under supervision of [x]ntpd(8)
1212f309f881SJohn Baldwin# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1213f309f881SJohn Baldwin
1214f309f881SJohn Baldwinoptions 	PPS_SYNC
1215f309f881SJohn Baldwin
1216b0fdc837SLawrence Stewart# Enable support for generic feed-forward clocks in the kernel.
1217b0fdc837SLawrence Stewart# The feed-forward clock support is an alternative to the feedback oriented
1218b0fdc837SLawrence Stewart# ntpd/system clock approach, and is to be used with a feed-forward
1219b0fdc837SLawrence Stewart# synchronization algorithm such as the RADclock:
1220b0fdc837SLawrence Stewart# More info here: http://www.synclab.org/radclock
1221b0fdc837SLawrence Stewart
1222b0fdc837SLawrence Stewartoptions 	FFCLOCK
1223b0fdc837SLawrence Stewart
1224000033d0SJeroen Ruigrok van der Werven
1225000033d0SJeroen Ruigrok van der Werven#####################################################################
1226de6a307eSPeter Dufault# SCSI DEVICES
1227de6a307eSPeter Dufault
12286a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
12296a8d6623SGarrett Wollman
12306a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
1231ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
12326a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
12336a8d6623SGarrett Wollman# device configuration sections below.
12346a8d6623SGarrett Wollman#
1235e14eb5a1SGarrett Wollman# It is possible to wire down your SCSI devices so that a given bus,
1236e14eb5a1SGarrett Wollman# target, and LUN always come on line as the same device unit.  In
1237e14eb5a1SGarrett Wollman# earlier versions the unit numbers were assigned in the order that
1238e14eb5a1SGarrett Wollman# the devices were probed on the SCSI bus.  This means that if you
1239e14eb5a1SGarrett Wollman# removed a disk drive, you may have had to rewrite your /etc/fstab
1240e14eb5a1SGarrett Wollman# file, and also that you had to be careful when adding a new disk
1241e14eb5a1SGarrett Wollman# as it may have been probed earlier and moved your device configuration
1242e14eb5a1SGarrett Wollman# around.  (See also option GEOM_VOL for a different solution to this
1243e14eb5a1SGarrett Wollman# problem.)
1244ebc1a0e2SPeter Dufault
1245ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
1246ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
1247700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
1248700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
1249ebc1a0e2SPeter Dufault
1250ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
1251ebc1a0e2SPeter Dufault
1252f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
1253f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
1254f71c01ccSPeter Wemmhint.scbus.1.bus="0"
1255f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
1256f71c01ccSPeter Wemmhint.scbus.3.bus="0"
1257f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
1258f71c01ccSPeter Wemmhint.scbus.2.bus="1"
1259f71c01ccSPeter Wemmhint.da.0.at="scbus0"
1260f71c01ccSPeter Wemmhint.da.0.target="0"
1261f71c01ccSPeter Wemmhint.da.0.unit="0"
1262f71c01ccSPeter Wemmhint.da.1.at="scbus3"
1263f71c01ccSPeter Wemmhint.da.1.target="1"
1264f71c01ccSPeter Wemmhint.da.2.at="scbus2"
1265f71c01ccSPeter Wemmhint.da.2.target="3"
1266f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
1267f71c01ccSPeter Wemmhint.sa.1.target="6"
1268ebc1a0e2SPeter Dufault
1269ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
1270ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
1271ebc1a0e2SPeter Dufault
1272ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
1273ebc1a0e2SPeter Dufault
1274cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
1275cf2458c9SMatt Jacob#
1276cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
1277cf2458c9SMatt Jacob# ("WORM") devices.
1278cf2458c9SMatt Jacob#
1279cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
1280cf2458c9SMatt Jacob#
1281cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
1282cf2458c9SMatt Jacob#
12833c7c6c12SMike Pritchard# The ses driver drives SCSI Environment Services ("ses") and
12843c7c6c12SMike Pritchard# SAF-TE ("SCSI Accessible Fault-Tolerant Enclosure") devices.
1285cf2458c9SMatt Jacob#
1286cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
1287cf2458c9SMatt Jacob#
12881eba4c79SScott Long# The sg driver provides a passthrough API that is compatible with the
12891eba4c79SScott Long# Linux SG driver.  It will work in conjunction with the COMPAT_LINUX
12901eba4c79SScott Long# option to run linux SG apps.  It can also stand on its own and provide
1291d51e8487SJosh Paetzel# source level API compatibility for porting apps to FreeBSD.
1292cf2458c9SMatt Jacob#
1293cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
1294cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
1295cf2458c9SMatt Jacob#
1296cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
1297cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
1298cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
1299cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
1300cf2458c9SMatt Jacob#
1301cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
1302cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
1303cf2458c9SMatt Jacob# to them.
1304cf2458c9SMatt Jacob#
1305b2420d4dSSergey Kandaurov# The pass driver provides a passthrough API to access the CAM subsystem.
1306ebc1a0e2SPeter Dufault
1307c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
1308c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
1309c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
1310c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
1311c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
1312dc0aa406SAlexander Motindevice		ses		#Enclosure Services (SES and SAF-TE)
1313cf2458c9SMatt Jacobdevice		pt		#SCSI processor
131464ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
131564ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
1316cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
13171eba4c79SScott Longdevice		sg		#Linux SCSI passthrough
1318130f4520SKenneth D. Merrydevice		ctl		#CAM Target Layer
13198909a72bSPeter Dufault
1320700daf5eSJustin T. Gibbs# CAM OPTIONS:
1321700daf5eSJustin T. Gibbs# debugging options:
1322f0f25b9cSAlexander Motin# CAMDEBUG		Compile in all possible debugging.
1323f0f25b9cSAlexander Motin# CAM_DEBUG_COMPILE	Debug levels to compile in.
1324f0f25b9cSAlexander Motin# CAM_DEBUG_FLAGS	Debug levels to enable on boot.
1325f0f25b9cSAlexander Motin# CAM_DEBUG_BUS		Limit debugging to the given bus.
1326f0f25b9cSAlexander Motin# CAM_DEBUG_TARGET	Limit debugging to the given target.
1327f0f25b9cSAlexander Motin# CAM_DEBUG_LUN		Limit debugging to the given lun.
1328f0f25b9cSAlexander Motin# CAM_DEBUG_DELAY	Delay in us after printing each debug line.
1329700daf5eSJustin T. Gibbs#
1330700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
1331700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
1332700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
133356234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
133456234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
13353a937198SBrooks Davis#             freeze the device queue after a bus device reset.  This
13363a937198SBrooks Davis#             can be changed at boot and runtime with the
13373a937198SBrooks Davis#             kern.cam.scsi_delay tunable/sysctl.
1338700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
1339f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_COMPILE=-1
1340f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_FLAGS=(CAM_DEBUG_INFO|CAM_DEBUG_PROBE|CAM_DEBUG_PERIPH)
13415895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
13425895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
13435895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
1344f0f25b9cSAlexander Motinoptions 	CAM_DEBUG_DELAY=1
13455895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
1346700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
1347700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
134832672ba8SAndre Oppermannoptions 	SCSI_DELAY=5000	# Be pessimistic about Joe SCSI device
13491a7c583cSGarrett Wollman
1350700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
1351700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
1352700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
1353700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
1354700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
1355700daf5eSJustin T. Gibbs# respectively.
135693063432SJoerg Wunsch#
1357700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
1358700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
1359700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
136093063432SJoerg Wunsch#
13615895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
13625895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
136393063432SJoerg Wunsch
13649dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
1365b29f9e40SMatt Jacob# SA_IO_TIMEOUT: Timeout for read/write/wfm  operations, in minutes
13669dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
13679dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
13689dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
13699f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
137025388b6cSBruce Evansoptions 	SA_IO_TIMEOUT=4
137125388b6cSBruce Evansoptions 	SA_SPACE_TIMEOUT=60
137225388b6cSBruce Evansoptions 	SA_REWIND_TIMEOUT=(2*60)
137325388b6cSBruce Evansoptions 	SA_ERASE_TIMEOUT=(4*60)
13749f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
13759dfb4471SKenneth D. Merry
13763ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
13773ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
137825388b6cSBruce Evansoptions 	SCSI_PT_DEFAULT_TIMEOUT=60
13793ece1bd2SKenneth D. Merry
13808904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
13818904e70bSMatt Jacob#
13828904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
13838904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
13849c0ef6d5SOliver Fromme# a topology with the SES device that's on the box these drives are in....
13858904e70bSMatt Jacoboptions 	SES_ENABLE_PASSTHROUGH
13868904e70bSMatt Jacob
13876a8d6623SGarrett Wollman
13886a8d6623SGarrett Wollman#####################################################################
13896a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
13906a8d6623SGarrett Wollman
1391bc093719SEd Schoutendevice		pty		#BSD-style compatibility pseudo ttys
13926d823e81SJulian Elischerdevice		nmdm		#back-to-back tty devices
1393f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
1394932ef5b5SEd Schoutendevice		snp		#Snoop device - to look at pty/vty/etc..
1395efacde1bSBrooks Davisdevice		ccd		#Concatenated disk driver
13966aec1278SMax Laierdevice		firmware	#firmware(9) support
1397be174c7eSGreg Lehey
13986f2d8adbSBoris Popov# Kernel side iconv library
13996f2d8adbSBoris Popovoptions 	LIBICONV
14006f2d8adbSBoris Popov
140158067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
14025895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
140358067a99SPoul-Henning Kamp
14046a8d6623SGarrett Wollman
14056a8d6623SGarrett Wollman#####################################################################
1406d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1407d61e6649SAlexander Langer
1408d61e6649SAlexander Langer# For ISA the required hints are listed.
14095bcb64f2SWarner Losh# EISA, MCA, PCI, CardBus, SD/MMC and pccard are self identifying buses, so
14105bcb64f2SWarner Losh# no hints are needed.
1411d61e6649SAlexander Langer
1412d61e6649SAlexander Langer#
1413d61e6649SAlexander Langer# Mandatory devices:
1414d61e6649SAlexander Langer#
1415d61e6649SAlexander Langer
14166e818956SDavid E. O'Brien# These options are valid for other keyboard drivers as well.
14176e818956SDavid E. O'Brienoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
14186e818956SDavid E. O'Brienoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
14196e818956SDavid E. O'Brien
142046360281SEd Mastedevice		kbdmux			# keyboard multiplexer
142146360281SEd Masteoptions		KBDMUX_DFLT_KEYMAP	# specify the built-in keymap
142246360281SEd Mastemakeoptions	KBDMUX_DFLT_KEYMAP=it.iso
142346360281SEd Maste
14247f5092f3SJohn Baldwinoptions 	FB_DEBUG		# Frame buffer debugging
14257f5092f3SJohn Baldwin
1426837f167eSRuslan Ermilovdevice		splash			# Splash screen and screen saver support
1427837f167eSRuslan Ermilov
1428905e8b43SDag-Erling Smørgrav# Various screen savers.
1429905e8b43SDag-Erling Smørgravdevice		blank_saver
1430905e8b43SDag-Erling Smørgravdevice		daemon_saver
1431905e8b43SDag-Erling Smørgravdevice		dragon_saver
1432905e8b43SDag-Erling Smørgravdevice		fade_saver
1433905e8b43SDag-Erling Smørgravdevice		fire_saver
1434905e8b43SDag-Erling Smørgravdevice		green_saver
1435905e8b43SDag-Erling Smørgravdevice		logo_saver
1436905e8b43SDag-Erling Smørgravdevice		rain_saver
1437905e8b43SDag-Erling Smørgravdevice		snake_saver
1438905e8b43SDag-Erling Smørgravdevice		star_saver
1439905e8b43SDag-Erling Smørgravdevice		warp_saver
1440905e8b43SDag-Erling Smørgrav
14411c9c6382SRuslan Ermilov# The syscons console driver (SCO color console compatible).
1442f453022cSPeter Wemmdevice		sc
1443f71c01ccSPeter Wemmhint.sc.0.at="isa"
1444683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
14456e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
14466e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1447cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
1448e2ee2173SMarcel Moolenaaroptions 	SC_DISABLE_KDBKEY	# disable `debug' key
1449c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
14506e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
14516e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
14526e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
145385e36760SJordan K. Hubbard
14547a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
145525388b6cSBruce Evansoptions 	SC_NORM_ATTR=(FG_GREEN|BG_BLACK)
145625388b6cSBruce Evansoptions 	SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)
145725388b6cSBruce Evansoptions 	SC_KERNEL_CONS_ATTR=(FG_RED|BG_BLACK)
145825388b6cSBruce Evansoptions 	SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)
14597a88382dSKazutaka YOKOTA
1460d51e8487SJosh Paetzel# The following options will let you change the default behavior of
146178f45204SMaxim Sobolev# cut-n-paste feature
146278f45204SMaxim Sobolevoptions 	SC_CUT_SPACES2TABS	# convert leading spaces into tabs
146325388b6cSBruce Evansoptions 	SC_CUT_SEPCHARS=\"x09\"	# set of characters that delimit words
146425388b6cSBruce Evans					# (default is single space - \"x20\")
146578f45204SMaxim Sobolev
14667a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
14677a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
14687a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
14697a88382dSKazutaka YOKOTA
14706e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
14716e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
14726e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
14736e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
14746e62b069SMarius Strobloptions 	SC_NO_MODE_CHANGE
14756e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
1476c42946c4SMitsuru IWASAKIoptions 	SC_NO_SUSPEND_VTYSWITCH
14772ac8be82SAndreas Schulz
14788a28ce0eSJohn Baldwin# `flags' for sc
14798a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
14808a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
14818a28ce0eSJohn Baldwin
148283409a55SEd Schouten# Enable experimental features of the syscons terminal emulator (teken).
1483e42fc368SEd Schoutenoptions 	TEKEN_CONS25		# cons25-style terminal emulation
148483409a55SEd Schoutenoptions 	TEKEN_UTF8		# UTF-8 output handling
148583409a55SEd Schouten
1486ccbb7b5eSEd Maste# The vt video console driver.
1487ccbb7b5eSEd Mastedevice		vt
1488ccbb7b5eSEd Masteoptions		VT_ALT_TO_ESC_HACK=1	# Prepend ESC sequence to ALT keys
1489ccbb7b5eSEd Masteoptions		VT_MAXWINDOWS=16	# Number of virtual consoles
1490ccbb7b5eSEd Masteoptions		VT_TWOBUTTON_MOUSE	# Use right mouse button to paste
1491ccbb7b5eSEd Maste
1492ccbb7b5eSEd Maste# The following options set the default framebuffer size.
1493ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_HEIGHT=480
1494ccbb7b5eSEd Masteoptions		VT_FB_DEFAULT_WIDTH=640
1495ccbb7b5eSEd Maste
1496ccbb7b5eSEd Maste# The following options will let you change the default vt terminal colors.
1497ccbb7b5eSEd Masteoptions		TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)
1498ccbb7b5eSEd Masteoptions		TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)
1499ccbb7b5eSEd Maste
15001fe04850SBruce Evans#
1501d61e6649SAlexander Langer# Optional devices:
15026a8d6623SGarrett Wollman#
15036a8d6623SGarrett Wollman
15046a8d6623SGarrett Wollman#
1505d61e6649SAlexander Langer# SCSI host adapters:
15066a8d6623SGarrett Wollman#
15077f5092f3SJohn Baldwin# adv: All Narrow SCSI bus AdvanSys controllers.
1508859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
15096e818956SDavid E. O'Brien# aha: Adaptec 154x/1535/1640
15107f5092f3SJohn Baldwin# ahb: Adaptec 174x EISA controllers
1511d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1512d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
1513cdd49e97SJustin T. Gibbs# ahd: Adaptec 29320/39320 Controllers.
15147f5092f3SJohn Baldwin# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
15156e818956SDavid E. O'Brien# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
15166e818956SDavid E. O'Brien#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1517a9ab459bSMarius Strobl# esp: Emulex ESP, NCR 53C9x and QLogic FAS families based controllers
1518a9ab459bSMarius Strobl#      including the AMD Am53C974 (found on devices such as the Tekram
1519a9ab459bSMarius Strobl#      DC-390(T)) and the Sun ESP and FAS families of controllers
1520d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1521d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1522d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1523e8a0f829SMatt Jacob#      Qlogic ISP 2100 and ISP 2200 1Gb Fibre Channel host adapters.
1524e8a0f829SMatt Jacob#      Qlogic ISP 2300 and ISP 2312 2Gb Fibre Channel host adapters.
1525af606348SMatt Jacob#      Qlogic ISP 2322 and ISP 6322 2Gb Fibre Channel host adapters.
1526ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
152764fa5108SMatt Jacob# mpt: LSI-Logic MPT/Fusion 53c1020 or 53c1030 Ultra4
152864fa5108SMatt Jacob#      or FC9x9 Fibre Channel host adapters.
1529d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1530fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1531fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1532fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1533fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1534f3d92b26SOlivier Houchard# trm: Tekram DC395U/UW/F DC315U adapters.
15356e818956SDavid E. O'Brien# wds: WD7000
1536d61e6649SAlexander Langer
15376e818956SDavid E. O'Brien#
15386e818956SDavid E. O'Brien# Note that the order is important in order for Buslogic ISA/EISA cards to be
15396e818956SDavid E. O'Brien# probed correctly.
15406e818956SDavid E. O'Brien#
15416e818956SDavid E. O'Briendevice		bt
15426e818956SDavid E. O'Brienhint.bt.0.at="isa"
15436e818956SDavid E. O'Brienhint.bt.0.port="0x330"
15447f5092f3SJohn Baldwindevice		adv
15457f5092f3SJohn Baldwinhint.adv.0.at="isa"
1546c9953c3bSPeter Wemmdevice		adw
15476e818956SDavid E. O'Briendevice		aha
15486e818956SDavid E. O'Brienhint.aha.0.at="isa"
15497f5092f3SJohn Baldwindevice		aic
15507f5092f3SJohn Baldwinhint.aic.0.at="isa"
15517f5092f3SJohn Baldwindevice		ahb
1552d61e6649SAlexander Langerdevice		ahc
1553cdd49e97SJustin T. Gibbsdevice		ahd
15541b946e21SScott Longdevice		esp
1555c5933b20SScott Longdevice		iscsi_initiator
1556d61e6649SAlexander Langerdevice		isp
15570787f2b8SMatt Jacobhint.isp.0.disable="1"
15580787f2b8SMatt Jacobhint.isp.0.role="3"
15590787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
15600787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
15610787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
15620787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
15630787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
15640787f2b8SMatt Jacobhint.isp.0.topology="lport"
15650787f2b8SMatt Jacobhint.isp.0.topology="nport"
15660787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
15670787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
15680787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
15690787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
15700787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
15710787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1572d61e6649SAlexander Langerdevice		ispfw
157364fa5108SMatt Jacobdevice		mpt
1574d61e6649SAlexander Langerdevice		ncr
1575d61e6649SAlexander Langerdevice		sym
1576f3d92b26SOlivier Houcharddevice		trm
15776e818956SDavid E. O'Briendevice		wds
15786e818956SDavid E. O'Brienhint.wds.0.at="isa"
15796e818956SDavid E. O'Brienhint.wds.0.port="0x350"
15806e818956SDavid E. O'Brienhint.wds.0.irq="11"
15816e818956SDavid E. O'Brienhint.wds.0.drq="6"
1582d61e6649SAlexander Langer
1583d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1584d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1585d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1586d61e6649SAlexander Langer# default.
1587d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1588d61e6649SAlexander Langer
1589fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1590fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1591fac70739SJeroen Ruigrok van der Werven
1592fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1593fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1594fac70739SJeroen Ruigrok van der Werven
1595662d3818SScott Long# Compile in Aic7xxx Debugging code.
1596662d3818SScott Longoptions 	AHC_DEBUG
1597662d3818SScott Long
1598662d3818SScott Long# Aic7xxx driver debugging options. See sys/dev/aic7xxx/aic7xxx.h
1599662d3818SScott Longoptions 	AHC_DEBUG_OPTS
1600662d3818SScott Long
1601f8f8803bSBruce Evans# Print register bitfields in debug output.  Adds ~128k to driver
1602f8f8803bSBruce Evans# See ahc(4).
1603662d3818SScott Longoptions 	AHC_REG_PRETTY_PRINT
1604662d3818SScott Long
1605cdd49e97SJustin T. Gibbs# Compile in aic79xx debugging code.
1606cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG
1607cdd49e97SJustin T. Gibbs
1608f8f8803bSBruce Evans# Aic79xx driver debugging options.  Adds ~215k to driver.  See ahd(4).
1609cdd49e97SJustin T. Gibbsoptions 	AHD_DEBUG_OPTS=0xFFFFFFFF
1610cdd49e97SJustin T. Gibbs
161143e9d8a3SScott Long# Print human-readable register definitions when debugging
161243e9d8a3SScott Longoptions 	AHD_REG_PRETTY_PRINT
161343e9d8a3SScott Long
1614662d3818SScott Long# Bitmap of units to enable targetmode operations.
1615662d3818SScott Longoptions 	AHD_TMODE_ENABLE
1616662d3818SScott Long
1617d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1618d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1619d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1620d61e6649SAlexander Langer
1621c5933b20SScott Long# Options used in dev/iscsi (Software iSCSI stack)
1622c5933b20SScott Long#
1623c5933b20SScott Longoptions 	ISCSI_INITIATOR_DEBUG=9
1624c5933b20SScott Long
1625d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1626d61e6649SAlexander Langer#
1627d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1628d61e6649SAlexander Langer#
162964fa5108SMatt Jacoboptions 	ISP_TARGET_MODE=1
1630af606348SMatt Jacob#
16319a1b0d43SMatt Jacob#	ISP_DEFAULT_ROLES	-	default role
16329a1b0d43SMatt Jacob#		none=0
16339a1b0d43SMatt Jacob#		target=1
16349a1b0d43SMatt Jacob#		initiator=2
16359a1b0d43SMatt Jacob#		both=3			(not supported currently)
1636af606348SMatt Jacob#
163715f0f952SMatt Jacob#	ISP_INTERNAL_TARGET		(trivial internal disk target, for testing)
163815f0f952SMatt Jacob#
1639e2873b76SMatt Jacoboptions 	ISP_DEFAULT_ROLES=0
1640d61e6649SAlexander Langer
1641d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1642d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1643d61e6649SAlexander Langer					# Allows the ncr to take precedence
1644d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1645d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1646d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1647d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1648d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1649d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1650d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1651d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1652d61e6649SAlexander Langer					# default:8, range:[1..64]
16536a8d6623SGarrett Wollman
16546e818956SDavid E. O'Brien# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
16556e818956SDavid E. O'Brien# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
16566e818956SDavid E. O'Brien# The DPT controllers are commonly re-licensed under other brand-names -
16576e818956SDavid E. O'Brien# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
16586e818956SDavid E. O'Brien# Compaq are actually DPT controllers.
16596e818956SDavid E. O'Brien#
16606e818956SDavid E. O'Brien# See src/sys/dev/dpt for debugging and other subtle options.
16616e818956SDavid E. O'Brien#  DPT_MEASURE_PERFORMANCE  Enables a set of (semi)invasive metrics. Various
16626e818956SDavid E. O'Brien#                           instruments are enabled.  The tools in
16636e818956SDavid E. O'Brien#                           /usr/sbin/dpt_* assume these to be enabled.
16646e818956SDavid E. O'Brien#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
16656e818956SDavid E. O'Brien#  DPT_RESET_HBA            Make "reset" actually reset the controller
16666e818956SDavid E. O'Brien#                           instead of fudging it.  Only enable this if you
16676e818956SDavid E. O'Brien#			    are 100% certain you need it.
16686e818956SDavid E. O'Brien
16696e818956SDavid E. O'Briendevice		dpt
16706e818956SDavid E. O'Brien
16716e818956SDavid E. O'Brien# DPT options
16726e818956SDavid E. O'Brien#!CAM# options 	DPT_MEASURE_PERFORMANCE
16736e818956SDavid E. O'Brienoptions 	DPT_RESET_HBA
16746e818956SDavid E. O'Brien
16756e818956SDavid E. O'Brien#
16766e818956SDavid E. O'Brien# Compaq "CISS" RAID controllers (SmartRAID 5* series)
16776e818956SDavid E. O'Brien# These controllers have a SCSI-like interface, and require the
16786e818956SDavid E. O'Brien# CAM infrastructure.
16796e818956SDavid E. O'Brien#
16806e818956SDavid E. O'Briendevice		ciss
16816e818956SDavid E. O'Brien
16826e818956SDavid E. O'Brien#
16836e818956SDavid E. O'Brien# Intel Integrated RAID controllers.
16846e818956SDavid E. O'Brien# This driver was developed and is maintained by Intel.  Contacts
16856e818956SDavid E. O'Brien# at Intel for this driver are
16866e818956SDavid E. O'Brien# "Kannanthanam, Boji T" <boji.t.kannanthanam@intel.com> and
16876e818956SDavid E. O'Brien# "Leubner, Achim" <achim.leubner@intel.com>.
16886e818956SDavid E. O'Brien#
16896e818956SDavid E. O'Briendevice		iir
16906e818956SDavid E. O'Brien
16916e818956SDavid E. O'Brien#
16926e818956SDavid E. O'Brien# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
16936e818956SDavid E. O'Brien# firmware.  These controllers have a SCSI-like interface, and require
16946e818956SDavid E. O'Brien# the CAM infrastructure.
16956e818956SDavid E. O'Brien#
16966e818956SDavid E. O'Briendevice		mly
16976e818956SDavid E. O'Brien
16986e818956SDavid E. O'Brien#
16996e818956SDavid E. O'Brien# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
17006e818956SDavid E. O'Brien# one entry is needed; the code will find and configure all supported
17016e818956SDavid E. O'Brien# controllers.
17026e818956SDavid E. O'Brien#
17036e818956SDavid E. O'Briendevice		ida		# Compaq Smart RAID
17046e818956SDavid E. O'Briendevice		mlx		# Mylex DAC960
17056e818956SDavid E. O'Briendevice		amr		# AMI MegaRAID
170664c71632SScott Longdevice		amrp		# SCSI Passthrough interface (optional, CAM req.)
17077f631a41SScott Longdevice		mfi		# LSI MegaRAID SAS
1708f366931cSScott Longdevice		mfip		# LSI MegaRAID SAS passthrough, requires CAM
17096b31d3f7SScott Longoptions 	MFI_DEBUG
1710a58b4afaSMark Johnstondevice		mrsas		# LSI/Avago MegaRAID SAS/SATA, 6Gb/s and 12Gb/s
17116e818956SDavid E. O'Brien
17126e818956SDavid E. O'Brien#
17136e818956SDavid E. O'Brien# 3ware ATA RAID
17146e818956SDavid E. O'Brien#
17156e818956SDavid E. O'Briendevice		twe		# 3ware ATA RAID
17166e818956SDavid E. O'Brien
171790d3341eSPeter Wemm#
1718e19ef875SAlexander Motin# Serial ATA host controllers:
1719e19ef875SAlexander Motin#
1720e19ef875SAlexander Motin# ahci: Advanced Host Controller Interface (AHCI) compatible
1721dd48af36SAlexander Motin# mvs:  Marvell 88SX50XX/88SX60XX/88SX70XX/SoC controllers
1722e19ef875SAlexander Motin# siis: SiliconImage SiI3124/SiI3132/SiI3531 controllers
17231a00526bSAlexander Motin#
17241a00526bSAlexander Motin# These drivers are part of cam(4) subsystem. They supersede less featured
17251a00526bSAlexander Motin# ata(4) subsystem drivers, supporting same hardware.
1726e19ef875SAlexander Motin
1727e19ef875SAlexander Motindevice		ahci
1728dd48af36SAlexander Motindevice		mvs
1729e19ef875SAlexander Motindevice		siis
1730e19ef875SAlexander Motin
1731e19ef875SAlexander Motin#
173245f6d665SAlexander Motin# The 'ATA' driver supports all legacy ATA/ATAPI controllers, including
173345f6d665SAlexander Motin# PC Card devices. You only need one "device ata" for it to find all
17346d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1735c4bda3c6SAlexander Motin# Alternatively, individual bus and chipset drivers may be chosen by using
1736c4bda3c6SAlexander Motin# the 'atacore' driver then selecting the drivers on a per vendor basis.
1737c4bda3c6SAlexander Motin# For example to build a system which only supports a VIA chipset,
1738c4bda3c6SAlexander Motin# omit 'ata' and include the 'atacore', 'atapci' and 'atavia' drivers.
1739c9953c3bSPeter Wemmdevice		ata
1740c4bda3c6SAlexander Motin
1741c4bda3c6SAlexander Motin# Modular ATA
1742c4bda3c6SAlexander Motin#device		atacore		# Core ATA functionality
1743c4bda3c6SAlexander Motin#device		atacard		# CARDBUS support
1744c4bda3c6SAlexander Motin#device		atabus		# PC98 cbus support
1745c4bda3c6SAlexander Motin#device		ataisa		# ISA bus support
1746c4bda3c6SAlexander Motin#device		atapci		# PCI bus support; only generic chipset support
1747c4bda3c6SAlexander Motin
1748c4bda3c6SAlexander Motin# PCI ATA chipsets
1749c4bda3c6SAlexander Motin#device		ataacard	# ACARD
1750c4bda3c6SAlexander Motin#device		ataacerlabs	# Acer Labs Inc. (ALI)
1751c4bda3c6SAlexander Motin#device		ataamd		# American Micro Devices (AMD)
1752c4bda3c6SAlexander Motin#device		ataati		# ATI
1753c4bda3c6SAlexander Motin#device		atacenatek	# Cenatek
1754c4bda3c6SAlexander Motin#device		atacypress	# Cypress
1755c4bda3c6SAlexander Motin#device		atacyrix	# Cyrix
1756c4bda3c6SAlexander Motin#device		atahighpoint	# HighPoint
1757c4bda3c6SAlexander Motin#device		ataintel	# Intel
1758c4bda3c6SAlexander Motin#device		ataite		# Integrated Technology Inc. (ITE)
1759c4bda3c6SAlexander Motin#device		atajmicron	# JMicron
1760c4bda3c6SAlexander Motin#device		atamarvell	# Marvell
1761c4bda3c6SAlexander Motin#device		atamicron	# Micron
1762c4bda3c6SAlexander Motin#device		atanational	# National
1763c4bda3c6SAlexander Motin#device		atanetcell	# NetCell
1764c4bda3c6SAlexander Motin#device		atanvidia	# nVidia
1765c4bda3c6SAlexander Motin#device		atapromise	# Promise
1766c4bda3c6SAlexander Motin#device		ataserverworks	# ServerWorks
1767c4bda3c6SAlexander Motin#device		atasiliconimage	# Silicon Image Inc. (SiI) (formerly CMD)
1768c4bda3c6SAlexander Motin#device		atasis		# Silicon Integrated Systems Corp.(SiS)
1769c4bda3c6SAlexander Motin#device		atavia		# VIA Technologies Inc.
1770c4bda3c6SAlexander Motin
17718b89ef0aSSøren Schmidt#
17726d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
17736d04301dSAlexander Langerhint.ata.0.at="isa"
17746d04301dSAlexander Langerhint.ata.0.port="0x1f0"
17756d04301dSAlexander Langerhint.ata.0.irq="14"
17766d04301dSAlexander Langerhint.ata.1.at="isa"
17776d04301dSAlexander Langerhint.ata.1.port="0x170"
17786d04301dSAlexander Langerhint.ata.1.irq="15"
17796d04301dSAlexander Langer
17806d04301dSAlexander Langer#
1781000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1782000da71aSSøren Schmidt#
17836fb5300bSAlexander Motin# ATA_REQUEST_TIMEOUT:	the number of seconds to wait for an ATA request
17846fb5300bSAlexander Motin#			before timing out.
178574d8e840SSøren Schmidt
17866fb5300bSAlexander Motin#options 	ATA_REQUEST_TIMEOUT=10
178774d8e840SSøren Schmidt
17888b89ef0aSSøren Schmidt#
17896d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
17906d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
17916a8d6623SGarrett Wollman#
1792f71c01ccSPeter Wemmdevice		fdc
1793f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1794f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1795f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1796f71c01ccSPeter Wemmhint.fdc.0.drq="2"
179785827d9cSJoerg Wunsch#
1798d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1799d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1800d2fb4892SJoerg Wunsch# however.
1801d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1802d2fb4892SJoerg Wunsch#
1803f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1804f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1805f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1806f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
180785827d9cSJoerg Wunsch
1808f71c01ccSPeter Wemm# Specify floppy devices
1809f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1810f71c01ccSPeter Wemmhint.fd.0.drive="0"
1811f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1812f71c01ccSPeter Wemmhint.fd.1.drive="1"
181385827d9cSJoerg Wunsch
18146a8d6623SGarrett Wollman#
1815501ef98fSMarcel Moolenaar# uart: newbusified driver for serial interfaces.  It consolidates the sio(4),
1816501ef98fSMarcel Moolenaar#	sab(4) and zs(4) drivers.
1817c8956b36SMarcel Moolenaar#
1818501ef98fSMarcel Moolenaardevice		uart
1819501ef98fSMarcel Moolenaar
18208194412bSMarcel Moolenaar# Options for uart(4)
18218194412bSMarcel Moolenaaroptions 	UART_PPS_ON_CTS		# Do time pulse capturing using CTS
18228194412bSMarcel Moolenaar					# instead of DCD.
18231662b008SIan Leporeoptions 	UART_POLL_FREQ		# Set polling rate, used when hw has
18241662b008SIan Lepore					# no interrupt support (50 Hz default).
18258194412bSMarcel Moolenaar
1826501ef98fSMarcel Moolenaar# The following hint should only be used for pure ISA devices.  It is not
1827501ef98fSMarcel Moolenaar# needed otherwise.  Use of hints is strongly discouraged.
1828501ef98fSMarcel Moolenaarhint.uart.0.at="isa"
1829501ef98fSMarcel Moolenaar
1830c8956b36SMarcel Moolenaar# The following 3 hints are used when the UART is a system device (i.e., a
1831c8956b36SMarcel Moolenaar# console or debug port), but only on platforms that don't have any other
1832c8956b36SMarcel Moolenaar# means to pass the information to the kernel.  The unit number of the hint
1833c8956b36SMarcel Moolenaar# is only used to bundle the hints together.  There is no relation to the
1834c8956b36SMarcel Moolenaar# unit number of the probed UART.
1835501ef98fSMarcel Moolenaarhint.uart.0.port="0x3f8"
1836501ef98fSMarcel Moolenaarhint.uart.0.flags="0x10"
1837501ef98fSMarcel Moolenaarhint.uart.0.baud="115200"
1838501ef98fSMarcel Moolenaar
1839501ef98fSMarcel Moolenaar# `flags' for serial drivers that support consoles like sio(4) and uart(4):
1840c8956b36SMarcel Moolenaar#	0x10	enable console support for this unit.  Other console flags
1841c8956b36SMarcel Moolenaar#		(if applicable) are ignored unless this is set.  Enabling
1842c8956b36SMarcel Moolenaar#		console support does not make the unit the preferred console.
1843c8956b36SMarcel Moolenaar#		Boot with -h or set boot_serial=YES in the loader.  For sio(4)
1844c8956b36SMarcel Moolenaar#		specifically, the 0x20 flag can also be set (see above).
1845c8956b36SMarcel Moolenaar#		Currently, at most one unit can have console support; the
1846c8956b36SMarcel Moolenaar#		first one (in config file order) with this flag set is
1847d51e8487SJosh Paetzel#		preferred.  Setting this flag for sio0 gives the old behavior.
1848c8956b36SMarcel Moolenaar#	0x80	use this port for serial line gdb support in ddb.  Also known
1849c8956b36SMarcel Moolenaar#		as debug port.
18509546766aSBruce Evans#
18519546766aSBruce Evans
1852501ef98fSMarcel Moolenaar# Options for serial drivers that support consoles:
185391ed2fecSJohn-Mark Gurneyoptions 	BREAK_TO_DEBUGGER	# A BREAK/DBG on the console goes to
1854c8956b36SMarcel Moolenaar					# ddb, if available.
18556a8d6623SGarrett Wollman
185626b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
185726b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
18589c0ef6d5SOliver Fromme# Sun servers by the Remote Console.  There are FreeBSD extensions:
1859c7b3d8e2SMaxim Konovalov# CR ~ ^p requests force panic and CR ~ ^r requests a clean reboot.
186026b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
186126b6ea69SPaul Saab
1862af2e25a6SMarcel Moolenaar# Serial Communications Controller
1863af2e25a6SMarcel Moolenaar# Supports the Siemens SAB 82532 and Zilog Z8530 multi-channel
1864af2e25a6SMarcel Moolenaar# communications controllers.
1865af2e25a6SMarcel Moolenaardevice		scc
1866af2e25a6SMarcel Moolenaar
18679c564b6cSJohn Hay# PCI Universal Communications driver
186864220a7eSMarcel Moolenaar# Supports various multi port PCI I/O cards.
18699c564b6cSJohn Haydevice		puc
18709c564b6cSJohn Hay
18716a8d6623SGarrett Wollman#
1872d61e6649SAlexander Langer# Network interfaces:
18736a8d6623SGarrett Wollman#
1874dfd77572SJohn Baldwin# MII bus support is required for many PCI Ethernet NICs,
1875d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
18763c7c6c12SMike Pritchard# transceiver control interfaces that operate like an MII.  Adding
18778c1093fcSMarius Strobl# "device miibus" to the kernel config pulls in support for the generic
18788c1093fcSMarius Strobl# miibus API, the common support for for bit-bang'ing the MII and all
18798c1093fcSMarius Strobl# of the PHY drivers, including a generic one for PHYs that aren't
18808c1093fcSMarius Strobl# specifically handled by an individual driver.  Support for specific
18818c1093fcSMarius Strobl# PHYs may be built by adding "device mii", "device mii_bitbang" if
18828c1093fcSMarius Strobl# needed by the NIC driver and then adding the appropriate PHY driver.
1883dfd77572SJohn Baldwindevice  	mii		# Minimal MII support
18848c1093fcSMarius Strobldevice  	mii_bitbang	# Common module for bit-bang'ing the MII
18858c1093fcSMarius Strobldevice  	miibus		# MII support w/ bit-bang'ing and all PHYs
1886dfd77572SJohn Baldwin
1887dfd77572SJohn Baldwindevice  	acphy		# Altima Communications AC101
1888dfd77572SJohn Baldwindevice  	amphy		# AMD AM79c873 / Davicom DM910{1,2}
1889dfd77572SJohn Baldwindevice  	atphy		# Attansic/Atheros F1
1890dfd77572SJohn Baldwindevice  	axphy		# Asix Semiconductor AX88x9x
1891dfd77572SJohn Baldwindevice  	bmtphy		# Broadcom BCM5201/BCM5202 and 3Com 3c905C
1892dfd77572SJohn Baldwindevice  	brgphy		# Broadcom BCM54xx/57xx 1000baseTX
1893dfd77572SJohn Baldwindevice  	ciphy		# Cicada/Vitesse CS/VSC8xxx
1894dfd77572SJohn Baldwindevice  	e1000phy	# Marvell 88E1000 1000/100/10-BT
1895dfd77572SJohn Baldwindevice  	gentbi		# Generic 10-bit 1000BASE-{LX,SX} fiber ifaces
1896dfd77572SJohn Baldwindevice  	icsphy		# ICS ICS1889-1893
1897dfd77572SJohn Baldwindevice  	ip1000phy	# IC Plus IP1000A/IP1001
1898dfd77572SJohn Baldwindevice  	jmphy		# JMicron JMP211/JMP202
1899dfd77572SJohn Baldwindevice  	lxtphy		# Level One LXT-970
1900dfd77572SJohn Baldwindevice  	mlphy		# Micro Linear 6692
1901dfd77572SJohn Baldwindevice  	nsgphy		# NatSemi DP8361/DP83865/DP83891
1902dfd77572SJohn Baldwindevice  	nsphy		# NatSemi DP83840A
1903dfd77572SJohn Baldwindevice  	nsphyter	# NatSemi DP83843/DP83815
1904dfd77572SJohn Baldwindevice  	pnaphy		# HomePNA
1905dfd77572SJohn Baldwindevice  	qsphy		# Quality Semiconductor QS6612
1906e6713fe5SPyun YongHyeondevice  	rdcphy		# RDC Semiconductor R6040
1907dfd77572SJohn Baldwindevice  	rgephy		# RealTek 8169S/8110S/8211B/8211C
1908dfd77572SJohn Baldwindevice  	rlphy		# RealTek 8139
1909dfd77572SJohn Baldwindevice  	rlswitch	# RealTek 8305
1910dfd77572SJohn Baldwindevice  	smcphy		# SMSC LAN91C111
1911dfd77572SJohn Baldwindevice  	tdkphy		# TDK 89Q2120
1912dfd77572SJohn Baldwindevice  	tlphy		# Texas Instruments ThunderLAN
1913dfd77572SJohn Baldwindevice  	truephy		# LSI TruePHY
1914dfd77572SJohn Baldwindevice		xmphy		# XaQti XMAC II
1915d61e6649SAlexander Langer
19167f5092f3SJohn Baldwin# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
19177f5092f3SJohn Baldwin#       PCI and ISA varieties.
1918ba26d470SStanislav Sedov# ae:   Support for gigabit ethernet adapters based on the Attansic/Atheros
1919ba26d470SStanislav Sedov#       L2 PCI-Express FastEthernet controllers.
1920cfef026aSPyun YongHyeon# age:  Support for gigabit ethernet adapters based on the Attansic/Atheros
1921cfef026aSPyun YongHyeon#       L1 PCI express gigabit ethernet controllers.
1922d68875ebSPyun YongHyeon# alc:  Support for Atheros AR8131/AR8132 PCIe ethernet controllers.
19233c6e15bcSPyun YongHyeon# ale:  Support for Atheros AR8121/AR8113/AR8114 PCIe ethernet controllers.
1924390cee87SJohn Baldwin# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
1925343ed0a8SJohn Baldwin# bce:	Broadcom NetXtreme II (BCM5706/BCM5708) PCI/PCIe Gigabit Ethernet
1926343ed0a8SJohn Baldwin#       adapters.
1927343ed0a8SJohn Baldwin# bfe:	Broadcom BCM4401 Ethernet adapter.
192895d67482SBill Paul# bge:	Support for gigabit ethernet adapters based on the Broadcom
1929586d7c2eSJohn Polstra#	BCM570x family of controllers, including the 3Com 3c996-T,
1930586d7c2eSJohn Polstra#	the Netgear GA302T, the SysKonnect SK-9D21 and SK-9D41, and
1931586d7c2eSJohn Polstra#	the embedded gigE NICs on Dell PowerEdge 2550 servers.
19324e400768SDavid Christensen# bxe:	Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
1933dd46ab31SDavid Christensen#       adapters.
19343132ad0dSWarner Losh# bwi:	Broadcom BCM430* and BCM431* family of wireless adapters.
1935eb5ef23cSWeongyo Jeong# bwn:	Broadcom BCM43xx family of wireless adapters.
1936119051cbSMarius Strobl# cas:	Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
19377f5092f3SJohn Baldwin# cm:	Arcnet SMC COM90c26 / SMC COM90c56
19387f5092f3SJohn Baldwin#	(and SMC COM90c66 in '56 compatibility mode) adapters.
1939ca7fe84aSNavdeep Parhar# cxgb: Chelsio T3 based 1GbE/10GbE PCIe Ethernet adapters.
1940ca7fe84aSNavdeep Parhar# cxgbe:Chelsio T4 and T5 based 1GbE/10GbE/40GbE PCIe Ethernet adapters.
1941d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1942d61e6649SAlexander Langer#       and various workalikes including:
1943d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1944d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1945d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1946d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1947d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1948d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1949d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1950d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1951d61e6649SAlexander Langer#       KNE110TX.
1952d61e6649SAlexander Langer# de:   Digital Equipment DC21040
1953a59716d2SPrafulla Deuskar# em:   Intel Pro/1000 Gigabit Ethernet 82542, 82543, 82544 based adapters.
195496a761ecSJack F Vogel# igb:  Intel Pro/1000 PCI Express Gigabit Ethernet: 82575 and later adapters.
19557f5092f3SJohn Baldwin# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
19567f5092f3SJohn Baldwin#       and PC Card devices using these chipsets.
19577f5092f3SJohn Baldwin# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
19587f5092f3SJohn Baldwin#       Olicom Ethernet PC Card devices.
19597f5092f3SJohn Baldwin# fe:   Fujitsu MB86960A/MB86965A Ethernet
19607f5092f3SJohn Baldwin# fea:  DEC DEFEA EISA FDDI adapter
1961d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1962d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1963cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
19641ed3fed7SMarius Strobl# gem:  Apple GMAC/Sun ERI/Sun GEM
196552c07e1cSMarius Strobl# hme:  Sun HME (Happy Meal Ethernet)
196675a1bf5fSPyun YongHyeon# jme:  JMicron JMC260 Fast Ethernet/JMC250 Gigabit Ethernet based adapters.
196744ac0964SMarius Strobl# le:   AMD Am7900 LANCE and Am79C9xx PCnet
1968c678bc4fSBill Paul# lge:	Support for PCI gigabit ethernet adapters based on the Level 1
1969c678bc4fSBill Paul#	LXT1001 NetCellerator chipset. This includes the D-Link DGE-500SX,
1970c678bc4fSBill Paul#	SMC TigerCard 1000 (SMC9462SX), and some Addtron cards.
1971d1f25d5dSBernhard Schmidt# malo: Marvell Libertas wireless NICs.
1972d1f25d5dSBernhard Schmidt# mwl:  Marvell 88W8363 802.11n wireless NICs.
1973778eefa4SJohn Baldwin#	Requires the mwl firmware module
1974778eefa4SJohn Baldwin# mwlfw: Marvell 88W8363 firmware
1975c9d21ce9SPyun YongHyeon# msk:	Support for gigabit ethernet adapters based on the Marvell/SysKonnect
1976c9d21ce9SPyun YongHyeon#	Yukon II Gigabit controllers, including 88E8021, 88E8022, 88E8061,
1977c9d21ce9SPyun YongHyeon#	88E8062, 88E8035, 88E8036, 88E8038, 88E8050, 88E8052, 88E8053,
1978c9d21ce9SPyun YongHyeon#	88E8055, 88E8056 and D-Link 560T/550SX.
19792bc6081cSScott Long# lmc:	Support for the LMC/SBE wide-area network interface cards.
198022f2c49aSHans Petter Selasky# mlx5:	Mellanox ConnectX-4 and ConnectX-4 LX IB and Eth shared code module.
198122f2c49aSHans Petter Selasky# mlx5en:Mellanox ConnectX-4 and ConnectX-4 LX PCIe Ethernet adapters.
1982d3d67116SMaxim Sobolev# my:	Myson Fast Ethernet (MTD80X, MTD89X)
1983ce4946daSBill Paul# nge:	Support for PCI gigabit ethernet adapters based on the National
1984ce4946daSBill Paul#	Semiconductor DP83820 and DP83821 chipset. This includes the
1985ce4946daSBill Paul#	SMC EZ Card 1000 (SMC9462TX), D-Link DGE-500T, Asante FriendlyNet
1986cc2824b8SBjoern A. Zeeb#	GigaNIX 1000TA and 1000TPC, the Addtron AEG320T, the Surecom
1987cc2824b8SBjoern A. Zeeb#	EP-320G-TX and the Netgear GA622T.
19882f345d8eSLuigi Rizzo# oce:	Emulex 10 Gbit adapters (OneConnect Ethernet)
198941f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
19900fd7564eSMarius Strobl#	PCnet-FAST, PCnet-FAST+, PCnet-FAST III, PCnet-PRO and PCnet-Home
19910fd7564eSMarius Strobl#	chipsets. These can also be handled by the le(4) driver if the
19920fd7564eSMarius Strobl#	pcn(4) driver is left out of the kernel. The le(4) driver does not
19930fd7564eSMarius Strobl#	support the additional features like the MII bus and burst mode of
19940fd7564eSMarius Strobl#	the PCnet-FAST and greater chipsets though.
1995390cee87SJohn Baldwin# ral:	Ralink Technology IEEE 802.11 wireless adapter
19960587cad8SPyun YongHyeon# re:   RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter
1997d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1998d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1999d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
2000d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
2001d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
2002d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
2003d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
2004d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
2005d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
2006d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
2007d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
2008d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
2009d61e6649SAlexander Langer#       card which is 32-bit.
2010d193ed0bSPyun YongHyeon# sge:  Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet adapter
2011b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
2012b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
2013d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
2014d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
2015d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
2016d61e6649SAlexander Langer#       (also single mode and multimode).
2017d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
2018d61e6649SAlexander Langer#       attach each one as a separate network interface.
20197f5092f3SJohn Baldwin# sn:   Support for ISA and PC Card Ethernet devices using the
20207f5092f3SJohn Baldwin#       SMC91C90/92/94/95 chips.
2021d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
2022d61e6649SAlexander Langer#       the D-Link DFE-550TX.
2023d497bdf1SPyun YongHyeon# stge: Support for gigabit ethernet adapters based on the Sundance/Tamarack
2024d497bdf1SPyun YongHyeon#       TC9021 family of controllers, including the Sundance ST2021/ST2023,
2025d497bdf1SPyun YongHyeon#       the Sundance/Tamarack TC9021, the D-Link DL-4000 and ASUS NX1101.
2026d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
2027d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
2028c86eb67fSDmitry Morozovsky#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
2029c86eb67fSDmitry Morozovsky#       probably want to bump up kern.ipc.nmbclusters a lot to use this driver.
2030d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
2031d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
2032d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
2033d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
2034d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
20353c7c6c12SMike Pritchard# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II series)
2036362c5c1eSBill Paul# txp:	Support for 3Com 3cR990 cards with the "Typhoon" chipset
2037d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
2038d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
2039e83bcc01SGavin Atkinson#       including the D-Link DFE520TX and D-Link DFE530TX (see 'rl' for
2040e83bcc01SGavin Atkinson#       DFE530TX+), the Hawking Technologies PN102TX, and the AOpen/Acer ALN-320.
20412608aefcSPyun YongHyeon# vte:  DM&P Vortex86 RDC R6040 Fast Ethernet
2042d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
2043d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
2044d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
2045d61e6649SAlexander Langer#       NE2000 clone.
20467f5092f3SJohn Baldwin# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
20477f5092f3SJohn Baldwin#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
20487f5092f3SJohn Baldwin#       bridge with a PCMCIA adapter plugged into it.
20497f5092f3SJohn Baldwin# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
20507f5092f3SJohn Baldwin#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
20517f5092f3SJohn Baldwin#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
2052d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
2053d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
2054d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
2055d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
2056d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
2057d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
2058d61e6649SAlexander Langer
20597f5092f3SJohn Baldwin# Order for ISA/EISA devices is important here
20607f5092f3SJohn Baldwin
20617f5092f3SJohn Baldwindevice		cm
20627f5092f3SJohn Baldwinhint.cm.0.at="isa"
20637f5092f3SJohn Baldwinhint.cm.0.port="0x2e0"
20647f5092f3SJohn Baldwinhint.cm.0.irq="9"
20657f5092f3SJohn Baldwinhint.cm.0.maddr="0xdc000"
20667f5092f3SJohn Baldwindevice		ep
20677f5092f3SJohn Baldwindevice		ex
2068c06a3350SPeter Wemmdevice		fe
20697f5092f3SJohn Baldwinhint.fe.0.at="isa"
20707f5092f3SJohn Baldwinhint.fe.0.port="0x300"
20717f5092f3SJohn Baldwindevice		fea
20727f5092f3SJohn Baldwindevice		sn
20737f5092f3SJohn Baldwinhint.sn.0.at="isa"
20747f5092f3SJohn Baldwinhint.sn.0.port="0x300"
20757f5092f3SJohn Baldwinhint.sn.0.irq="10"
20767f5092f3SJohn Baldwindevice		an
20777f5092f3SJohn Baldwindevice		wi
20787f5092f3SJohn Baldwindevice		xe
20797f5092f3SJohn Baldwin
2080d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
2081ba26d470SStanislav Sedovdevice		ae		# Attansic/Atheros L2 FastEthernet
2082cfef026aSPyun YongHyeondevice		age		# Attansic/Atheros L1 Gigabit Ethernet
2083d68875ebSPyun YongHyeondevice		alc		# Atheros AR8131/AR8132 Ethernet
20843c6e15bcSPyun YongHyeondevice		ale		# Atheros AR8121/AR8113/AR8114 Ethernet
2085343ed0a8SJohn Baldwindevice		bce		# Broadcom BCM5706/BCM5708 Gigabit Ethernet
2086343ed0a8SJohn Baldwindevice		bfe		# Broadcom BCM440x 10/100 Ethernet
2087343ed0a8SJohn Baldwindevice		bge		# Broadcom BCM570xx Gigabit Ethernet
2088119051cbSMarius Strobldevice		cas		# Sun Cassini/Cassini+ and NS DP83065 Saturn
20898090c9f5SKip Macydevice		cxgb		# Chelsio T3 10 Gigabit Ethernet
2090404825a7SKip Macydevice		cxgb_t3fw	# Chelsio T3 10 Gigabit Ethernet firmware
2091ca7fe84aSNavdeep Parhardevice		cxgbe		# Chelsio T4 and T5 1GbE/10GbE/40GbE
2092d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
20934d52a575SXin LIdevice		et		# Agere ET1310 10/100/Gigabit Ethernet
20944664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
20954664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
20961ed3fed7SMarius Strobldevice		gem		# Apple GMAC/Sun ERI/Sun GEM
209752c07e1cSMarius Strobldevice		hme		# Sun HME (Happy Meal Ethernet)
20980587cad8SPyun YongHyeondevice		jme		# JMicron JMC250 Gigabit/JMC260 Fast Ethernet
2099343ed0a8SJohn Baldwindevice		lge		# Level 1 LXT1001 gigabit Ethernet
210022f2c49aSHans Petter Selaskydevice		mlx5		# Shared code module between IB and Ethernet
210122f2c49aSHans Petter Selaskydevice		mlx5en		# Mellanox ConnectX-4 and ConnectX-4 LX
21020587cad8SPyun YongHyeondevice		msk		# Marvell/SysKonnect Yukon II Gigabit Ethernet
2103d3d67116SMaxim Sobolevdevice		my		# Myson Fast Ethernet (MTD80X, MTD89X)
2104343ed0a8SJohn Baldwindevice		nge		# NatSemi DP83820 gigabit Ethernet
21050587cad8SPyun YongHyeondevice		re		# RealTek 8139C+/8169/8169S/8110S
2106d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
21072e1b1231SDima Dorfmandevice		pcn		# AMD Am79C97x PCI 10/100 NICs
2108d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
2109d193ed0bSPyun YongHyeondevice		sge		# Silicon Integrated Systems SiS190/191
2110d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
2111343ed0a8SJohn Baldwindevice		sk		# SysKonnect SK-984x & SK-982x gigabit Ethernet
2112d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
21130587cad8SPyun YongHyeondevice		stge		# Sundance/Tamarack TC9021 gigabit Ethernet
2114d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
2115eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
2116d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
21172608aefcSPyun YongHyeondevice		vte		# DM&P Vortex86 RDC R6040 Fast Ethernet
2118d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
2119d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
2120d61e6649SAlexander Langer
2121d61e6649SAlexander Langer# PCI Ethernet NICs.
2122d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
212302f3c16fSJohn Baldwindevice		em		# Intel Pro/1000 Gigabit Ethernet
212402f3c16fSJohn Baldwindevice		igb		# Intel Pro/1000 PCIE Gigabit Ethernet
2125fa14cadaSJohn Baldwindevice		ixgb		# Intel Pro/10Gbe PCI-X Ethernet
2126758cc3dcSJack F Vogeldevice		ix		# Intel Pro/10Gbe PCIE Ethernet
2127758cc3dcSJack F Vogeldevice		ixv		# Intel Pro/10Gbe PCIE Ethernet VF
212844ac0964SMarius Strobldevice		le		# AMD Am7900 LANCE and Am79C9xx PCnet
2129f9ae0280SAndrew Gallatindevice		mxge		# Myricom Myri-10G 10GbE NIC
2130fd3ddbd0SSam Lefflerdevice		nxge		# Neterion Xframe 10GbE Server/Storage Adapter
21312f345d8eSLuigi Rizzodevice		oce		# Emulex 10 GbE (OneConnect Ethernet)
21326e535f6eSRemko Lodderdevice		ti		# Alteon Networks Tigon I/II gigabit Ethernet
213395d67482SBill Pauldevice		txp		# 3Com 3cR990 (``Typhoon'')
2134c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
2135548d35fdSGeorge V. Neville-Neildevice		vxge		# Exar/Neterion XFrame 3100 10GbE
2136d61e6649SAlexander Langer
2137343ed0a8SJohn Baldwin# PCI FDDI NICs.
2138c06a3350SPeter Wemmdevice		fpa
2139d61e6649SAlexander Langer
21402bc6081cSScott Long# PCI WAN adapters.
21412bc6081cSScott Longdevice		lmc
21422bc6081cSScott Long
2143390cee87SJohn Baldwin# PCI IEEE 802.11 Wireless NICs
2144390cee87SJohn Baldwindevice		ath		# Atheros pci/cardbus NIC's
2145390cee87SJohn Baldwindevice		ath_hal		# pci/cardbus chip support
2146390cee87SJohn Baldwin#device		ath_ar5210	# AR5210 chips
2147390cee87SJohn Baldwin#device		ath_ar5211	# AR5211 chips
2148390cee87SJohn Baldwin#device		ath_ar5212	# AR5212 chips
2149390cee87SJohn Baldwin#device		ath_rf2413
2150390cee87SJohn Baldwin#device		ath_rf2417
2151390cee87SJohn Baldwin#device		ath_rf2425
2152390cee87SJohn Baldwin#device		ath_rf5111
2153390cee87SJohn Baldwin#device		ath_rf5112
2154390cee87SJohn Baldwin#device		ath_rf5413
2155390cee87SJohn Baldwin#device		ath_ar5416	# AR5416 chips
2156390cee87SJohn Baldwinoptions 	AH_SUPPORT_AR5416	# enable AR5416 tx/rx descriptors
2157bc391cb2SWarner Losh# All of the AR5212 parts have a problem when paired with the AR71xx
2158bc391cb2SWarner Losh# CPUS.  These parts have a bug that triggers a fatal bus error on the AR71xx
2159bc391cb2SWarner Losh# only.  Details of the exact nature of the bug are sketchy, but some can be
2160bc391cb2SWarner Losh# found at https://forum.openwrt.org/viewtopic.php?pid=70060 on pages 4, 5 and
2161bc391cb2SWarner Losh# 6.  This option enables this workaround.  There is a performance penalty
2162bc391cb2SWarner Losh# for this work around, but without it things don't work at all.  The DMA
2163bc391cb2SWarner Losh# from the card usually bursts 128 bytes, but on the affected CPUs, only
2164bc391cb2SWarner Losh# 4 are safe.
2165bc391cb2SWarner Loshoptions	   	AH_RXCFG_SDMAMW_4BYTES
2166390cee87SJohn Baldwin#device		ath_ar9160	# AR9160 chips
2167390cee87SJohn Baldwin#device		ath_ar9280	# AR9280 chips
216858c4a5a1SRui Paulo#device		ath_ar9285	# AR9285 chips
2169390cee87SJohn Baldwindevice		ath_rate_sample	# SampleRate tx rate control for ath
2170390cee87SJohn Baldwindevice		bwi		# Broadcom BCM430* BCM431*
2171eb5ef23cSWeongyo Jeongdevice		bwn		# Broadcom BCM43xx
2172d1f25d5dSBernhard Schmidtdevice		malo		# Marvell Libertas wireless NICs.
2173d1f25d5dSBernhard Schmidtdevice		mwl		# Marvell 88W8363 802.11n wireless NICs.
2174778eefa4SJohn Baldwindevice		mwlfw
2175390cee87SJohn Baldwindevice		ral		# Ralink Technology RT2500 wireless NICs.
2176390cee87SJohn Baldwin
217710a4360cSPyun YongHyeon# Use sf_buf(9) interface for jumbo buffers on ti(4) controllers.
217810a4360cSPyun YongHyeon#options 	TI_SF_BUF_JUMBO
217998cb733cSKenneth D. Merry# Turn on the header splitting option for the ti(4) driver firmware.  This
218098cb733cSKenneth D. Merry# only works for Tigon II chips, and has no effect for Tigon I chips.
218110a4360cSPyun YongHyeon# This option requires the TI_SF_BUF_JUMBO option above.
2182b590f210SPyun YongHyeon#options 	TI_JUMBO_HDRSPLIT
218398cb733cSKenneth D. Merry
21842c8f5a28SKenneth D. Merry# These two options allow manipulating the mbuf cluster size and mbuf size,
21852c8f5a28SKenneth D. Merry# respectively.  Be very careful with NIC driver modules when changing
21862c8f5a28SKenneth D. Merry# these from their default values, because that can potentially cause a
21872c8f5a28SKenneth D. Merry# mismatch between the mbuf size assumed by the kernel and the mbuf size
21882c8f5a28SKenneth D. Merry# assumed by a module.  The only driver that currently has the ability to
21892c8f5a28SKenneth D. Merry# detect a mismatch is ti(4).
21902c8f5a28SKenneth D. Merryoptions 	MCLSHIFT=12	# mbuf cluster shift in bits, 12 == 4KB
21912c8f5a28SKenneth D. Merryoptions 	MSIZE=512	# mbuf size in bytes
21922c8f5a28SKenneth D. Merry
219368713f97SKenjiro Cho#
219444b5247dSKenjiro Cho# ATM related options (Cranor version)
219544b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
219668713f97SKenjiro Cho#
219768713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
219868713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
219968713f97SKenjiro Cho#
2200c594298bSHartmut Brandt# The `hatm' device provides support for Fore/Marconi HE155 and HE622
2201c594298bSHartmut Brandt# ATM PCI cards.
2202c594298bSHartmut Brandt#
2203fb24f088SHartmut Brandt# The `fatm' device provides support for Fore PCA200E ATM PCI cards.
2204fb24f088SHartmut Brandt#
22058dd4275cSHartmut Brandt# The `patm' device provides support for IDT77252 based cards like
22068dd4275cSHartmut Brandt# ProSum's ProATM-155 and ProATM-25 and IDT's evaluation boards.
22078dd4275cSHartmut Brandt#
2208f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
220968713f97SKenjiro Cho# atm devices.
22103cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
221168713f97SKenjiro Cho# bypass TCP/IP.
221268713f97SKenjiro Cho#
2213fb24f088SHartmut Brandt# utopia provides the access to the ATM PHY chips and is required for en,
2214fb24f088SHartmut Brandt# hatm and fatm.
22151ba46a03SHartmut Brandt#
221668713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
221768713f97SKenjiro Cho# for more details, please read the original documents at
221898a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
221968713f97SKenjiro Cho#
2220f71c01ccSPeter Wemmdevice		atm
222144b5247dSKenjiro Chodevice		en
2222fb24f088SHartmut Brandtdevice		fatm			#Fore PCA200E
2223c594298bSHartmut Brandtdevice		hatm			#Fore/Marconi HE155/622
22248dd4275cSHartmut Brandtdevice		patm			#IDT77252 cards (ProATM and IDT)
22251ba46a03SHartmut Brandtdevice		utopia			#ATM PHY driver
22268c9cef57SBjoern A. Zeeboptions 	NATM			#native ATM
2227f4567b9cSJulian Elischer
22287e9024cdSHartmut Brandtoptions 	LIBMBPOOL		#needed by patm, iatm
22297e9024cdSHartmut Brandt
2230c19da41eSPeter Wemm#
22310739ea1dSSeigo Tanimura# Sound drivers
2232c19da41eSPeter Wemm#
22330739ea1dSSeigo Tanimura# sound: The generic sound driver.
2234c7406082SJohn-Mark Gurney#
22350739ea1dSSeigo Tanimura
22360739ea1dSSeigo Tanimuradevice		sound
22370739ea1dSSeigo Tanimura
22380739ea1dSSeigo Tanimura#
22390739ea1dSSeigo Tanimura# snd_*: Device-specific drivers.
2240c7406082SJohn-Mark Gurney#
22419c0ef6d5SOliver Fromme# The flags of the device tell the device a bit more info about the
22427f5092f3SJohn Baldwin# device that normally is obtained through the PnP interface.
22437f5092f3SJohn Baldwin#	bit  2..0   secondary DMA channel;
22447f5092f3SJohn Baldwin#	bit  4      set if the board uses two dma channels;
22457f5092f3SJohn Baldwin#	bit 15..8   board type, overrides autodetection; leave it
22467f5092f3SJohn Baldwin#		    zero if don't know what to put in (and you don't,
22477f5092f3SJohn Baldwin#		    since this is unsupported at the moment...).
22487f5092f3SJohn Baldwin#
2249c3a730dfSJoel Dahl# snd_ad1816:		Analog Devices AD1816 ISA PnP/non-PnP.
22500739ea1dSSeigo Tanimura# snd_als4000:		Avance Logic ALS4000 PCI.
2251d9bde1adSAriff Abdullah# snd_atiixp:		ATI IXP 200/300/400 PCI.
2252903b2fb9SJoel Dahl# snd_audiocs:		Crystal Semiconductor CS4231 SBus/EBus. Only
2253903b2fb9SJoel Dahl#			for sparc64.
22540739ea1dSSeigo Tanimura# snd_cmi:		CMedia CMI8338/CMI8738 PCI.
22550739ea1dSSeigo Tanimura# snd_cs4281:		Crystal Semiconductor CS4281 PCI.
22560739ea1dSSeigo Tanimura# snd_csa:		Crystal Semiconductor CS461x/428x PCI. (except
22570739ea1dSSeigo Tanimura#			4281)
22580739ea1dSSeigo Tanimura# snd_ds1:		Yamaha DS-1 PCI.
22590739ea1dSSeigo Tanimura# snd_emu10k1:		Creative EMU10K1 PCI and EMU10K2 (Audigy) PCI.
22600fa7ab6aSAlexander Leidinger# snd_emu10kx:		Creative SoundBlaster Live! and Audigy
22619f548240SAlexander Leidinger# snd_envy24:		VIA Envy24 and compatible, needs snd_spicds.
22629f548240SAlexander Leidinger# snd_envy24ht:		VIA Envy24HT and compatible, needs snd_spicds.
22630739ea1dSSeigo Tanimura# snd_es137x:		Ensoniq AudioPCI ES137x PCI.
2264727ded3aSJoel Dahl# snd_ess:		Ensoniq ESS ISA PnP/non-PnP, to be used in
2265727ded3aSJoel Dahl#			conjunction with snd_sbc.
22660739ea1dSSeigo Tanimura# snd_fm801:		Forte Media FM801 PCI.
22670739ea1dSSeigo Tanimura# snd_gusc:		Gravis UltraSound ISA PnP/non-PnP.
22684b8939a1SAriff Abdullah# snd_hda:		Intel High Definition Audio (Controller) and
22694b8939a1SAriff Abdullah#			compatible.
2270e4afd792SAlexander Motin# snd_hdspe:		RME HDSPe AIO and RayDAT.
227117470869SAlexander Motin# snd_ich:		Intel ICH AC'97 and some more audio controllers
2272903b2fb9SJoel Dahl#			embedded in a chipset, for example nVidia
2273903b2fb9SJoel Dahl#			nForce controllers.
22740739ea1dSSeigo Tanimura# snd_maestro:		ESS Technology Maestro-1/2x PCI.
22750739ea1dSSeigo Tanimura# snd_maestro3:		ESS Technology Maestro-3/Allegro PCI.
22760739ea1dSSeigo Tanimura# snd_mss:		Microsoft Sound System ISA PnP/non-PnP.
22770739ea1dSSeigo Tanimura# snd_neomagic:		Neomagic 256 AV/ZX PCI.
22780739ea1dSSeigo Tanimura# snd_sb16:		Creative SoundBlaster16, to be used in
22791c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22800739ea1dSSeigo Tanimura# snd_sb8:		Creative SoundBlaster (pre-16), to be used in
22811c9c6382SRuslan Ermilov#			conjunction with snd_sbc.
22820739ea1dSSeigo Tanimura# snd_sbc:		Creative SoundBlaster ISA PnP/non-PnP.
22837f5092f3SJohn Baldwin#			Supports ESS and Avance ISA chips as well.
22840739ea1dSSeigo Tanimura# snd_solo:		ESS Solo-1x PCI.
2285de8d750fSJoel Dahl# snd_spicds:		SPI codec driver, needed by Envy24/Envy24HT drivers.
2286903b2fb9SJoel Dahl# snd_t4dwave:		Trident 4DWave DX/NX PCI, Sis 7018 PCI and Acer Labs
22870739ea1dSSeigo Tanimura#			M5451 PCI.
2288de8d750fSJoel Dahl# snd_uaudio:		USB audio.
22890739ea1dSSeigo Tanimura# snd_via8233:		VIA VT8233x PCI.
22900739ea1dSSeigo Tanimura# snd_via82c686:	VIA VT82C686A PCI.
22910739ea1dSSeigo Tanimura# snd_vibes:		S3 Sonicvibes PCI.
229281bb901eSPeter Wemm
2293f37a929cSPeter Wemmdevice		snd_ad1816
2294f37a929cSPeter Wemmdevice		snd_als4000
2295d9bde1adSAriff Abdullahdevice		snd_atiixp
22967a7386a3SPyun YongHyeon#device		snd_audiocs
22970739ea1dSSeigo Tanimuradevice		snd_cmi
2298f37a929cSPeter Wemmdevice		snd_cs4281
22990739ea1dSSeigo Tanimuradevice		snd_csa
2300f37a929cSPeter Wemmdevice		snd_ds1
2301f37a929cSPeter Wemmdevice		snd_emu10k1
23020fa7ab6aSAlexander Leidingerdevice		snd_emu10kx
2303b1ff0220SAlexander Leidingerdevice		snd_envy24
23049f548240SAlexander Leidingerdevice		snd_envy24ht
2305f37a929cSPeter Wemmdevice		snd_es137x
23060739ea1dSSeigo Tanimuradevice		snd_ess
2307f37a929cSPeter Wemmdevice		snd_fm801
23080739ea1dSSeigo Tanimuradevice		snd_gusc
23094b8939a1SAriff Abdullahdevice		snd_hda
2310e4afd792SAlexander Motindevice		snd_hdspe
23110739ea1dSSeigo Tanimuradevice		snd_ich
23120739ea1dSSeigo Tanimuradevice		snd_maestro
2313f37a929cSPeter Wemmdevice		snd_maestro3
23140739ea1dSSeigo Tanimuradevice		snd_mss
23150739ea1dSSeigo Tanimuradevice		snd_neomagic
2316f37a929cSPeter Wemmdevice		snd_sb16
2317f37a929cSPeter Wemmdevice		snd_sb8
23180739ea1dSSeigo Tanimuradevice		snd_sbc
23190739ea1dSSeigo Tanimuradevice		snd_solo
23209f548240SAlexander Leidingerdevice		snd_spicds
2321f37a929cSPeter Wemmdevice		snd_t4dwave
2322de8d750fSJoel Dahldevice		snd_uaudio
2323f37a929cSPeter Wemmdevice		snd_via8233
2324f37a929cSPeter Wemmdevice		snd_via82c686
23250739ea1dSSeigo Tanimuradevice		snd_vibes
2326c19da41eSPeter Wemm
23271c9c6382SRuslan Ermilov# For non-PnP sound cards:
2328673974d9SRuslan Ermilovhint.pcm.0.at="isa"
2329673974d9SRuslan Ermilovhint.pcm.0.irq="10"
2330673974d9SRuslan Ermilovhint.pcm.0.drq="1"
2331673974d9SRuslan Ermilovhint.pcm.0.flags="0x0"
2332673974d9SRuslan Ermilovhint.sbc.0.at="isa"
2333673974d9SRuslan Ermilovhint.sbc.0.port="0x220"
2334673974d9SRuslan Ermilovhint.sbc.0.irq="5"
2335673974d9SRuslan Ermilovhint.sbc.0.drq="1"
2336673974d9SRuslan Ermilovhint.sbc.0.flags="0x15"
2337673974d9SRuslan Ermilovhint.gusc.0.at="isa"
2338673974d9SRuslan Ermilovhint.gusc.0.port="0x220"
2339673974d9SRuslan Ermilovhint.gusc.0.irq="5"
2340673974d9SRuslan Ermilovhint.gusc.0.drq="1"
2341673974d9SRuslan Ermilovhint.gusc.0.flags="0x13"
23427f5092f3SJohn Baldwin
23436a8d6623SGarrett Wollman#
234418fe4678SAriff Abdullah# Following options are intended for debugging/testing purposes:
234518fe4678SAriff Abdullah#
234618fe4678SAriff Abdullah# SND_DEBUG                    Enable extra debugging code that includes
234718fe4678SAriff Abdullah#                              sanity checking and possible increase of
234818fe4678SAriff Abdullah#                              verbosity.
234918fe4678SAriff Abdullah#
2350d51e8487SJosh Paetzel# SND_DIAGNOSTIC               Similar in a spirit of INVARIANTS/DIAGNOSTIC,
235118fe4678SAriff Abdullah#                              zero tolerance against inconsistencies.
235218fe4678SAriff Abdullah#
235318fe4678SAriff Abdullah# SND_FEEDER_MULTIFORMAT       By default, only 16/32 bit feeders are compiled
235418fe4678SAriff Abdullah#                              in. This options enable most feeder converters
235518fe4678SAriff Abdullah#                              except for 8bit. WARNING: May bloat the kernel.
235618fe4678SAriff Abdullah#
235718fe4678SAriff Abdullah# SND_FEEDER_FULL_MULTIFORMAT  Ditto, but includes 8bit feeders as well.
235818fe4678SAriff Abdullah#
235918fe4678SAriff Abdullah# SND_FEEDER_RATE_HP           (feeder_rate) High precision 64bit arithmetic
236018fe4678SAriff Abdullah#                              as much as possible (the default trying to
236118fe4678SAriff Abdullah#                              avoid it). Possible slowdown.
236218fe4678SAriff Abdullah#
236318fe4678SAriff Abdullah# SND_PCM_64                   (Only applicable for i386/32bit arch)
236418fe4678SAriff Abdullah#                              Process 32bit samples through 64bit
236518fe4678SAriff Abdullah#                              integer/arithmetic. Slight increase of dynamic
236618fe4678SAriff Abdullah#                              range at a cost of possible slowdown.
236718fe4678SAriff Abdullah#
236818fe4678SAriff Abdullah# SND_OLDSTEREO                Only 2 channels are allowed, effectively
236918fe4678SAriff Abdullah#                              disabling multichannel processing.
237018fe4678SAriff Abdullah#
237118fe4678SAriff Abdullahoptions		SND_DEBUG
237218fe4678SAriff Abdullahoptions		SND_DIAGNOSTIC
237318fe4678SAriff Abdullahoptions		SND_FEEDER_MULTIFORMAT
237418fe4678SAriff Abdullahoptions		SND_FEEDER_FULL_MULTIFORMAT
237518fe4678SAriff Abdullahoptions		SND_FEEDER_RATE_HP
237618fe4678SAriff Abdullahoptions		SND_PCM_64
237718fe4678SAriff Abdullahoptions		SND_OLDSTEREO
237818fe4678SAriff Abdullah
237918fe4678SAriff Abdullah#
2380567e21c2SBruce Evans# Miscellaneous hardware:
23816a8d6623SGarrett Wollman#
23826fe8789dSMatthew N. Dodd# scd: Sony CD-ROM using proprietary (non-ATAPI) interface
23833ae5b532SMatthew N. Dodd# mcd: Mitsumi CD-ROM using proprietary (non-ATAPI) interface
23841c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
23857f5092f3SJohn Baldwin# joy: joystick (including IO DATA PCJOY PC Card joystick)
2386603d67aeSRink Springer# cmx: OmniKey CardMan 4040 pccard smartcard reader
2387657e73c4SPeter Dufault
23883ae5b532SMatthew N. Dodd# Mitsumi CD-ROM
23893ae5b532SMatthew N. Dodddevice		mcd
23903ae5b532SMatthew N. Doddhint.mcd.0.at="isa"
23913ae5b532SMatthew N. Doddhint.mcd.0.port="0x300"
23926fe8789dSMatthew N. Dodd# for the Sony CDU31/33A CDROM
23936fe8789dSMatthew N. Dodddevice		scd
23946fe8789dSMatthew N. Doddhint.scd.0.at="isa"
23956fe8789dSMatthew N. Doddhint.scd.0.port="0x230"
23961c9c6382SRuslan Ermilovdevice		joy			# PnP aware, hints for non-PnP only
23977f5092f3SJohn Baldwinhint.joy.0.at="isa"
23987f5092f3SJohn Baldwinhint.joy.0.port="0x201"
2399603d67aeSRink Springerdevice		cmx
2400a800f455SJulian Elischer
2401eeb706c0SJustin T. Gibbs#
2402a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
24031c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2404a2f87f42SPeter Pentchev# TV card, e.g. Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
24051c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
24061c2b5939SRoger Hardiman#
2407a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2408a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2409a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2410a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
24111c2b5939SRoger Hardiman# These options can be used to override the auto detection
241298a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
24131c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
24149ff07e32SAmancio Hasty#
24154f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
24161c2b5939SRoger Hardiman# or
24171c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
24183c7c6c12SMike Pritchard# Specifies the default video capture mode.
24191748d1e5SGavin Atkinson# This is required for Dual Crystal (28&35MHz) boards where PAL is used
2420d51e8487SJosh Paetzel# to prevent hangs during initialization, e.g. VideoLogic Captivator PCI.
2421a9c5b8d0SSøren Schmidt#
24224f5f3f07SBrian Somers# options 	BKTR_USE_PLL
24231748d1e5SGavin Atkinson# This is required for PAL or SECAM boards with a 28MHz crystal and no 35MHz
2424a2f87f42SPeter Pentchev# crystal, e.g. some new Bt878 cards.
2425a9c5b8d0SSøren Schmidt#
24261c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
24279c0ef6d5SOliver Fromme# This enables IOCTLs which give user level access to the GPIO port.
24281c2b5939SRoger Hardiman#
24291c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
2430d51e8487SJosh Paetzel# Prevents the MSP34xx reset. Good if you initialize the MSP in another OS first
24311c2b5939SRoger Hardiman#
24321c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
24331c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
24341c2b5939SRoger Hardiman#
24351c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
24361c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
24371c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
24381c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
24391c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
24401c2b5939SRoger Hardiman# As a rough guess, old = before 1998
24411c2b5939SRoger Hardiman#
244230e27d96SAlexander Langer# options 	BKTR_NEW_MSP34XX_DRIVER
244330e27d96SAlexander Langer# Use new, more complete initialization scheme for the msp34* soundchip.
244430e27d96SAlexander Langer# Should fix stereo autodetection if the old driver does only output
244530e27d96SAlexander Langer# mono sound.
2446017b0edcSMatt Jacob
2447c17d4340SNicolas Souchu#
2448c17d4340SNicolas Souchu# options 	BKTR_USE_FREEBSD_SMBUS
2449c17d4340SNicolas Souchu# Compile with FreeBSD SMBus implementation
2450c17d4340SNicolas Souchu#
245128ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
24520f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
245337973e86SPeter Wemm#     device smbus
245437973e86SPeter Wemm#     device iicbus
245537973e86SPeter Wemm#     device iicbb
2456c17d4340SNicolas Souchu#     device iicsmb
24570f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
24580f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
245928ebb692SNicolas Souchu#
2460c06a3350SPeter Wemmdevice		bktr
2461446cee6eSJoerg Wunsch
2462dc9deb29SPoul-Henning Kamp#
24636e818956SDavid E. O'Brien# PC Card/PCMCIA and Cardbus
24646e818956SDavid E. O'Brien#
24655bcb64f2SWarner Losh# cbb: pci/cardbus bridge implementing YENTA interface
24666e818956SDavid E. O'Brien# pccard: pccard slots
24676e818956SDavid E. O'Brien# cardbus: cardbus slots
24686e818956SDavid E. O'Briendevice		cbb
24696e818956SDavid E. O'Briendevice		pccard
24706e818956SDavid E. O'Briendevice		cardbus
24716e818956SDavid E. O'Brien
24726e818956SDavid E. O'Brien#
24735bcb64f2SWarner Losh# MMC/SD
24745bcb64f2SWarner Losh#
2475831f5dcfSAlexander Motin# mmc 		MMC/SD bus
2476831f5dcfSAlexander Motin# mmcsd		MMC/SD memory card
2477831f5dcfSAlexander Motin# sdhci		Generic PCI SD Host Controller
2478831f5dcfSAlexander Motin#
2479831f5dcfSAlexander Motindevice		mmc
2480831f5dcfSAlexander Motindevice		mmcsd
2481831f5dcfSAlexander Motindevice		sdhci
24825bcb64f2SWarner Losh
24835bcb64f2SWarner Losh#
24848afa373cSNicolas Souchu# SMB bus
24858afa373cSNicolas Souchu#
24863c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
24873c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
24883c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
24898afa373cSNicolas Souchu#
24908afa373cSNicolas Souchu# Supported devices:
24914d5f30e0SRuslan Ermilov# smb		standard I/O through /dev/smb*
24928afa373cSNicolas Souchu#
24933c5656bfSArchie Cobbs# Supported SMB interfaces:
249428ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
249528ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
24967f5092f3SJohn Baldwin# intpm		Intel PIIX4 (82371AB, 82443MX) Power Management Unit
24977f5092f3SJohn Baldwin# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
24987f5092f3SJohn Baldwin# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
24997f5092f3SJohn Baldwin# viapm		VIA VT82C586B/596B/686A and VT8233 Power Management Unit
2500b1acc4a2SMurray Stokely# amdpm		AMD 756 Power Management Unit
25014d5f30e0SRuslan Ermilov# amdsmb	AMD 8111 SMBus 2.0 Controller
250244e6ce01SNicolas Souchu# nfpm		NVIDIA nForce Power Management Unit
25034d5f30e0SRuslan Ermilov# nfsmb		NVIDIA nForce2/3/4 MCP SMBus 2.0 Controller
25040572ccaaSJim Harris# ismt		Intel SMBus 2.0 controller chips (on Atom S1200, C2000)
25058afa373cSNicolas Souchu#
2506c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
25073c5656bfSArchie Cobbs
25087f5092f3SJohn Baldwindevice		intpm
25097f5092f3SJohn Baldwindevice		alpm
25107f5092f3SJohn Baldwindevice		ichsmb
25117f5092f3SJohn Baldwindevice		viapm
251244e6ce01SNicolas Souchudevice		amdpm
25134d5f30e0SRuslan Ermilovdevice		amdsmb
251444e6ce01SNicolas Souchudevice		nfpm
25154d5f30e0SRuslan Ermilovdevice		nfsmb
25160572ccaaSJim Harrisdevice		ismt
25177f5092f3SJohn Baldwin
2518c9953c3bSPeter Wemmdevice		smb
25198afa373cSNicolas Souchu
25208afa373cSNicolas Souchu#
25218afa373cSNicolas Souchu# I2C Bus
25228afa373cSNicolas Souchu#
25238afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
25248afa373cSNicolas Souchu#
25258afa373cSNicolas Souchu# Supported devices:
25268afa373cSNicolas Souchu# ic	i2c network interface
25278afa373cSNicolas Souchu# iic	i2c standard io
2528f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
25291ab68cbbSJayachandran C.# iicoc simple polling driver for OpenCores I2C controller
25308afa373cSNicolas Souchu#
25318afa373cSNicolas Souchu# Supported interfaces:
253228ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
253328ebb692SNicolas Souchu#
253428ebb692SNicolas Souchu# Other:
253528ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
25368afa373cSNicolas Souchu#
2537c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2538c9953c3bSPeter Wemmdevice		iicbb
25398afa373cSNicolas Souchu
2540c9953c3bSPeter Wemmdevice		ic
2541c9953c3bSPeter Wemmdevice		iic
2542c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
25431ab68cbbSJayachandran C.device		iicoc		# OpenCores I2C controller support
25448afa373cSNicolas Souchu
2545286fa445SRafal Jaworowski# I2C peripheral devices
2546286fa445SRafal Jaworowski#
2547286fa445SRafal Jaworowski# ds133x	Dallas Semiconductor DS1337, DS1338 and DS1339 RTC
25481513a6ffSJayachandran C.# ds1374	Dallas Semiconductor DS1374 RTC
2549286fa445SRafal Jaworowski# ds1672	Dallas Semiconductor DS1672 RTC
2550f8e8af9cSHiroki Sato# s35390a	Seiko Instruments S-35390A RTC
2551286fa445SRafal Jaworowski#
2552286fa445SRafal Jaworowskidevice		ds133x
25531513a6ffSJayachandran C.device		ds1374
2554286fa445SRafal Jaworowskidevice		ds1672
2555f8e8af9cSHiroki Satodevice		s35390a
2556286fa445SRafal Jaworowski
2557ab4c624bSMike Smith# Parallel-Port Bus
2558ab4c624bSMike Smith#
2559ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2560ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2561ab4c624bSMike Smith# are automatically probed and attached when found.
2562ab4c624bSMike Smith#
2563ab4c624bSMike Smith# Supported devices:
2564ab4c624bSMike Smith# vpo	Iomega Zip Drive
2565f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2566f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2567fdf94d1aSNicolas Souchu# lpt	Parallel Printer
256846f3ff79SMike Smith# plip	Parallel network interface
2569fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2570f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
257128ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
25721caef332SWojciech A. Koszek# pcfclock Parallel port clock driver.
2573ab4c624bSMike Smith#
2574ab4c624bSMike Smith# Supported interfaces:
2575ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2576ab4c624bSMike Smith#
2577ef8f7626SNicolas Souchu
25780f210c92SNicolas Souchuoptions 	PPC_PROBE_CHIPSET # Enable chipset specific detection
25790f210c92SNicolas Souchu				  # (see flags in ppc(4))
25805895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
25819d5abbddSJens Schweikhardtoptions 	PERIPH_1284	# Makes your computer act as an IEEE1284
2582ef8f7626SNicolas Souchu				# compliant peripheral
25835895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
25845895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
25855895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
25865895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
25875895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
25883b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_VERBOSE         # Verbose pcfclock driver
25893b2d592cSJordan K. Hubbardoptions 	PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2590ef8f7626SNicolas Souchu
2591f71c01ccSPeter Wemmdevice		ppc
2592f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2593f71c01ccSPeter Wemmhint.ppc.0.irq="7"
25940d31b179SPeter Wemmdevice		ppbus
25950d31b179SPeter Wemmdevice		vpo
25960d31b179SPeter Wemmdevice		lpt
25970d31b179SPeter Wemmdevice		plip
25980d31b179SPeter Wemmdevice		ppi
25990d31b179SPeter Wemmdevice		pps
26000d31b179SPeter Wemmdevice		lpbb
26010d31b179SPeter Wemmdevice		pcfclock
2602ab4c624bSMike Smith
2603f45757caSChristian Brueffer#
2604f45757caSChristian Brueffer# Etherswitch framework and drivers
2605f45757caSChristian Brueffer#
2606f45757caSChristian Brueffer# etherswitch	The etherswitch(4) framework
2607f45757caSChristian Brueffer# miiproxy	Proxy device for miibus(4) functionality
2608f45757caSChristian Brueffer#
2609f45757caSChristian Brueffer# Switch hardware support:
2610f45757caSChristian Brueffer# arswitch	Atheros switches
2611f45757caSChristian Brueffer# ip17x 	IC+ 17x family switches
2612f45757caSChristian Brueffer# rtl8366r	Realtek RTL8366 switches
2613f45757caSChristian Brueffer# ukswitch	Multi-PHY switches
2614f45757caSChristian Brueffer#
2615f45757caSChristian Bruefferdevice		etherswitch
2616f45757caSChristian Bruefferdevice		miiproxy
2617f45757caSChristian Bruefferdevice		arswitch
2618f45757caSChristian Bruefferdevice		ip17x
2619f45757caSChristian Bruefferdevice		rtl8366rb
2620f45757caSChristian Bruefferdevice		ukswitch
2621f45757caSChristian Brueffer
26220ac40133SBrian Somers# Kernel BOOTP support
26230ac40133SBrian Somers
26240ac40133SBrian Somersoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2625c15882f0SRick Macklem				# Requires NFSCL and NFS_ROOT
26260ac40133SBrian Somersoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
26270ac40133SBrian Somersoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
26280ac40133SBrian Somersoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
26290ac40133SBrian Somersoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2630eead3ae9SBenno Riceoptions 	BOOTP_BLOCKSIZE=8192 # Override NFS block size
2631432aad0eSTor Egge
2632d94f38acSEivind Eklund#
26334103b765SPoul-Henning Kamp# Add software watchdog routines.
2634370c3cb5SSean Kelly#
26354103b765SPoul-Henning Kampoptions 	SW_WATCHDOG
2636370c3cb5SSean Kelly
2637370c3cb5SSean Kelly#
2638f7829d0dSAttilio Rao# Add the software deadlock resolver thread.
2639f7829d0dSAttilio Rao#
2640f7829d0dSAttilio Raooptions 	DEADLKRES
2641f7829d0dSAttilio Rao
2642f7829d0dSAttilio Rao#
2643b99d6e6fSDavid Schultz# Disable swapping of stack pages.  This option removes all
26444e0ee531SMike Barcroft# code which actually performs swapping, so it's not possible to turn
26454e0ee531SMike Barcroft# it back on at run-time.
2646c796cfa1SAndrzej Bialecki#
2647c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2648c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2649c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2650c796cfa1SAndrzej Bialecki#
265119dde963SPeter Wemm#options 	NO_SWAPPING
2652c796cfa1SAndrzej Bialecki
26539dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
26549dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
26559dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
26569dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
26579dab0776SDavid Greenman#
26585895e3c8SPeter Wemmoptions 	NSFBUFS=1024
26599dab0776SDavid Greenman
266015a1057cSEivind Eklund#
2661053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
26629c0ef6d5SOliver Fromme# line of whatever acquired the lock in the lock itself, and changes a
2663053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
26642c048c4aSBryan Drewery# not at all useful unless you are debugging lock code.  Note that
26652c048c4aSBryan Drewery# modules should be recompiled as this option modifies KBI.
266615a1057cSEivind Eklund#
266715a1057cSEivind Eklundoptions 	DEBUG_LOCKS
266815a1057cSEivind Eklund
266926086a03SPeter Wemm
267026086a03SPeter Wemm#####################################################################
26711d33cf3dSNick Hibma# USB support
26721d33cf3dSNick Hibma# UHCI controller
2673c9953c3bSPeter Wemmdevice		uhci
26741d33cf3dSNick Hibma# OHCI controller
2675c9953c3bSPeter Wemmdevice		ohci
2676ca3acad1SBernd Walter# EHCI controller
2677ca3acad1SBernd Walterdevice		ehci
2678857508a3SAndrew Thompson# XHCI controller
2679857508a3SAndrew Thompsondevice		xhci
268039e5901eSTakanori Watanabe# SL811 Controller
2681b92755d1SAndrew Thompson#device		slhci
26821d33cf3dSNick Hibma# General USB code (mandatory for USB)
2683c9953c3bSPeter Wemmdevice		usb
26841d33cf3dSNick Hibma#
2685b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2686b5ea1f0cSNick Hibmadevice		udbp
2687d1233ab3SBruce Evans# USB Fm Radio
2688d1233ab3SBruce Evansdevice		ufm
26892d45d793SHans Petter Selasky# USB temperature meter
26902d45d793SHans Petter Selaskydevice		ugold
26916bd03b20SKevin Lo# USB LED
26926bd03b20SKevin Lodevice		uled
2693f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2694c9953c3bSPeter Wemmdevice		uhid
26951d33cf3dSNick Hibma# USB keyboard
2696c9953c3bSPeter Wemmdevice		ukbd
26971d33cf3dSNick Hibma# USB printer
2698c9953c3bSPeter Wemmdevice		ulpt
269931615ef7SRebecca Cran# USB mass storage driver (Requires scbus and da)
2700c9953c3bSPeter Wemmdevice		umass
270131615ef7SRebecca Cran# USB mass storage driver for device-side mode
270231615ef7SRebecca Crandevice		usfs
2703ce17576aSScott Long# USB support for Belkin F5U109 and Magic Control Technology serial adapters
2704ce17576aSScott Longdevice		umct
2705e9fb12d3SNick Hibma# USB modem support
2706e9fb12d3SNick Hibmadevice		umodem
2707f26c33d2SNick Hibma# USB mouse
2708c9953c3bSPeter Wemmdevice		ums
2709eed447b5SHans Petter Selasky# USB touchpad(s)
2710eed447b5SHans Petter Selaskydevice		atp
2711eed447b5SHans Petter Selaskydevice		wsp
2712f25a8a01SGleb Smirnoff# eGalax USB touch screen
2713f25a8a01SGleb Smirnoffdevice		uep
27141c9c6382SRuslan Ermilov# Diamond Rio 500 MP3 player
2715e2dbd15fSNick Hibmadevice		urio
2716d1233ab3SBruce Evans#
2717916e6e02SJosef Karthauser# USB serial support
2718916e6e02SJosef Karthauserdevice		ucom
2719fe75118bSNick Hibma# USB support for 3G modem cards by Option, Novatel, Huawei and Sierra
2720483b9e47SNick Hibmadevice		u3g
27219aab0d96SMaxim Konovalov# USB support for Technologies ARK3116 based serial adapters
27229aab0d96SMaxim Konovalovdevice		uark
2723d1233ab3SBruce Evans# USB support for Belkin F5U103 and compatible serial adapters
2724d1233ab3SBruce Evansdevice		ubsa
272548b68edfSJosef Karthauser# USB support for serial adapters based on the FT8U100AX and FT8U232AM
272648b68edfSJosef Karthauserdevice		uftdi
2727c5286e11STakanori Watanabe# USB support for some Windows CE based serial communication.
2728c5286e11STakanori Watanabedevice		uipaq
272948b68edfSJosef Karthauser# USB support for Prolific PL-2303 serial adapters
2730916e6e02SJosef Karthauserdevice		uplcom
27312e7328e7SRink Springer# USB support for Silicon Laboratories CP2101/CP2102 based USB serial adapters
27322e7328e7SRink Springerdevice		uslcom
273348b68edfSJosef Karthauser# USB Visor and Palm devices
273448b68edfSJosef Karthauserdevice		uvisor
2735d1233ab3SBruce Evans# USB serial support for DDI pocket's PHS
2736d1233ab3SBruce Evansdevice		uvscom
2737f26c33d2SNick Hibma#
2738ff6b30b9SKevin Lo# USB ethernet support
2739ff6b30b9SKevin Lodevice		uether
2740ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2741d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2742d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2743d04bb221SBill Paul# eval board.
2744c9953c3bSPeter Wemmdevice		aue
2745bf029145SRobert Watson
2746bf029145SRobert Watson# ASIX Electronics AX88172 USB 2.0 ethernet driver. Used in the
2747bf029145SRobert Watson# LinkSys USB200M and various other adapters.
2748bf029145SRobert Watsondevice		axe
274979eb99dfSLi-Wen Hsu# ASIX Electronics AX88178A/AX88179 USB 2.0/3.0 gigabit ethernet driver.
275079eb99dfSLi-Wen Hsudevice		axge
2751bf029145SRobert Watson
2752dfd1e98eSBill Paul#
27536bcf0032SMaxim Sobolev# Devices which communicate using Ethernet over USB, particularly
27546bcf0032SMaxim Sobolev# Communication Device Class (CDC) Ethernet specification. Supports
27556bcf0032SMaxim Sobolev# Sharp Zaurus PDAs, some DOCSIS cable modems and so on.
27566bcf0032SMaxim Sobolevdevice		cdce
27576bcf0032SMaxim Sobolev#
275801779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
275901779872SBill Paul# and Netmate II, and the Belkin F5U111.
2760c9953c3bSPeter Wemmdevice		cue
276101779872SBill Paul#
2762dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2763d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2764d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
276501779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
276601779872SBill Paul# and 2104USB, and the Corega USB-T.
2767c9953c3bSPeter Wemmdevice		kue
276811e04b05SShunsuke Akiyama#
276911e04b05SShunsuke Akiyama# RealTek RTL8150 USB to fast ethernet. Supports the Melco LUA-KTX
277011e04b05SShunsuke Akiyama# and the GREEN HOUSE GH-USB100B.
277111e04b05SShunsuke Akiyamadevice		rue
2772cdd40f3bSMIHIRA Sanpei Yoshiro#
2773cdd40f3bSMIHIRA Sanpei Yoshiro# Davicom DM9601E USB to fast ethernet. Supports the Corega FEther USB-TXC.
2774cdd40f3bSMIHIRA Sanpei Yoshirodevice		udav
2775941e2863SAndrew Thompson#
2776e1b74f21SKevin Lo# RealTek RTL8152 USB to fast ethernet.
2777e1b74f21SKevin Lodevice		ure
2778e1b74f21SKevin Lo#
277922445463SKevin Lo# Moschip MCS7730/MCS7840 USB to fast ethernet. Supports the Sitecom LN030.
278022445463SKevin Lodevice		mos
278122445463SKevin Lo#
2782941e2863SAndrew Thompson# HSxPA devices from Option N.V
2783941e2863SAndrew Thompsondevice		uhso
2784cdd40f3bSMIHIRA Sanpei Yoshiro
278531d98677SRui Paulo# Realtek RTL8188SU/RTL8191SU/RTL8192SU wireless driver
278631d98677SRui Paulodevice		rsu
27878a4cd00aSWarner Losh#
278871aa1d32SSam Leffler# Ralink Technology RT2501USB/RT2601USB wireless driver
278971aa1d32SSam Lefflerdevice		rum
279093393dfdSAndrew Thompson# Ralink Technology RT2700U/RT2800U/RT3000U wireless driver
279193393dfdSAndrew Thompsondevice		run
27928a4cd00aSWarner Losh#
279371aa1d32SSam Leffler# Atheros AR5523 wireless driver
279471aa1d32SSam Lefflerdevice		uath
279571aa1d32SSam Leffler#
2796d1f25d5dSBernhard Schmidt# Conexant/Intersil PrismGT wireless driver
2797d1f25d5dSBernhard Schmidtdevice		upgt
2798d1f25d5dSBernhard Schmidt#
279971aa1d32SSam Leffler# Ralink Technology RT2500USB wireless driver
28008a4cd00aSWarner Loshdevice		ural
28018a4cd00aSWarner Losh#
280229311227SHans Petter Selasky# RNDIS USB ethernet driver
280329311227SHans Petter Selaskydevice		urndis
28045aaea652SKevin Lo# Realtek RTL8187B/L wireless driver
28055aaea652SKevin Lodevice		urtw
28065aaea652SKevin Lo#
280771aa1d32SSam Leffler# ZyDas ZD1211/ZD1211B wireless driver
280871aa1d32SSam Lefflerdevice		zyd
280945b395cdSGleb Smirnoff#
281045b395cdSGleb Smirnoff# Sierra USB wireless driver
281145b395cdSGleb Smirnoffdevice		usie
2812f26c33d2SNick Hibma
28138a4cd00aSWarner Losh#
2814f26c33d2SNick Hibma# debugging options for the USB subsystem
28151d33cf3dSNick Hibma#
28161d33cf3dSNick Hibmaoptions 	USB_DEBUG
2817fe75118bSNick Hibmaoptions 	U3G_DEBUG
2818f26c33d2SNick Hibma
28196e8394b8SKazutaka YOKOTA# options for ukbd:
28206e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
282191b050b2SPoul-Henning Kampmakeoptions	UKBD_DFLT_KEYMAP=jp.pc98
28226e8394b8SKazutaka YOKOTA
2823565f53bbSShunsuke Akiyama# options for uplcom:
28243c7c6c12SMike Pritchardoptions 	UPLCOM_INTR_INTERVAL=100	# interrupt pipe interval
2825565f53bbSShunsuke Akiyama						# in milliseconds
2826565f53bbSShunsuke Akiyama
282720280807SShunsuke Akiyama# options for uvscom:
282820280807SShunsuke Akiyamaoptions 	UVSCOM_DEFAULT_OPKTSIZE=8	# default output packet size
28293c7c6c12SMike Pritchardoptions 	UVSCOM_INTR_INTERVAL=100	# interrupt pipe interval
2830565f53bbSShunsuke Akiyama						# in milliseconds
283120280807SShunsuke Akiyama
28328b7ce2ffSSam Leffler#####################################################################
2833869093b1SHidetoshi Shimokawa# FireWire support
28347d2ba89bSJohn Baldwin
2835869093b1SHidetoshi Shimokawadevice		firewire	# FireWire bus code
28367d2ba89bSJohn Baldwindevice		sbp		# SCSI over Firewire (Requires scbus and da)
283779acdabbSHidetoshi Shimokawadevice		sbp_targ	# SBP-2 Target mode  (Requires scbus and targ)
2838869093b1SHidetoshi Shimokawadevice		fwe		# Ethernet over FireWire (non-standard!)
28391c9c6382SRuslan Ermilovdevice		fwip		# IP over FireWire (RFC2734 and RFC3146)
2840869093b1SHidetoshi Shimokawa
2841869093b1SHidetoshi Shimokawa#####################################################################
2842869093b1SHidetoshi Shimokawa# dcons support (Dumb Console Device)
2843869093b1SHidetoshi Shimokawa
2844869093b1SHidetoshi Shimokawadevice		dcons			# dumb console driver
2845869093b1SHidetoshi Shimokawadevice		dcons_crom		# FireWire attachment
2846869093b1SHidetoshi Shimokawaoptions 	DCONS_BUF_SIZE=16384	# buffer size
2847869093b1SHidetoshi Shimokawaoptions 	DCONS_POLL_HZ=100	# polling rate
2848869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_CONSOLE=0	# force to be the primary console
2849869093b1SHidetoshi Shimokawaoptions 	DCONS_FORCE_GDB=1	# force to be the gdb device
28507d2ba89bSJohn Baldwin
28517d2ba89bSJohn Baldwin#####################################################################
28528b7ce2ffSSam Leffler# crypto subsystem
28538b7ce2ffSSam Leffler#
28541c9c6382SRuslan Ermilov# This is a port of the OpenBSD crypto framework.  Include this when
2855b2630c29SGeorge V. Neville-Neil# configuring IPSEC and when you have a h/w crypto device to accelerate
28561c9c6382SRuslan Ermilov# user applications that link to OpenSSL.
28578b7ce2ffSSam Leffler#
28581c9c6382SRuslan Ermilov# Drivers are ports from OpenBSD with some simple enhancements that have
28591c9c6382SRuslan Ermilov# been fed back to OpenBSD.
28608b7ce2ffSSam Leffler
28618b7ce2ffSSam Lefflerdevice		crypto		# core crypto support
2862b65946c6SJohn-Mark Gurney
2863b65946c6SJohn-Mark Gurney# Only install the cryptodev device if you are running tests, or know
2864e0b231cbSJohn-Mark Gurney# specifically why you need it.  In most cases, it is not needed and
2865e0b231cbSJohn-Mark Gurney# will make things slower.
28668b7ce2ffSSam Lefflerdevice		cryptodev	# /dev/crypto for access to h/w
28678b7ce2ffSSam Leffler
2868ac7e2c05SSam Lefflerdevice		rndtest		# FIPS 140-2 entropy tester
28698b7ce2ffSSam Leffler
2870b7c4858fSSam Lefflerdevice		hifn		# Hifn 7951, 7781, etc.
2871b7c4858fSSam Leffleroptions 	HIFN_DEBUG	# enable debugging support: hw.hifn.debug
2872b7c4858fSSam Leffleroptions 	HIFN_RNDTEST	# enable rndtest support
2873b7c4858fSSam Leffler
2874b7c4858fSSam Lefflerdevice		ubsec		# Broadcom 5501, 5601, 58xx
2875b7c4858fSSam Leffleroptions 	UBSEC_DEBUG	# enable debugging support: hw.ubsec.debug
2876b7c4858fSSam Leffleroptions 	UBSEC_RNDTEST	# enable rndtest support
2877b7c4858fSSam Leffler
28788b7ce2ffSSam Leffler#####################################################################
28798b7ce2ffSSam Leffler
28808b7ce2ffSSam Leffler
2881785d2100SJohn Birrell#
2882785d2100SJohn Birrell# Embedded system options:
2883785d2100SJohn Birrell#
2884785d2100SJohn Birrell# An embedded system might want to run something other than init.
28850fc9f11dSSergey Kandaurovoptions 	INIT_PATH=/sbin/init:/rescue/init
2886bc0e3a03SJeroen Ruigrok van der Werven
2887bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2888bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
28891c9c6382SRuslan Ermilovoptions 	DEBUG_VFS_LOCKS	# enable VFS lock debugging
2890395bb186SSam Leffleroptions 	SOCKBUF_DEBUG	# enable sockbuf last record/mb tail checking
289141c1a233SGleb Smirnoffoptions 	IFMEDIA_DEBUG	# enable debugging in net/if_media.c
2892bc0e3a03SJeroen Ruigrok van der Werven
2893e2c1a4e9SBenno Rice#
2894e2c1a4e9SBenno Rice# Verbose SYSINIT
2895e2c1a4e9SBenno Rice#
2896e2c1a4e9SBenno Rice# Make the SYSINIT process performed by mi_startup() verbose.  This is very
2897e2c1a4e9SBenno Rice# useful when porting to a new architecture.  If DDB is also enabled, this
2898e2c1a4e9SBenno Rice# will print function names instead of addresses.
2899e2c1a4e9SBenno Riceoptions 	VERBOSE_SYSINIT
2900e2c1a4e9SBenno Rice
2901446af86dSJohn Baldwin#####################################################################
2902446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2903446af86dSJohn Baldwin#
2904446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2905446af86dSJohn Baldwin# one time.
2906446af86dSJohn Baldwinoptions 	SEMMNI=11
2907446af86dSJohn Baldwin
2908446af86dSJohn Baldwin# Total number of semaphores system wide
2909446af86dSJohn Baldwinoptions 	SEMMNS=61
2910446af86dSJohn Baldwin
2911446af86dSJohn Baldwin# Total number of undo structures in system
2912446af86dSJohn Baldwinoptions 	SEMMNU=31
2913446af86dSJohn Baldwin
2914446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2915446af86dSJohn Baldwin# at one time.
2916446af86dSJohn Baldwinoptions 	SEMMSL=61
2917446af86dSJohn Baldwin
2918446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2919446af86dSJohn Baldwin# semaphore at one time.
2920446af86dSJohn Baldwinoptions 	SEMOPM=101
2921446af86dSJohn Baldwin
2922446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2923446af86dSJohn Baldwin# System V semaphore at one time.
2924446af86dSJohn Baldwinoptions 	SEMUME=11
2925446af86dSJohn Baldwin
2926446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2927446af86dSJohn Baldwinoptions 	SHMALL=1025
2928446af86dSJohn Baldwin
2929446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
293025388b6cSBruce Evansoptions 	SHMMAX=(SHMMAXPGS*PAGE_SIZE+1)
2931446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2932446af86dSJohn Baldwin
2933446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2934446af86dSJohn Baldwinoptions 	SHMMIN=2
2935446af86dSJohn Baldwin
2936446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2937446af86dSJohn Baldwin# at one time.
2938446af86dSJohn Baldwinoptions 	SHMMNI=33
2939446af86dSJohn Baldwin
2940446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2941446af86dSJohn Baldwin# a single process at one time.
2942446af86dSJohn Baldwinoptions 	SHMSEG=9
2943446af86dSJohn Baldwin
2944d9282887SDima Dorfman# Set the amount of time (in seconds) the system will wait before
2945d9282887SDima Dorfman# rebooting automatically when a kernel panic occurs.  If set to (-1),
2946d9282887SDima Dorfman# the system will wait indefinitely until a key is pressed on the
2947d9282887SDima Dorfman# console.
2948d9282887SDima Dorfmanoptions 	PANIC_REBOOT_WAIT_TIME=16
2949d9282887SDima Dorfman
29505bbb8060STor Egge# Attempt to bypass the buffer cache and put data directly into the
29515bbb8060STor Egge# userland buffer for read operation when O_DIRECT flag is set on the
29525bbb8060STor Egge# file.  Both offset and length of the read operation must be
29535bbb8060STor Egge# multiples of the physical media sector size.
29545bbb8060STor Egge#
2955995356dcSDag-Erling Smørgravoptions 	DIRECTIO
29565bbb8060STor Egge
29575bbb8060STor Egge# Specify a lower limit for the number of swap I/O buffers.  They are
29585bbb8060STor Egge# (among other things) used when bypassing the buffer cache due to
29595bbb8060STor Egge# DIRECTIO kernel option enabled and O_DIRECT flag set on file.
29605bbb8060STor Egge#
2961995356dcSDag-Erling Smørgravoptions 	NSWBUF_MIN=120
29625bbb8060STor Egge
2963446af86dSJohn Baldwin#####################################################################
2964446af86dSJohn Baldwin
2965bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
29669c0ef6d5SOliver Fromme# Note that documenting these is not considered an affront.
2967bc0e3a03SJeroen Ruigrok van der Werven
2968bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
296928d7984fSJeroen Ruigrok van der Werven
297028d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2971bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
297228d7984fSJeroen Ruigrok van der Werven
2973bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
29748b6f5e65SJeroen Ruigrok van der Werven
297528d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2976bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
297728d7984fSJeroen Ruigrok van der Werven
29788b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
29798b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
29808b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
29818b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
29828b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
29838b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
29848b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
29858b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
29868b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
29878b6f5e65SJeroen Ruigrok van der Werven
29888b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
29898b6f5e65SJeroen Ruigrok van der Werven
2990bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2991bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2992bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2993bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
29948b6f5e65SJeroen Ruigrok van der Werven
29958b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
29968b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
29978b6f5e65SJeroen Ruigrok van der Werven
29988b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
29998b6f5e65SJeroen Ruigrok van der Werven
3000316ec49aSScott Longoptions 	KSTACK_MAX_PAGES=32 # Maximum pages to give the kernel stack
3001b7627840SKonstantin Belousovoptions 	KSTACK_USAGE_PROF
3002316ec49aSScott Long
3003662d3818SScott Long# Adaptec Array Controller driver options
3004662d3818SScott Longoptions 	AAC_DEBUG	# Debugging levels:
3005662d3818SScott Long				# 0 - quiet, only emit warnings
3006662d3818SScott Long				# 1 - noisy, emit major function
3007662d3818SScott Long				#     points and things done
3008662d3818SScott Long				# 2 - extremely noisy, emit trace
3009662d3818SScott Long				#     items in loops, etc.
3010662d3818SScott Long
3011097055e2SEdward Tomasz Napierala# Resource Accounting
3012097055e2SEdward Tomasz Napieralaoptions 	RACCT
3013097055e2SEdward Tomasz Napierala
3014ec125fbbSEdward Tomasz Napierala# Resource Limits
3015ec125fbbSEdward Tomasz Napieralaoptions 	RCTL
3016ec125fbbSEdward Tomasz Napierala
30171e9ea774SBruce Evans# Yet more undocumented options for linting.
30181e9ea774SBruce Evans# BKTR_ALLOC_PAGES has no effect except to cause warnings, and
30191e9ea774SBruce Evans# BROOKTREE_ALLOC_PAGES hasn't actually been superseded by it, since the
30201e9ea774SBruce Evans# driver still mostly spells this option BROOKTREE_ALLOC_PAGES.
302125388b6cSBruce Evans##options 	BKTR_ALLOC_PAGES=(217*4+1)
302225388b6cSBruce Evansoptions 	BROOKTREE_ALLOC_PAGES=(217*4+1)
30231e9ea774SBruce Evansoptions 	MAXFILES=999
3024efba048eSXin LI
3025997b0a64SDag-Erling Smørgrav# Random number generator
302610cb2424SMark Murray# Only ONE of the below two may be used; they are mutually exclusive.
3027646041a8SMark Murray# If neither is present, then the Fortuna algorithm is selected.
3028646041a8SMark Murray#options 	RANDOM_YARROW	# Yarrow CSPRNG (old default)
3029646041a8SMark Murray#options 	RANDOM_LOADABLE	# Allow the algorithm to be loaded as
3030646041a8SMark Murray				# a module.
3031e866d8f0SMark Murray# Select this to allow high-rate but potentially expensive
3032e866d8f0SMark Murray# harvesting of Slab-Allocator entropy. In very high-rate
3033e866d8f0SMark Murray# situations the value of doing this is dubious at best.
3034e866d8f0SMark Murrayoptions 	RANDOM_ENABLE_UMA	# slab allocator
303581e3caafSJustin Hibbits
303681e3caafSJustin Hibbits# Module to enable execution of application via emulators like QEMU
303781e3caafSJustin Hibbitsoptions         IMAGACT_BINMISC
3038aa14e9b7SMark Johnston
303923c9098bSSean Bruno# Intel em(4) driver
304023c9098bSSean Brunooptions		EM_MULTIQUEUE # Activate multiqueue features/disable MSI-X
304123c9098bSSean Bruno
3042aa14e9b7SMark Johnston# zlib I/O stream support
3043aa14e9b7SMark Johnston# This enables support for compressed core dumps.
3044aa14e9b7SMark Johnstonoptions 	GZIO
3045