xref: /freebsd/sys/conf/NOTES (revision 49993db0912b069e39d9d2235b694f1c6deb8523)
12365e64fSRodney W. Grimes#
219dde963SPeter Wemm# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
3f71c01ccSPeter Wemm#
4f71c01ccSPeter Wemm# Lines that begin with 'device', 'options', 'machine', 'ident', 'maxusers',
5f71c01ccSPeter Wemm# 'makeoptions', 'hints' etc go into the kernel configuration that you
6f71c01ccSPeter Wemm# run config(8) with.
7f71c01ccSPeter Wemm#
8f71c01ccSPeter Wemm# Lines that begin with 'hints.' are NOT for config(8), they go into your
9f71c01ccSPeter Wemm# hints file.  See /boot/device.hints and/or the 'hints' config(8) directive.
102365e64fSRodney W. Grimes#
115d4850e7SAlexander Langer# Please use ``make LINT'' to create an old-style LINT file if you want to
125d4850e7SAlexander Langer# do kernel test-builds.
135d4850e7SAlexander Langer#
14c3aac50fSPeter Wemm# $FreeBSD$
152365e64fSRodney W. Grimes#
162365e64fSRodney W. Grimes
176a8d6623SGarrett Wollman#
186a8d6623SGarrett Wollman# This directive is mandatory; it defines the architecture to be
1956be1833SKATO Takenori# configured for; in this case, the 386 family based IBM-PC and
2056be1833SKATO Takenori# compatibles.
216a8d6623SGarrett Wollman#
225895e3c8SPeter Wemmmachine		i386
232365e64fSRodney W. Grimes
246a8d6623SGarrett Wollman#
256a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
266a8d6623SGarrett Wollman# be the same as the name of your kernel.
276a8d6623SGarrett Wollman#
286a8d6623SGarrett Wollmanident		LINT
296a8d6623SGarrett Wollman
306a8d6623SGarrett Wollman#
316a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
326a8d6623SGarrett Wollman# internal system tables by a complicated formula defined in param.c.
336a8d6623SGarrett Wollman#
346a8d6623SGarrett Wollmanmaxusers	10
356a8d6623SGarrett Wollman
366a8d6623SGarrett Wollman#
371b3c07c8SPoul-Henning Kamp# We want LINT to cover profiling as well
388a10dafbSPeter Wemmprofile 	2
391b3c07c8SPoul-Henning Kamp
401b3c07c8SPoul-Henning Kamp#
417bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
42503e6666SBruce Evans# generated Makefile in the build area.
43503e6666SBruce Evans#
44503e6666SBruce Evans# CONF_CFLAGS gives some extra compiler flags that are added to ${CFLAGS}
45503e6666SBruce Evans# after most other flags.  Here we use it to inhibit use of non-optimal
46503e6666SBruce Evans# gcc builtin functions (e.g., memcmp).
47503e6666SBruce Evans#
48503e6666SBruce Evans# DEBUG happens to be magic.
497bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
507bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
517bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
527bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
537bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
547bf01a14SPeter Wemm#
552c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
562c8635c6SPeter Wemm# kernel.
572c8635c6SPeter Wemm#
58503e6666SBruce Evansmakeoptions	CONF_CFLAGS=-fno-builtin  #Don't allow use of memcmp, etc.
595895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
602c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
617bf01a14SPeter Wemm
627bf01a14SPeter Wemm#
6398eb9009SSeigo Tanimura# Certain applications can grow to be larger than the 512M limit
64d43f0f0aSJohn Dyson# that FreeBSD initially imposes.  Below are some options to
6598eb9009SSeigo Tanimura# allow that limit to grow to 1GB, and can be increased further
66d43f0f0aSJohn Dyson# with changing the parameters.  MAXDSIZ is the maximum that the
67d43f0f0aSJohn Dyson# limit can be set to, and the DFLDSIZ is the default value for
68d43f0f0aSJohn Dyson# the limit.  You might want to set the default lower than the
69d43f0f0aSJohn Dyson# max, and explicitly set the maximum with a shell command for processes
70d43f0f0aSJohn Dyson# that regularly exceed the limit like INND.
71d43f0f0aSJohn Dyson#
7298eb9009SSeigo Tanimuraoptions 	MAXDSIZ="(1024UL*1024*1024)"
7398eb9009SSeigo Tanimuraoptions 	DFLDSIZ="(1024UL*1024*1024)"
74d43f0f0aSJohn Dyson
75a59d364aSMatthew Dillon#
76a59d364aSMatthew Dillon# BLKDEV_IOSIZE sets the default block size used in user block
77a59d364aSMatthew Dillon# device I/O.  Note that this value will be overriden by the label
78a59d364aSMatthew Dillon# when specifying a block device from a label with a non-0
798b22cebbSMatthew Dillon# partition blocksize.  The default is PAGE_SIZE.
80a59d364aSMatthew Dillon#
81a59d364aSMatthew Dillonoptions 	BLKDEV_IOSIZE=8192
82a59d364aSMatthew Dillon
8320f71813SJohn-Mark Gurney# Options for the VM subsystem
849a20f99aSJohn Baldwinoptions 	PQ_CACHESIZE=512	# color for 512k/16k cache
859a20f99aSJohn Baldwin# Deprecated options supported for backwards compatibility
8620f71813SJohn-Mark Gurney#options 	PQ_NOOPT		# No coloring
879a20f99aSJohn Baldwin#options 	PQ_LARGECACHE		# color for 512k/16k cache
8820f71813SJohn-Mark Gurney#options 	PQ_HUGECACHE		# color for 1024k/16k cache
897c43028bSKelly Yancey#options 	PQ_MEDIUMCACHE		# color for 256k/16k cache
907c43028bSKelly Yancey#options 	PQ_NORMALCACHE		# color for 64k/16k cache
9120f71813SJohn-Mark Gurney
92827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
93827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
94b44dfc0dSBrian Somers#    strings -n 3 /kernel | sed -n 's/^___//p' > MYKERNEL
95827d623eSJordan K. Hubbard#
96827d623eSJordan K. Hubbardoptions 	INCLUDE_CONFIG_FILE     # Include this file in kernel
97827d623eSJordan K. Hubbard
988b140d57SMike Smith#
998b140d57SMike Smith# The root device and filesystem type can be compiled in;
1008b140d57SMike Smith# this provides a fallback option if the root device cannot
1018b140d57SMike Smith# be correctly guesst by the bootstrap code, or an override if
1028b140d57SMike Smith# the RB_DFLTROOT flag (-r) is specified when booting the kernel.
1038b140d57SMike Smith#
1048b140d57SMike Smithoptions 	ROOTDEVNAME=\"ufs:da0s2e\"
1058b140d57SMike Smith
1066a8d6623SGarrett Wollman
1076a8d6623SGarrett Wollman#####################################################################
108477a642cSPeter Wemm# SMP OPTIONS:
109477a642cSPeter Wemm#
110477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
111477a642cSPeter Wemm# APIC_IO enables the use of the IO APIC for Symmetric I/O.
112477a642cSPeter Wemm#
113477a642cSPeter Wemm# Notes:
114477a642cSPeter Wemm#
115477a642cSPeter Wemm#  An SMP kernel will ONLY run on an Intel MP spec. qualified motherboard.
116477a642cSPeter Wemm#
1175895e3c8SPeter Wemm#  Be sure to disable 'cpu I386_CPU' && 'cpu I486_CPU' for SMP kernels.
118477a642cSPeter Wemm#
119477a642cSPeter Wemm#  Check the 'Rogue SMP hardware' section to see if additional options
120477a642cSPeter Wemm#   are required by your hardware.
121477a642cSPeter Wemm#
122477a642cSPeter Wemm
123477a642cSPeter Wemm# Mandatory:
124477a642cSPeter Wemmoptions 	SMP			# Symmetric MultiProcessor Kernel
125477a642cSPeter Wemmoptions 	APIC_IO			# Symmetric (APIC) I/O
126477a642cSPeter Wemm
127477a642cSPeter Wemm#
128477a642cSPeter Wemm# Rogue SMP hardware:
129477a642cSPeter Wemm#
130477a642cSPeter Wemm
131477a642cSPeter Wemm# Bridged PCI cards:
132477a642cSPeter Wemm#
133477a642cSPeter Wemm# The MP tables of most of the current generation MP motherboards
134477a642cSPeter Wemm#  do NOT properly support bridged PCI cards.  To use one of these
135477a642cSPeter Wemm#  cards you should refer to ???
136477a642cSPeter Wemm
1371fe4c660SJohn Baldwin# SMP Debugging Options:
1381fe4c660SJohn Baldwin#
139ab4f2c18SJohn Baldwin# MUTEX_DEBUG enables various extra assertions in the mutex code.
1401fe4c660SJohn Baldwin# WITNESS enables the mutex witness code which detects deadlocks and cycles
1411fe4c660SJohn Baldwin#         during locking operations.
142660d1e3aSJohn Baldwin# WITNESS_DDB causes the witness code to drop into the kernel debugger if
143660d1e3aSJohn Baldwin#	  a lock heirarchy violation occurs or if locks are held when going to
144660d1e3aSJohn Baldwin#	  sleep.
145660d1e3aSJohn Baldwin# WITNESS_SKIPSPIN disables the witness checks on spin mutexes.
146ab4f2c18SJohn Baldwinoptions 	MUTEX_DEBUG
1471fe4c660SJohn Baldwinoptions 	WITNESS
148660d1e3aSJohn Baldwinoptions 	WITNESS_DDB
149660d1e3aSJohn Baldwinoptions 	WITNESS_SKIPSPIN
1501fe4c660SJohn Baldwin
151477a642cSPeter Wemm
152477a642cSPeter Wemm#####################################################################
15356be1833SKATO Takenori# CPU OPTIONS
15456be1833SKATO Takenori
15556be1833SKATO Takenori#
15656be1833SKATO Takenori# You must specify at least one CPU (the one you intend to run on);
15756be1833SKATO Takenori# deleting the specification for CPUs you don't need to use may make
158e44a0ea3SPeter Wemm# parts of the system run faster.
159e44a0ea3SPeter Wemm# I386_CPU is mutually exclusive with the other CPU types.
16056be1833SKATO Takenori#
161e44a0ea3SPeter Wemm#cpu		I386_CPU
1625895e3c8SPeter Wemmcpu		I486_CPU
1635895e3c8SPeter Wemmcpu		I586_CPU		# aka Pentium(tm)
1645895e3c8SPeter Wemmcpu		I686_CPU		# aka Pentium Pro(tm)
16556be1833SKATO Takenori
16656be1833SKATO Takenori#
16756be1833SKATO Takenori# Options for CPU features.
16856be1833SKATO Takenori#
16956be1833SKATO Takenori# CPU_BLUELIGHTNING_FPU_OP_CACHE enables FPU operand cache on IBM
17056be1833SKATO Takenori# BlueLightning CPU.  It works only with Cyrix FPU, and this option
17156be1833SKATO Takenori# should not be used with Intel FPU.
17256be1833SKATO Takenori#
17356be1833SKATO Takenori# CPU_BLUELIGHTNING_3X enables triple-clock mode on IBM Blue Lightning
17456be1833SKATO Takenori# CPU if CPU supports it. The default is double-clock mode on
17556be1833SKATO Takenori# BlueLightning CPU box.
17656be1833SKATO Takenori#
17756be1833SKATO Takenori# CPU_BTB_EN enables branch target buffer on Cyrix 5x86 (NOTE 1).
17856be1833SKATO Takenori#
1794962d938SKATO Takenori# CPU_DIRECT_MAPPED_CACHE sets L1 cache of Cyrix 486DLC CPU in direct
1804962d938SKATO Takenori# mapped mode.  Default is 2-way set associative mode.
1814962d938SKATO Takenori#
1826593be60SKATO Takenori# CPU_CYRIX_NO_LOCK enables weak locking for the entire address space
1839b953cf6SDag-Erling Smørgrav# of Cyrix 6x86 and 6x86MX CPUs by setting the NO_LOCK bit of CCR1.
1849b953cf6SDag-Erling Smørgrav# Otherwise, the NO_LOCK bit of CCR1 is cleared.  (NOTE 3)
1856593be60SKATO Takenori#
18656be1833SKATO Takenori# CPU_DISABLE_5X86_LSSER disables load store serialize (i.e. enables
18756be1833SKATO Takenori# reorder).  This option should not be used if you use memory mapped
18856be1833SKATO Takenori# I/O device(s).
18956be1833SKATO Takenori#
19056be1833SKATO Takenori# CPU_FASTER_5X86_FPU enables faster FPU exception handler.
19156be1833SKATO Takenori#
19256be1833SKATO Takenori# CPU_I486_ON_386 enables CPU cache on i486 based CPU upgrade products
19356be1833SKATO Takenori# for i386 machines.
1944962d938SKATO Takenori#
195ec4e5afbSRobert Nordier# CPU_IORT defines I/O clock delay time (NOTE 1).  Default values of
19656be1833SKATO Takenori# I/O clock delay time on Cyrix 5x86 and 6x86 are 0 and 7,respectively
19756be1833SKATO Takenori# (no clock delay).
19856be1833SKATO Takenori#
19965cbb03cSKATO Takenori# CPU_L2_LATENCY specifed the L2 cache latency value.  This option is used
20065cbb03cSKATO Takenori# only when CPU_PPRO2CELERON is defined and Mendocino Celeron is detected.
20165cbb03cSKATO Takenori# The default value is 5.
20265cbb03cSKATO Takenori#
20356be1833SKATO Takenori# CPU_LOOP_EN prevents flushing the prefetch buffer if the destination
20456be1833SKATO Takenori# of a jump is already present in the prefetch buffer on Cyrix 5x86(NOTE
20556be1833SKATO Takenori# 1).
20656be1833SKATO Takenori#
20765cbb03cSKATO Takenori# CPU_PPRO2CELERON enables L2 cache of Mendocino Celeron CPUs.  This option
20865cbb03cSKATO Takenori# is useful when you use Socket 8 to Socket 370 converter, because most Pentium
20965cbb03cSKATO Takenori# Pro BIOSs do not enable L2 cache of Mendocino Celeron CPUs.
21065cbb03cSKATO Takenori#
21156be1833SKATO Takenori# CPU_RSTK_EN enables return stack on Cyrix 5x86 (NOTE 1).
21256be1833SKATO Takenori#
21356be1833SKATO Takenori# CPU_SUSP_HLT enables suspend on HALT.  If this option is set, CPU
21456be1833SKATO Takenori# enters suspend mode following execution of HALT instruction.
21556be1833SKATO Takenori#
2164536af6aSKATO Takenori# CPU_WT_ALLOC enables write allocation on Cyrix 6x86/6x86MX and AMD
2174536af6aSKATO Takenori# K5/K6/K6-2 cpus.
2186593be60SKATO Takenori#
21956be1833SKATO Takenori# CYRIX_CACHE_WORKS enables CPU cache on Cyrix 486 CPUs with cache
22056be1833SKATO Takenori# flush at hold state.
22156be1833SKATO Takenori#
22256be1833SKATO Takenori# CYRIX_CACHE_REALLY_WORKS enables (1) CPU cache on Cyrix 486 CPUs
22356be1833SKATO Takenori# without cache flush at hold state, and (2) write-back CPU cache on
22456be1833SKATO Takenori# Cyrix 6x86 whose revision < 2.7 (NOTE 2).
22556be1833SKATO Takenori#
226b0050656SJohn-Mark Gurney# NO_F00F_HACK disables the hack that prevents Pentiums (and ONLY
227b0050656SJohn-Mark Gurney# Pentiums) from locking up when a LOCK CMPXCHG8B instruction is
228c9e6ddc6SDoug Barton# executed.  This option is only needed if I586_CPU is also defined,
229c9e6ddc6SDoug Barton# and should be included for any non-Pentium CPU that defines it.
230b0050656SJohn-Mark Gurney#
231925f3681SMike Smith# NO_MEMORY_HOLE is an optimisation for systems with AMD K6 processors
232925f3681SMike Smith# which indicates that the 15-16MB range is *definitely* not being
233925f3681SMike Smith# occupied by an ISA memory hole.
234925f3681SMike Smith#
23556be1833SKATO Takenori# NOTE 1: The options, CPU_BTB_EN, CPU_LOOP_EN, CPU_IORT,
236ec4e5afbSRobert Nordier# CPU_LOOP_EN and CPU_RSTK_EN should not be used because of CPU bugs.
23756be1833SKATO Takenori# These options may crash your system.
23856be1833SKATO Takenori#
23956be1833SKATO Takenori# NOTE 2: If CYRIX_CACHE_REALLY_WORKS is not set, CPU cache is enabled
24056be1833SKATO Takenori# in write-through mode when revision < 2.7.  If revision of Cyrix
24156be1833SKATO Takenori# 6x86 >= 2.7, CPU cache is always enabled in write-back mode.
24256be1833SKATO Takenori#
2436593be60SKATO Takenori# NOTE 3: This option may cause failures for software that requires
2446593be60SKATO Takenori# locked cycles in order to operate correctly.
2456593be60SKATO Takenori#
2465895e3c8SPeter Wemmoptions 	CPU_BLUELIGHTNING_FPU_OP_CACHE
2475895e3c8SPeter Wemmoptions 	CPU_BLUELIGHTNING_3X
2485895e3c8SPeter Wemmoptions 	CPU_BTB_EN
2495895e3c8SPeter Wemmoptions 	CPU_DIRECT_MAPPED_CACHE
2505895e3c8SPeter Wemmoptions 	CPU_DISABLE_5X86_LSSER
2515895e3c8SPeter Wemmoptions 	CPU_FASTER_5X86_FPU
2525895e3c8SPeter Wemmoptions 	CPU_I486_ON_386
2535895e3c8SPeter Wemmoptions 	CPU_IORT
25465cbb03cSKATO Takenorioptions 	CPU_L2_LATENCY=5
2555895e3c8SPeter Wemmoptions 	CPU_LOOP_EN
25665cbb03cSKATO Takenorioptions 	CPU_PPRO2CELERON
2575895e3c8SPeter Wemmoptions 	CPU_RSTK_EN
2585895e3c8SPeter Wemmoptions 	CPU_SUSP_HLT
2595895e3c8SPeter Wemmoptions 	CPU_WT_ALLOC
2605895e3c8SPeter Wemmoptions 	CYRIX_CACHE_WORKS
2615895e3c8SPeter Wemmoptions 	CYRIX_CACHE_REALLY_WORKS
2625895e3c8SPeter Wemm#options 	NO_F00F_HACK
26356be1833SKATO Takenori
26456be1833SKATO Takenori#
26556be1833SKATO Takenori# A math emulator is mandatory if you wish to run on hardware which
26656be1833SKATO Takenori# does not have a floating-point processor.  Pick either the original,
26756be1833SKATO Takenori# bogus (but freely-distributable) math emulator, or a much more
26856be1833SKATO Takenori# fully-featured but GPL-licensed emulator taken from Linux.
26956be1833SKATO Takenori#
27056be1833SKATO Takenorioptions 	MATH_EMULATE		#Support for x87 emulation
27156be1833SKATO Takenori# Don't enable both of these in a real config.
27256be1833SKATO Takenorioptions 	GPL_MATH_EMULATE	#Support for x87 emulation via
27356be1833SKATO Takenori					#new math emulator
27456be1833SKATO Takenori
27556be1833SKATO Takenori
27656be1833SKATO Takenori#####################################################################
2776a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
278690f540cSAndrey A. Chernov
2796a8d6623SGarrett Wollman#
2806a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
28156c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
28256c7a48cSJordan K. Hubbard# still relies on the 4.3 emulation.
2836a8d6623SGarrett Wollman#
2845895e3c8SPeter Wemmoptions 	COMPAT_43
2856a8d6623SGarrett Wollman
2866a8d6623SGarrett Wollman#
2876a8d6623SGarrett Wollman# These three options provide support for System V Interface
2886a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2896a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2906a8d6623SGarrett Wollman#
2916a8d6623SGarrett Wollmanoptions 	SYSVSHM
2926a8d6623SGarrett Wollmanoptions 	SYSVSEM
2936a8d6623SGarrett Wollmanoptions 	SYSVMSG
2946a8d6623SGarrett Wollman
2956a8d6623SGarrett Wollman
2966a8d6623SGarrett Wollman#####################################################################
2976a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2986a8d6623SGarrett Wollman
2996a8d6623SGarrett Wollman#
300b5d89ca8SBruce Evans# Enable the kernel debugger.
3016a8d6623SGarrett Wollman#
302b5d89ca8SBruce Evansoptions 	DDB
303b5d89ca8SBruce Evans
304b5d89ca8SBruce Evans#
3055ccab2afSGary Palmer# Don't drop into DDB for a panic. Intended for unattended operation
3065ccab2afSGary Palmer# where you may want to drop to DDB from the console, but still want
3075ccab2afSGary Palmer# the machine to recover from a panic
3085ccab2afSGary Palmer#
3095ccab2afSGary Palmeroptions 	DDB_UNATTENDED
3105ccab2afSGary Palmer
3115ccab2afSGary Palmer#
312562d05dfSPaul Traina# If using GDB remote mode to debug the kernel, there's a non-standard
313562d05dfSPaul Traina# extension to the remote protocol that can be used to use the serial
314562d05dfSPaul Traina# port as both the debugging port and the system console.  It's non-
315562d05dfSPaul Traina# standard and you're on your own if you enable it.  See also the
316562d05dfSPaul Traina# "remotechat" variables in the FreeBSD specific version of gdb.
317562d05dfSPaul Traina#
318562d05dfSPaul Trainaoptions 	GDB_REMOTE_CHAT
319562d05dfSPaul Traina
320562d05dfSPaul Traina#
3216a8d6623SGarrett Wollman# KTRACE enables the system-call tracing facility ktrace(2).
3226a8d6623SGarrett Wollman#
3232365e64fSRodney W. Grimesoptions 	KTRACE			#kernel tracing
32421c64a07SAndrey A. Chernov
3256a8d6623SGarrett Wollman#
326c508c1b6SJohn Baldwin# KTR is a kernel tracing mechanism imported from BSD/OS.  Currently it
327c508c1b6SJohn Baldwin# has no userland interface aside from a few sysctl's.  It is enabled with
328c508c1b6SJohn Baldwin# the KTR option.  The KTR_EXTEND option causes trace events to be generated
329c508c1b6SJohn Baldwin# as a string from snprintf rather than as a string and up to 5 argument
330c508c1b6SJohn Baldwin# pointers.  KTR_ENTRIES defines the number of entries in the circular trace
331c508c1b6SJohn Baldwin# buffer.  KTR_COMPILE defines the mask of events to compile into the kernel
332c508c1b6SJohn Baldwin# as defined by the KTR_* constants in <sys/ktr.h>.  KTR_MASK defines the
333c508c1b6SJohn Baldwin# initial value of the ktr_mask variable which determines at runtime what
334c508c1b6SJohn Baldwin# events to trace.  KTR_CPUMASK determines which CPU's log events, with
335d902baa4SJohn Baldwin# bit X corresponding to cpu X.  KTR_VERBOSE enables dumping of KTR events
336d902baa4SJohn Baldwin# to the console by default.  This functionality can be toggled via the
337d902baa4SJohn Baldwin# debug.ktr_verbose sysctl and defaults to off if KTR_VERBOSE is not defined.
338c508c1b6SJohn Baldwin#
339c508c1b6SJohn Baldwinoptions 	KTR
340c508c1b6SJohn Baldwinoptions 	KTR_EXTEND
341c508c1b6SJohn Baldwinoptions 	KTR_ENTRIES=1024
342c508c1b6SJohn Baldwinoptions 	KTR_COMPILE=0x3fffff
343c508c1b6SJohn Baldwinoptions 	KTR_MASK=0x201208
344c508c1b6SJohn Baldwinoptions 	KTR_CPUMASK=0x3
345d902baa4SJohn Baldwinoptions 	KTR_VERBOSE
346c508c1b6SJohn Baldwin
347c508c1b6SJohn Baldwin#
3485526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
3496a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
3506a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
3516a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
3526a8d6623SGarrett Wollman# programming errors.
3536a8d6623SGarrett Wollman#
3545526d2d9SEivind Eklundoptions 	INVARIANTS
3555526d2d9SEivind Eklund
3565526d2d9SEivind Eklund#
35734b15f2aSJohn Baldwin# The INVARIANT_SUPPORT option makes us compile in support for
35834b15f2aSJohn Baldwin# verifying some of the internal structures.  It is a prerequisite for
35934b15f2aSJohn Baldwin# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
36034b15f2aSJohn Baldwin# called.  The intent is that you can set 'INVARIANTS' for single
36134b15f2aSJohn Baldwin# source files (by changing the source file or specifying it on the
36234b15f2aSJohn Baldwin# command line) if you have 'INVARIANT_SUPPORT' enabled.  Also, if you
36334b15f2aSJohn Baldwin# wish to build a kernel module with 'INVARIANTS', then adding
36434b15f2aSJohn Baldwin# 'INVARIANT_SUPPORT' to your kernel will provide all the necessary
36534b15f2aSJohn Baldwin# infrastructure without the added overhead.
36634b15f2aSJohn Baldwin#
36734b15f2aSJohn Baldwinoptions 	INVARIANT_SUPPORT
36834b15f2aSJohn Baldwin
36934b15f2aSJohn Baldwin#
3705526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
3715526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
3725526d2d9SEivind Eklund# it is disabled by default.
3735526d2d9SEivind Eklund#
3740dc7d907SPoul-Henning Kampoptions 	DIAGNOSTIC
375da59a31cSDavid Greenman
3760dd1eea1SJordan K. Hubbard#
377348acd94SGarrett Wollman# PERFMON causes the driver for Pentium/Pentium Pro performance counters
378348acd94SGarrett Wollman# to be compiled.  See perfmon(4) for more information.
379348acd94SGarrett Wollman#
380348acd94SGarrett Wollmanoptions 	PERFMON
381348acd94SGarrett Wollman
382346ebe51SEivind Eklund
383346ebe51SEivind Eklund#
384346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
385346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
386346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
387346ebe51SEivind Eklund# from.)
388346ebe51SEivind Eklund#
389346ebe51SEivind Eklundoptions 	COMPILING_LINT
390346ebe51SEivind Eklund
391346ebe51SEivind Eklund
392348acd94SGarrett Wollman# XXX - this doesn't belong here.
3930dd1eea1SJordan K. Hubbard# Allow ordinary users to take the console - this is useful for X.
3940dd1eea1SJordan K. Hubbardoptions 	UCONSOLE
3950dd1eea1SJordan K. Hubbard
39696fc6efbSPoul-Henning Kamp# XXX - this doesn't belong here either
39796fc6efbSPoul-Henning Kampoptions 	USERCONFIG		#boot -c editor
398ed91f3baSMike Smithoptions 	INTRO_USERCONFIG	#imply -c and show intro screen
39996fc6efbSPoul-Henning Kampoptions 	VISUAL_USERCONFIG	#visual boot -c editor
4006a8d6623SGarrett Wollman
4016a8d6623SGarrett Wollman#####################################################################
4026a8d6623SGarrett Wollman# NETWORKING OPTIONS
40370c0b54cSAndrey A. Chernov
4046a8d6623SGarrett Wollman#
4056a8d6623SGarrett Wollman# Protocol families:
4066a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
40711bfa65aSBruce Evans#  Source code for the NS (Xerox Network Service) is provided for amusement
40811bfa65aSBruce Evans#  value.
4096a8d6623SGarrett Wollman#
4106a8d6623SGarrett Wollmanoptions 	INET			#Internet communications protocols
41151f4c152SYoshinobu Inoueoptions 	INET6			#IPv6 communications protocols
4126a800098SYoshinobu Inoueoptions 	IPSEC			#IP security
4136a800098SYoshinobu Inoueoptions 	IPSEC_ESP		#IP security (crypto; define w/ IPSEC)
4146a800098SYoshinobu Inoueoptions 	IPSEC_DEBUG		#debug for IP security
415f73bbaf2SDavid Greenman
416cc6a66f2SJulian Elischeroptions 	IPX			#IPX/SPX communications protocols
417cc6a66f2SJulian Elischeroptions 	IPXIP			#IPX in IP encapsulation (not available)
418cc6a66f2SJulian Elischeroptions 	IPTUNNEL		#IP in IPX encapsulation (not available)
419cc6a66f2SJulian Elischer
420e83e2322SBoris Popovoptions 	NCP			#NetWare Core protocol
421e83e2322SBoris Popov
42234b5fca7SJulian Elischeroptions 	NETATALK		#Appletalk communications protocols
4238b6f5e65SJeroen Ruigrok van der Wervenoptions 	NETATALKDEBUG		#Appletalk debugging
42434b5fca7SJulian Elischer
42511bfa65aSBruce Evans# These are currently broken but are shipped due to interest.
42611bfa65aSBruce Evans#options 	NS			#Xerox NS protocols
427dc915e7cSGarrett Wollman#options 	NSIP			#XNS over IP
42863a74862SSteven Wallace
429d8589bd5SBoris Popov# mchain library. It can be either loaded as KLD or compiled into kernel
430d8589bd5SBoris Popovoptions 	LIBMCHAIN
431d8589bd5SBoris Popov
4324cf49a43SJulian Elischer# netgraph(4). Enable the base netgraph code with the NETGRAPH option.
4334cf49a43SJulian Elischer# Individual node types can be enabled with the corresponding option
4344cf49a43SJulian Elischer# listed below; however, this is not strictly necessary as netgraph
4354cf49a43SJulian Elischer# will automatically load the corresponding KLD module if the node type
43692a3e552SArchie Cobbs# is not already compiled into the kernel. Each type below has a
43792a3e552SArchie Cobbs# corresponding man page, e.g., ng_async(8).
4384cf49a43SJulian Elischeroptions 	NETGRAPH		#netgraph(4) system
4394cf49a43SJulian Elischeroptions 	NETGRAPH_ASYNC
44092a3e552SArchie Cobbsoptions 	NETGRAPH_BPF
4414cf49a43SJulian Elischeroptions 	NETGRAPH_CISCO
4424cf49a43SJulian Elischeroptions 	NETGRAPH_ECHO
44346aa8b9bSArchie Cobbsoptions 	NETGRAPH_ETHER
4444cf49a43SJulian Elischeroptions 	NETGRAPH_FRAME_RELAY
4454cf49a43SJulian Elischeroptions 	NETGRAPH_HOLE
4464cf49a43SJulian Elischeroptions 	NETGRAPH_IFACE
44748e94174SArchie Cobbsoptions 	NETGRAPH_KSOCKET
4484cf49a43SJulian Elischeroptions 	NETGRAPH_LMI
449a2b408adSArchie Cobbs# MPPC compression requires proprietary files (not included)
450a2b408adSArchie Cobbs#options 	NETGRAPH_MPPC_COMPRESSION
451a2b408adSArchie Cobbsoptions 	NETGRAPH_MPPC_ENCRYPTION
4527d7a5b89SArchie Cobbsoptions 	NETGRAPH_ONE2MANY
453b0801bacSArchie Cobbsoptions 	NETGRAPH_PPP
454b0801bacSArchie Cobbsoptions 	NETGRAPH_PPPOE
455add85a1dSArchie Cobbsoptions 	NETGRAPH_PPTPGRE
4564cf49a43SJulian Elischeroptions 	NETGRAPH_RFC1490
457b0801bacSArchie Cobbsoptions 	NETGRAPH_SOCKET
4584cf49a43SJulian Elischeroptions 	NETGRAPH_TEE
4594cf49a43SJulian Elischeroptions 	NETGRAPH_TTY
4604cf49a43SJulian Elischeroptions 	NETGRAPH_UI
461b58a8a3bSJulian Elischeroptions 	NETGRAPH_VJC
4624cf49a43SJulian Elischer
463c9953c3bSPeter Wemmdevice		mn	# Munich32x/Falc54 Nx64kbit/sec cards.
464599fcb02SPoul-Henning Kampdevice		lmc	# tulip based LanMedia WAN cards
46548ecc012SPoul-Henning Kampdevice		musycc	# LMC/SBE LMC1504 quad T1/E1
4663cf4d0bfSPoul-Henning Kamp
4676a8d6623SGarrett Wollman#
4686a8d6623SGarrett Wollman# Network interfaces:
469f71c01ccSPeter Wemm#  The `loop' device is MANDATORY when networking is enabled.
470f71c01ccSPeter Wemm#  The `ether' device provides generic code to handle
47156c7a48cSJordan K. Hubbard#  Ethernets; it is MANDATORY when a Ethernet device driver is
472722012ccSJulian Elischer#  configured or token-ring is enabled.
473f71c01ccSPeter Wemm#  The 'fddi' device provides generic code to support FDDI.
474f71c01ccSPeter Wemm#  The `sppp' device serves a similar role for certain types
475e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
476f71c01ccSPeter Wemm#  The `sl' device implements the Serial Line IP (SLIP) service.
477f71c01ccSPeter Wemm#  The `ppp' device implements the Point-to-Point Protocol.
478f71c01ccSPeter Wemm#  The `bpf' device enables the Berkeley Packet Filter.  Be
479d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
480d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
481d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
482f71c01ccSPeter Wemm#  The `disc' device implements a minimal network interface,
48359d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
4849e54a8ceSNik Clayton#  included for testing purposes.  This shows up as the 'ds' interface.
4854c12b435SNick Sayer#  The `tap' device is a pty-like virtual Ethernet interface
486f71c01ccSPeter Wemm#  The `tun' device implements (user-)ppp and nos-tun
487f71c01ccSPeter Wemm#  The `gif' device implements IPv6 over IP4 tunneling,
488cfa1ca9dSYoshinobu Inoue#  IPv4 over IPv6 tunneling, IPv4 over IPv4 tunneling and
489cfa1ca9dSYoshinobu Inoue#  IPv6 over IPv6 tunneling.
490f57fc21cSJeroen Ruigrok van der Werven#  The XBONEHACK option allows the same pair of addresses to be configured on
491f57fc21cSJeroen Ruigrok van der Werven#  multiple gif interfaces.
492f71c01ccSPeter Wemm#  The `faith' device captures packets sent to it and diverts them
493cfa1ca9dSYoshinobu Inoue#  to the IPv4/IPv6 translation daemon.
494d5015639SMunechika SUMIKAWA#  The `stf' device implements 6to4 encapsulation.
495f71c01ccSPeter Wemm#  The `ef' device provides support for multiple ethernet frame types
4965d94d71cSBoris Popov#  specified via ETHER_* options. See ef(4) for details.
4976a8d6623SGarrett Wollman#
498829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
499829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
500829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
5016b5ca0d8SDag-Erling Smørgrav# events for resetting the demand dial activity timer - requires bpf.
502829b5d55SPeter Wemm# See pppd(8) for more details.
50389327d27SPeter Wemm#
504f71c01ccSPeter Wemmdevice		ether			#Generic Ethernet
505f71c01ccSPeter Wemmdevice		vlan	1		#VLAN support
506f71c01ccSPeter Wemmdevice		token			#Generic TokenRing
507f71c01ccSPeter Wemmdevice		fddi			#Generic FDDI
508f71c01ccSPeter Wemmdevice		sppp			#Generic Synchronous PPP
509f71c01ccSPeter Wemmdevice		loop	1		#Network loopback device
510f71c01ccSPeter Wemmdevice		bpf			#Berkeley packet filter
511f71c01ccSPeter Wemmdevice		disc			#Discard device (ds0, ds1, etc)
5124c12b435SNick Sayerdevice		tap			#Virtual Ethernet driver
513f71c01ccSPeter Wemmdevice		tun			#Tunnel driver (ppp(8), nos-tun(8))
514f71c01ccSPeter Wemmdevice		sl			#Serial Line IP
515f71c01ccSPeter Wemmdevice		ppp	2		#Point-to-point protocol
51689327d27SPeter Wemmoptions 	PPP_BSDCOMP		#PPP BSD-compress support
51789327d27SPeter Wemmoptions 	PPP_DEFLATE		#PPP zlib/deflate/gzip support
5186b5ca0d8SDag-Erling Smørgravoptions 	PPP_FILTER		#enable bpf filtering (needs bpf)
519d29895dcSGarrett Wollman
520f71c01ccSPeter Wemmdevice		ef			# Multiple ethernet frames support
5215d94d71cSBoris Popovoptions 	ETHER_II		# enable Ethernet_II frame
5225d94d71cSBoris Popovoptions 	ETHER_8023		# enable Ethernet_802.3 (Novell) frame
5235d94d71cSBoris Popovoptions 	ETHER_8022		# enable Ethernet_802.2 frame
5245d94d71cSBoris Popovoptions 	ETHER_SNAP		# enable Ethernet_802.2/SNAP frame
5255d94d71cSBoris Popov
526cfa1ca9dSYoshinobu Inoue# for IPv6
527f71c01ccSPeter Wemmdevice		gif	4		#IPv6 and IPv4 tunneling
528f57fc21cSJeroen Ruigrok van der Wervenoptions 	XBONEHACK
529f71c01ccSPeter Wemmdevice		faith	1		#for IPv6 and IPv4 translation
530d5015639SMunechika SUMIKAWAdevice		stf			#6to4 IPv6 over IPv4 encapsulation
531cfa1ca9dSYoshinobu Inoue
5326a8d6623SGarrett Wollman#
5336a8d6623SGarrett Wollman# Internet family options:
5346a8d6623SGarrett Wollman#
5356a8d6623SGarrett Wollman# TCP_COMPAT_42 causes the TCP code to emulate certain bugs present in
5366a8d6623SGarrett Wollman# 4.2BSD.  This option should not be used unless you have a 4.2BSD
5376a8d6623SGarrett Wollman# machine and TCP connections fail.
5386a8d6623SGarrett Wollman#
5396a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
5406a8d6623SGarrett Wollman# with mrouted(8).
5416a8d6623SGarrett Wollman#
542d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
543ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
544ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
545ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
546ab6e02daSJordan K. Hubbard#
547ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
548ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
549a236d14cSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall_type=open
550ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
551ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
552ab6e02daSJordan K. Hubbard# feature works properly.
5538dd4744eSJordan K. Hubbard#
554ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
555ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
556ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
557ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
558ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
559ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
560ffdd472dSPeter Wemm# out of sync.
561d29895dcSGarrett Wollman#
56293e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
56393e0e116SJulian Elischer#
5641b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
5651b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
5661b968362SDag-Erling Smørgrav# from traceroute and similar tools.
5671b968362SDag-Erling Smørgrav#
56865e8111fSBruce Evans# TCPDEBUG is undocumented.
56965e8111fSBruce Evans#
5705895e3c8SPeter Wemmoptions 	TCP_COMPAT_42		#emulate 4.2BSD TCP bugs
571e3178a06SJordan K. Hubbardoptions 	MROUTING		# Multicast routing
572d29895dcSGarrett Wollmanoptions 	IPFIREWALL		#firewall
573d29895dcSGarrett Wollmanoptions 	IPFIREWALL_VERBOSE	#print information about
574d29895dcSGarrett Wollman					# dropped packets
5751857b6feSDag-Erling Smørgravoptions 	IPFIREWALL_FORWARD	#enable transparent proxy support
5765895e3c8SPeter Wemmoptions 	IPFIREWALL_VERBOSE_LIMIT=100	#limit verbosity
577e43a9900SAlexander Langeroptions 	IPFIREWALL_DEFAULT_TO_ACCEPT	#allow everything by default
578210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL		#firewall for IPv6
579210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE
580210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_VERBOSE_LIMIT=100
581210d0432SYoshinobu Inoueoptions 	IPV6FIREWALL_DEFAULT_TO_ACCEPT
58293e0e116SJulian Elischeroptions 	IPDIVERT		#divert sockets
5839cc86ee9SGuido van Rooijoptions 	IPFILTER		#ipfilter support
5849cc86ee9SGuido van Rooijoptions 	IPFILTER_LOG		#ipfilter logging
5858259bcdfSJeroen Ruigrok van der Wervenoptions 	IPFILTER_DEFAULT_BLOCK	#block all packets by default
5861b968362SDag-Erling Smørgravoptions 	IPSTEALTH		#support for stealth forwarding
58765e8111fSBruce Evansoptions 	TCPDEBUG
5886a8d6623SGarrett Wollman
589a79b7128SAlfred Perlstein# Statically Link in accept filters
590a79b7128SAlfred Perlsteinoptions		ACCEPT_FILTER_DATA
591a79b7128SAlfred Perlsteinoptions		ACCEPT_FILTER_HTTP
592a79b7128SAlfred Perlstein
593e46cd3d4SDag-Erling Smørgrav# TCP_DROP_SYNFIN adds support for ignoring TCP packets with SYN+FIN. This
594e46cd3d4SDag-Erling Smørgrav# prevents nmap et al. from identifying the TCP/IP stack, but breaks support
595e46cd3d4SDag-Erling Smørgrav# for RFC1644 extensions and is not recommended for web servers.
596e46cd3d4SDag-Erling Smørgrav#
597e46cd3d4SDag-Erling Smørgravoptions 	TCP_DROP_SYNFIN		#drop TCP packets with SYN+FIN
598e46cd3d4SDag-Erling Smørgrav
59968e9d934SLuigi Rizzo# DUMMYNET enables the "dummynet" bandwidth limiter. You need
60068e9d934SLuigi Rizzo# IPFIREWALL as well. See the dummynet(4) manpage for more info.
60168e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
60268e9d934SLuigi Rizzo# You can use IPFIREWALL and dummynet together with bridging.
60368ec4eb6SLuigi Rizzooptions 	DUMMYNET
60468ec4eb6SLuigi Rizzooptions 	BRIDGE
60568e9d934SLuigi Rizzo
6063f8c4506SPoul-Henning Kamp#
6073f8c4506SPoul-Henning Kamp# ATM (HARP version) options
6083f8c4506SPoul-Henning Kamp#
6093f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
6103f8c4506SPoul-Henning Kamp#	for ATM support.
6113f8c4506SPoul-Henning Kamp#
6123f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
6133f8c4506SPoul-Henning Kamp#
6143f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
6153f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
6163f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
6173f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
6183f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
6193f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
6203f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
6213f8c4506SPoul-Henning Kamp#
6223f8c4506SPoul-Henning Kamp# The `hea' driver provides support for the Efficient Networks, Inc.
6233f8c4506SPoul-Henning Kamp# ENI-155p ATM PCI Adapter.
6243f8c4506SPoul-Henning Kamp#
6253f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
6263f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
6273f8c4506SPoul-Henning Kamp#
6283f8c4506SPoul-Henning Kampoptions 	ATM_CORE		#core ATM protocol family
6293f8c4506SPoul-Henning Kampoptions 	ATM_IP			#IP over ATM support
6303f8c4506SPoul-Henning Kampoptions 	ATM_SIGPVC		#SIGPVC signalling manager
6313f8c4506SPoul-Henning Kampoptions 	ATM_SPANS		#SPANS signalling manager
6323f8c4506SPoul-Henning Kampoptions 	ATM_UNI			#UNI signalling manager
633c9953c3bSPeter Wemmdevice		hea			#Efficient ENI-155p ATM PCI
634c9953c3bSPeter Wemmdevice		hfa			#FORE PCA-200E ATM PCI
6353f8c4506SPoul-Henning Kamp
6366a8d6623SGarrett Wollman
6376a8d6623SGarrett Wollman#####################################################################
6386a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
639e3178a06SJordan K. Hubbard
6402365e64fSRodney W. Grimes#
6416a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
6426a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
643c5b193bfSPoul-Henning Kamp# time.  (Exception: the UFS family---FFS, and MFS --- cannot
6446a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
6456a8d6623SGarrett Wollman# compile other filesystems as well.
6466a8d6623SGarrett Wollman#
647a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
648a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
649a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
650a5b88b01SKATO Takenori# soul to sit down and fix them.
6512365e64fSRodney W. Grimes#
652f1a9c715SDavid Greenman
6536a8d6623SGarrett Wollman# One of these is mandatory:
6546a8d6623SGarrett Wollmanoptions 	FFS			#Fast filesystem
65532a023dcSDavid E. O'Brienoptions 	MFS			#Memory File System
6566a8d6623SGarrett Wollmanoptions 	NFS			#Network File System
6576a8d6623SGarrett Wollman
6586a8d6623SGarrett Wollman# The rest are optional:
6597c115697SPoul-Henning Kamp#options 	NFS_NOSERVER		#Disable the NFS-server code.
6605895e3c8SPeter Wemmoptions 	CD9660			#ISO 9660 filesystem
661f1a9c715SDavid Greenmanoptions 	FDESC			#File descriptor filesystem
6620adb9b96SPeter Wemmoptions 	HPFS			#OS/2 File system
663dba11ce5SAlexander Langeroptions 	MSDOSFS			#MS DOS File System (FAT, FAT32)
6643ee9bf69SEivind Eklundoptions 	NTFS			#NT File System
665f1a9c715SDavid Greenmanoptions 	NULLFS			#NULL filesystem
666e83e2322SBoris Popovoptions 	NWFS			#NetWare filesystem
667f1a9c715SDavid Greenmanoptions 	PORTAL			#Portal filesystem
668f1a9c715SDavid Greenmanoptions 	PROCFS			#Process filesystem
669f1a9c715SDavid Greenmanoptions 	UMAPFS			#UID map filesystem
670f1a9c715SDavid Greenmanoptions 	UNION			#Union filesystem
67146746c3bSJulian Elischeroptions 	DEVFS			#devices filesystem
672bcf77694SPeter Wemm# The xFS_ROOT options REQUIRE the associated ``options xFS''
673bcf77694SPeter Wemmoptions 	NFS_ROOT		#NFS usable as root device
6740b0c10b4SAdrian Chadd# This code enables IFS, an FFS which exports inodes as the namespace.
6750b0c10b4SAdrian Chadd# You can find details in src/sys/ufs/ifs/README .
6760b0c10b4SAdrian Chaddoptions		IFS
677f1a9c715SDavid Greenman
678d0a28bafSAlexander Langer# Soft updates is a technique for improving file system speed and
679d61e6649SAlexander Langer# making abrupt shutdown less risky.
680f8f8d7afSEivind Eklund#
6813d5c4fdcSPoul-Henning Kampoptions 	SOFTUPDATES
682b1897c19SJulian Elischer
683a64ed089SRobert Watson# Extended attributes allow additional data to be associated with files,
684a64ed089SRobert Watson# and is used for ACLs, Capabilities, and MAC labels
685a64ed089SRobert Watson#
68649993db0SRobert Watsonoptions		UFS_EXTATTR
68749993db0SRobert Watsonoptions		UFS_EXTATTR_AUTOSTART
688a64ed089SRobert Watson
68971e4fff8SPoul-Henning Kamp# Make space in the kernel for a root filesystem on a md device.
69071e4fff8SPoul-Henning Kamp# Define to the number of kilobytes to reserve for the filesystem.
69171e4fff8SPoul-Henning Kampoptions 	MD_ROOT_SIZE=10
69271e4fff8SPoul-Henning Kamp
69371e4fff8SPoul-Henning Kamp# Make the md device a potential root device, either with preloaded
69471e4fff8SPoul-Henning Kamp# images of type mfs_root or md_root.
69571e4fff8SPoul-Henning Kampoptions 	MD_ROOT
696d52d7365SPoul-Henning Kamp
697a401ebbeSDavid Greenman# Allow this many swap-devices.
6988f7939aeSMatthew Dillon#
6998f7939aeSMatthew Dillon# In order to manage swap, the system must reserve bitmap space that
7008f7939aeSMatthew Dillon# scales with the largest mounted swap device multiplied by NSWAPDEV,
7018f7939aeSMatthew Dillon# irregardless of whether other swap devices exist or not.  So it
7028f7939aeSMatthew Dillon# is not a good idea to make this value too large.
7032727da4cSDag-Erling Smørgravoptions 	NSWAPDEV=5
704a401ebbeSDavid Greenman
705495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
7062365e64fSRodney W. Grimesoptions 	QUOTA			#enable disk quotas
7076a8d6623SGarrett Wollman
708276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
709276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
710276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
711276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
712ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
7136110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
714276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
715276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
716276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
717276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
718276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
719276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
720cb800e34SJulian Elischer#
721cb800e34SJulian Elischeroptions 	SUIDDIR
722cb800e34SJulian Elischer
723df394affSJohn-Mark Gurney# NFS options:
7245895e3c8SPeter Wemmoptions 	NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
7255895e3c8SPeter Wemmoptions 	NFS_MAXATTRTIMO=60
7265895e3c8SPeter Wemmoptions 	NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
7275895e3c8SPeter Wemmoptions 	NFS_MAXDIRATTRTIMO=60
7285895e3c8SPeter Wemmoptions 	NFS_GATHERDELAY=10	# Default write gather delay (msec)
7295895e3c8SPeter Wemmoptions 	NFS_UIDHASHSIZ=29	# Tune the size of nfssvc_sock with this
7305895e3c8SPeter Wemmoptions 	NFS_WDELAYHASHSIZ=16	# and with this
7315895e3c8SPeter Wemmoptions 	NFS_MUIDHASHSIZ=63	# Tune the size of nfsmount with this
732df394affSJohn-Mark Gurneyoptions 	NFS_DEBUG		# Enable NFS Debugging
733df394affSJohn-Mark Gurney
7349afcea2fSRobert V. Baron# Coda stuff:
7359afcea2fSRobert V. Baronoptions 	CODA			#CODA filesystem.
736f71c01ccSPeter Wemmdevice		vcoda	4		#coda minicache <-> venus comm.
737a1d55890SJordan K. Hubbard
738053a2b61SEivind Eklund#
739053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
740053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
741053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
742053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
743053a2b61SEivind Eklund#
7445895e3c8SPeter Wemmoptions 	EXT2FS
745053a2b61SEivind Eklund
746dd85920aSJason Evans# Use real implementations of the aio_* system calls.  There are numerous
747dd85920aSJason Evans# stability issues in the current aio code that make it unsuitable for
748dd85920aSJason Evans# inclusion on shell boxes.
749dd85920aSJason Evansoptions 	VFS_AIO
750053a2b61SEivind Eklund
751c16dc61bSEivind Eklund# Enable the code UFS IO optimization through the VM system.  This allows
752c16dc61bSEivind Eklund# use VM operations instead of copying operations when possible.
753c16dc61bSEivind Eklund#
754c16dc61bSEivind Eklund# Even with this enabled, actual use of the code is still controlled by the
755c16dc61bSEivind Eklund# sysctl vfs.ioopt.  0 gives no optimization, 1 gives normal (use VM
756c16dc61bSEivind Eklund# operations if a request happens to fit), 2 gives agressive optimization
757c16dc61bSEivind Eklund# (the operations are split to do as much as possible through the VM system.)
758c16dc61bSEivind Eklund#
759c16dc61bSEivind Eklund# Enabling this will probably not give an overall speedup except for
760c16dc61bSEivind Eklund# special workloads.
761c16dc61bSEivind Eklundoptions 	ENABLE_VFS_IOOPT
762c16dc61bSEivind Eklund
76315bbdecfSMark Murray# Cryptographically secure random number generator; /dev/[u]random
764ac519db0SMark Murraydevice		random
76515bbdecfSMark Murray
7666a8d6623SGarrett Wollman
7676a8d6623SGarrett Wollman#####################################################################
768abc97a06SBruce Evans# POSIX P1003.1B
769abc97a06SBruce Evans
770ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
771abc97a06SBruce Evans# P1003_1B: Infrastructure
772abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
773abc97a06SBruce Evans# _KPOSIX_VERSION:             Version kernel is built for
774abc97a06SBruce Evans
7755895e3c8SPeter Wemmoptions 	P1003_1B
7765895e3c8SPeter Wemmoptions 	_KPOSIX_PRIORITY_SCHEDULING
7775895e3c8SPeter Wemmoptions 	_KPOSIX_VERSION=199309L
778abc97a06SBruce Evans
779abc97a06SBruce Evans
780abc97a06SBruce Evans#####################################################################
781000033d0SJeroen Ruigrok van der Werven# CLOCK OPTIONS
782000033d0SJeroen Ruigrok van der Werven
783000033d0SJeroen Ruigrok van der Werven# The granularity of operation is controlled by the kernel option HZ whose
784000033d0SJeroen Ruigrok van der Werven# default value (100) means a granularity of 10ms.  For an accurate simulation
785000033d0SJeroen Ruigrok van der Werven# of high data rates it might be necessary to reduce the timer granularity to
786000033d0SJeroen Ruigrok van der Werven# 1ms or less.  Consider, however, that some interfaces using programmed I/O
787000033d0SJeroen Ruigrok van der Werven# may require a considerable time to output packets.  So, reducing the
788000033d0SJeroen Ruigrok van der Werven# granularity too much might actually cause ticks to be missed thus reducing
789000033d0SJeroen Ruigrok van der Werven# the accuracy of operation.
790000033d0SJeroen Ruigrok van der Werven
791000033d0SJeroen Ruigrok van der Wervenoptions 	HZ=100
792000033d0SJeroen Ruigrok van der Werven
793000033d0SJeroen Ruigrok van der Werven# Other clock options
794000033d0SJeroen Ruigrok van der Werven
795000033d0SJeroen Ruigrok van der Wervenoptions 	CLK_CALIBRATION_LOOP
796000033d0SJeroen Ruigrok van der Wervenoptions 	CLK_USE_I8254_CALIBRATION
797000033d0SJeroen Ruigrok van der Wervenoptions 	CLK_USE_TSC_CALIBRATION
798000033d0SJeroen Ruigrok van der Werven
799000033d0SJeroen Ruigrok van der Werven
800000033d0SJeroen Ruigrok van der Werven#####################################################################
801de6a307eSPeter Dufault# SCSI DEVICES
802de6a307eSPeter Dufault
8036a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
8046a8d6623SGarrett Wollman
8056a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
806ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
8076a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
8086a8d6623SGarrett Wollman# device configuration sections below.
8096a8d6623SGarrett Wollman#
810265368d4SRodney W. Grimes# Beginning with FreeBSD 2.0.5 you can wire down your SCSI devices so
811ebc1a0e2SPeter Dufault# that a given bus, target, and LUN always come on line as the same
812ebc1a0e2SPeter Dufault# device unit.  In earlier versions the unit numbers were assigned
813ebc1a0e2SPeter Dufault# in the order that the devices were probed on the SCSI bus.  This
814ebc1a0e2SPeter Dufault# means that if you removed a disk drive, you may have had to rewrite
815ebc1a0e2SPeter Dufault# your /etc/fstab file, and also that you had to be careful when adding
816ebc1a0e2SPeter Dufault# a new disk as it may have been probed earlier and moved your device
817ebc1a0e2SPeter Dufault# configuration around.
818ebc1a0e2SPeter Dufault
819ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
820ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
821700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
822700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
823ebc1a0e2SPeter Dufault
824ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
825ebc1a0e2SPeter Dufault
826f71c01ccSPeter Wemmhint.scbus.0.at="ahc0"
827f71c01ccSPeter Wemmhint.scbus.1.at="ahc1"
828f71c01ccSPeter Wemmhint.scbus.1.bus="0"
829f71c01ccSPeter Wemmhint.scbus.3.at="ahc2"
830f71c01ccSPeter Wemmhint.scbus.3.bus="0"
831f71c01ccSPeter Wemmhint.scbus.2.at="ahc2"
832f71c01ccSPeter Wemmhint.scbus.2.bus="1"
833f71c01ccSPeter Wemmhint.da.0.at="scbus0"
834f71c01ccSPeter Wemmhint.da.0.target="0"
835f71c01ccSPeter Wemmhint.da.0.unit="0"
836f71c01ccSPeter Wemmhint.da.1.at="scbus3"
837f71c01ccSPeter Wemmhint.da.1.target="1"
838f71c01ccSPeter Wemmhint.da.2.at="scbus2"
839f71c01ccSPeter Wemmhint.da.2.target="3"
840f71c01ccSPeter Wemmhint.sa.1.at="scbus1"
841f71c01ccSPeter Wemmhint.sa.1.target="6"
842ebc1a0e2SPeter Dufault
843ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
844ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
845ebc1a0e2SPeter Dufault
846ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
847ebc1a0e2SPeter Dufault
848cf2458c9SMatt Jacob# The ch driver drives SCSI Media Changer ("jukebox") devices.
849cf2458c9SMatt Jacob#
850cf2458c9SMatt Jacob# The da driver drives SCSI Direct Access ("disk") and Optical Media
851cf2458c9SMatt Jacob# ("WORM") devices.
852cf2458c9SMatt Jacob#
853cf2458c9SMatt Jacob# The sa driver drives SCSI Sequential Access ("tape") devices.
854cf2458c9SMatt Jacob#
855cf2458c9SMatt Jacob# The cd driver drives SCSI Read Only Direct Access ("cd") devices.
856cf2458c9SMatt Jacob#
857cf2458c9SMatt Jacob# The ses driver drives SCSI Envinronment Services ("ses") and
858cf2458c9SMatt Jacob# SAF-TE ("SCSI Accessable Fault-Tolerant Enclosure") devices.
859cf2458c9SMatt Jacob#
860cf2458c9SMatt Jacob# The pt driver drives SCSI Processor devices.
861cf2458c9SMatt Jacob#
862cf2458c9SMatt Jacob#
863cf2458c9SMatt Jacob# Target Mode support is provided here but also requires that a SIM
864cf2458c9SMatt Jacob# (SCSI Host Adapter Driver) provide support as well.
865cf2458c9SMatt Jacob#
866cf2458c9SMatt Jacob# The targ driver provides target mode support as a Processor type device.
867cf2458c9SMatt Jacob# It exists to give the minimal context necessary to respond to Inquiry
868cf2458c9SMatt Jacob# commands. There is a sample user application that shows how the rest
869cf2458c9SMatt Jacob# of the command support might be done in /usr/share/examples/scsi_target.
870cf2458c9SMatt Jacob#
871cf2458c9SMatt Jacob# The targbh driver provides target mode support and exists to respond
872cf2458c9SMatt Jacob# to incoming commands that do not otherwise have a logical unit assigned
873cf2458c9SMatt Jacob# to them.
874cf2458c9SMatt Jacob#
875265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
876cf2458c9SMatt Jacob# configuration as the "pass" driver.
877ebc1a0e2SPeter Dufault
878c9953c3bSPeter Wemmdevice		scbus		#base SCSI code
879c9953c3bSPeter Wemmdevice		ch		#SCSI media changers
880c9953c3bSPeter Wemmdevice		da		#SCSI direct access devices (aka disks)
881c9953c3bSPeter Wemmdevice		sa		#SCSI tapes
882c9953c3bSPeter Wemmdevice		cd		#SCSI CD-ROMs
88364ed91d5SMatt Jacobdevice		ses		#SCSI Environmental Services (and SAF-TE)
884cf2458c9SMatt Jacobdevice		pt		#SCSI processor
88564ed91d5SMatt Jacobdevice		targ		#SCSI Target Mode Code
88664ed91d5SMatt Jacobdevice		targbh		#SCSI Target Mode Blackhole Device
887cf2458c9SMatt Jacobdevice		pass		#CAM passthrough driver
8888909a72bSPeter Dufault
889700daf5eSJustin T. Gibbs# CAM OPTIONS:
890700daf5eSJustin T. Gibbs# debugging options:
891700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
892700daf5eSJustin T. Gibbs#             specify them all!
893700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
894700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
895700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
896700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
897d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
898d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
899700daf5eSJustin T. Gibbs#
900700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
901700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
902700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
90356234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
90456234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
90556234437SKenneth D. Merry#             freeze the device queue after a bus device reset.
906700daf5eSJustin T. Gibbsoptions 	CAMDEBUG
9075895e3c8SPeter Wemmoptions 	CAM_DEBUG_BUS=-1
9085895e3c8SPeter Wemmoptions 	CAM_DEBUG_TARGET=-1
9095895e3c8SPeter Wemmoptions 	CAM_DEBUG_LUN=-1
9105895e3c8SPeter Wemmoptions 	CAM_DEBUG_FLAGS="CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB"
9115895e3c8SPeter Wemmoptions 	CAM_MAX_HIGHPOWER=4
912700daf5eSJustin T. Gibbsoptions 	SCSI_NO_SENSE_STRINGS
913700daf5eSJustin T. Gibbsoptions 	SCSI_NO_OP_STRINGS
91456234437SKenneth D. Merryoptions 	SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
9151a7c583cSGarrett Wollman
916700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
917700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
918700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
919700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
920700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
921700daf5eSJustin T. Gibbs# respectively.
92293063432SJoerg Wunsch#
923700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
924700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
925700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
92693063432SJoerg Wunsch#
9275895e3c8SPeter Wemmoptions 	CHANGER_MIN_BUSY_SECONDS=2
9285895e3c8SPeter Wemmoptions 	CHANGER_MAX_BUSY_SECONDS=10
92993063432SJoerg Wunsch
9309dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
9319dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
9329dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
9339dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
9349f050ed5SMatt Jacob# SA_1FM_AT_EOD: Default to model which only has a default one filemark at EOT.
9355895e3c8SPeter Wemmoptions 	SA_SPACE_TIMEOUT="(60)"
9365895e3c8SPeter Wemmoptions 	SA_REWIND_TIMEOUT="(2*60)"
9375895e3c8SPeter Wemmoptions 	SA_ERASE_TIMEOUT="(4*60)"
9389f050ed5SMatt Jacoboptions 	SA_1FM_AT_EOD
9399dfb4471SKenneth D. Merry
9403ece1bd2SKenneth D. Merry# Optional timeout for the CAM processor target (pt) device
9413ece1bd2SKenneth D. Merry# This is specified in seconds.  The default is 60 seconds.
9423ece1bd2SKenneth D. Merryoptions 	SCSI_PT_DEFAULT_TIMEOUT="60"
9433ece1bd2SKenneth D. Merry
9448904e70bSMatt Jacob# Optional enable of doing SES passthrough on other devices (e.g., disks)
9458904e70bSMatt Jacob#
9468904e70bSMatt Jacob# Normally disabled because a lot of newer SCSI disks report themselves
9478904e70bSMatt Jacob# as having SES capabilities, but this can then clot up attempts to build
9488904e70bSMatt Jacob# build a topology with the SES device that's on the box these drives
9498904e70bSMatt Jacob# are in....
9508904e70bSMatt Jacoboptions		SES_ENABLE_PASSTHROUGH
9518904e70bSMatt Jacob
9526a8d6623SGarrett Wollman
9536a8d6623SGarrett Wollman#####################################################################
9546a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
9556a8d6623SGarrett Wollman
9561160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
9571160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
9581160da92SJoerg Wunsch# `xterm', among others.
9591160da92SJoerg Wunsch
960f71c01ccSPeter Wemmdevice		pty		#Pseudo ttys
961f71c01ccSPeter Wemmdevice		speaker		#Play IBM BASIC-style noises out your speaker
962f71c01ccSPeter Wemmdevice		gzip		#Exec gzipped a.out's
963f71c01ccSPeter Wemmdevice		md		#Memory/malloc disk
964f71c01ccSPeter Wemmdevice		snp		#Snoop device - to look at pty/vty/etc..
965f71c01ccSPeter Wemmdevice		ccd	4	#Concatenated disk driver
966be174c7eSGreg Lehey
967be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
968be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
969be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
9704cc4752cSGreg Lehey#
9714cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
97298a44096SSheldon Hearn# in src/sbin/vinum/Makefile.  Failure to do so will result in
9734cc4752cSGreg Lehey# the following message from vinum(8):
9744cc4752cSGreg Lehey#
9754cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
9764cc4752cSGreg Lehey#
9774cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
978f71c01ccSPeter Wemmdevice		vinum		#Vinum concat/mirror/raid driver
9793ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
9809ba0e7c3SBruce Evans
98158067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
9825895e3c8SPeter Wemmoptions 	MSGBUF_SIZE=40960
98358067a99SPoul-Henning Kamp
9846a8d6623SGarrett Wollman
9856a8d6623SGarrett Wollman#####################################################################
986d61e6649SAlexander Langer# HARDWARE BUS CONFIGURATION
9876a8d6623SGarrett Wollman
988d61e6649SAlexander Langer# ISA, EISA, MCA and PCI bus:
9896a8d6623SGarrett Wollman
9906a8d6623SGarrett Wollman#
99116e164e3SBruce Evans# Mandatory ISA devices: isa, npx
9926a8d6623SGarrett Wollman#
993c9953c3bSPeter Wemmdevice		isa
9942365e64fSRodney W. Grimes
9956a8d6623SGarrett Wollman#
9966a8d6623SGarrett Wollman# Options for `isa':
9976a8d6623SGarrett Wollman#
998d72ee36fSBruce Evans# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
999d72ee36fSBruce Evans# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
1000d72ee36fSBruce Evans# This option breaks suspend/resume on some portables.
1001d72ee36fSBruce Evans#
10029ba0e7c3SBruce Evans# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
1003d72ee36fSBruce Evans# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
10049ba0e7c3SBruce Evans# Automatic EOI is documented not to work for for the slave with the
10059ba0e7c3SBruce Evans# original i8259A, but it works for some clones and some integrated
10069ba0e7c3SBruce Evans# versions.
10079ba0e7c3SBruce Evans#
1008b2796687SNate Williams# MAXMEM specifies the amount of RAM on the machine; if this is not
10099bc192deSDavid E. O'Brien# specified, FreeBSD will first read the amount of memory from the CMOS
10109bc192deSDavid E. O'Brien# RAM, so the amount of memory will initially be limited to 64MB or 16MB
10119bc192deSDavid E. O'Brien# depending on the BIOS.  If the BIOS reports 64MB, a memory probe will
10129bc192deSDavid E. O'Brien# then attempt to detect the installed amount of RAM.  If this probe
10139bc192deSDavid E. O'Brien# fails to detect >64MB RAM you will have to use the MAXMEM option.
10149bc192deSDavid E. O'Brien# The amount is in kilobytes, so for a machine with 128MB of RAM, it would
10159bc192deSDavid E. O'Brien# be 131072 (128 * 1024).
1016b2796687SNate Williams#
10175eb46edfSDavid Greenman# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
10185eb46edfSDavid Greenman# reset the CPU for reboot.  This is needed on some systems with broken
10195eb46edfSDavid Greenman# keyboard controllers.
102077959e8eSMarc G. Fournier
10219ac61e92SPeter Wemmoptions 	COMPAT_OLDISA	#Use ISA shims and glue for old drivers
1022f71c01ccSPeter Wemmoptions 	AUTO_EOI_1
102319dde963SPeter Wemm#options 	AUTO_EOI_2
1024f71c01ccSPeter Wemm
1025f71c01ccSPeter Wemmoptions 	MAXMEM="(128*1024)"
102619dde963SPeter Wemm#options 	BROKEN_KEYBOARD_RESET
10273af6b652SDavid Greenman
1028595f6341SPoul-Henning Kamp# Enable support for the kernel PLL to use an external PPS signal,
1029595f6341SPoul-Henning Kamp# under supervision of [x]ntpd(8)
1030a2210fe1SPoul-Henning Kamp# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
1031595f6341SPoul-Henning Kamp
1032595f6341SPoul-Henning Kampoptions 	PPS_SYNC
1033595f6341SPoul-Henning Kamp
1034c2906d55SPoul-Henning Kamp# If you see the "calcru: negative time of %ld usec for pid %d (%s)\n"
1035c2906d55SPoul-Henning Kamp# message you probably have some broken sw/hw which disables interrupts
1036c2906d55SPoul-Henning Kamp# for too long.  You can make the system more resistant to this by
1037c2906d55SPoul-Henning Kamp# choosing a high value for NTIMECOUNTER.  The default is 5, there
1038c2906d55SPoul-Henning Kamp# is no upper limit but more than a couple of hundred are not productive.
1039a2210fe1SPoul-Henning Kamp# A better strategy may be to sysctl -w kern.timecounter.method=1
1040c2906d55SPoul-Henning Kamp
10415895e3c8SPeter Wemmoptions 	NTIMECOUNTER=20
1042c2906d55SPoul-Henning Kamp
1043d61e6649SAlexander Langer#
1044d61e6649SAlexander Langer# EISA bus
1045d61e6649SAlexander Langer#
1046d61e6649SAlexander Langer# The EISA bus device is `eisa'.  It provides auto-detection and
1047d61e6649SAlexander Langer# configuration support for all devices on the EISA bus.
1048d61e6649SAlexander Langer
1049d61e6649SAlexander Langerdevice		eisa
1050d61e6649SAlexander Langer
1051d61e6649SAlexander Langer# By default, only 10 EISA slots are probed, since the slot numbers
1052d61e6649SAlexander Langer# above clash with the configuration address space of the PCI subsystem,
1053d61e6649SAlexander Langer# and the EISA probe is not very smart about this.  This is sufficient
1054d61e6649SAlexander Langer# for most machines, but in particular the HP NetServer LC series comes
1055d61e6649SAlexander Langer# with an onboard AIC7770 dual-channel SCSI controller on EISA slot #11,
1056d61e6649SAlexander Langer# thus you need to bump this figure to 12 for them.
1057d61e6649SAlexander Langeroptions 	EISA_SLOTS=12
1058d61e6649SAlexander Langer
1059d61e6649SAlexander Langer#
1060d61e6649SAlexander Langer# MCA bus:
1061d61e6649SAlexander Langer#
1062d61e6649SAlexander Langer# The MCA bus device is `mca'.  It provides auto-detection and
1063d61e6649SAlexander Langer# configuration support for all devices on the MCA bus.
1064d61e6649SAlexander Langer# No hints are required for MCA.
1065d61e6649SAlexander Langer
1066d61e6649SAlexander Langerdevice		mca
1067d61e6649SAlexander Langer
1068d61e6649SAlexander Langer#
1069d61e6649SAlexander Langer# PCI bus & PCI options:
1070d61e6649SAlexander Langer#
1071d61e6649SAlexander Langer# The main PCI bus device is `pci'.  It provides auto-detection and
1072d61e6649SAlexander Langer# configuration support for all devices on the PCI bus, using either
1073d61e6649SAlexander Langer# configuration mode defined in the PCI specification.
1074d61e6649SAlexander Langer
1075d61e6649SAlexander Langerdevice		pci
1076d61e6649SAlexander Langer
1077a7ecc804SPeter Wemm#
1078a7ecc804SPeter Wemm# AGP GART support
1079a7ecc804SPeter Wemmdevice		agp
1080a7ecc804SPeter Wemm
1081d61e6649SAlexander Langer# PCI options
1082d61e6649SAlexander Langer#
1083d61e6649SAlexander Langer#options 	PCI_QUIET	#quiets PCI code on chipset settings
1084d61e6649SAlexander Langer
1085d61e6649SAlexander Langer
1086d61e6649SAlexander Langer#####################################################################
1087d61e6649SAlexander Langer# HARDWARE DEVICE CONFIGURATION
1088d61e6649SAlexander Langer
1089d61e6649SAlexander Langer# EISA support is available for some device, so they can be auto-probed.
1090d61e6649SAlexander Langer# MicroChannel (MCA) support is available for some devices.
1091d61e6649SAlexander Langer# For ISA the required hints are listed.
1092d61e6649SAlexander Langer# EISA, MCA, PCI and pccard are self identifying buses, so no hints
1093d61e6649SAlexander Langer# are needed.
1094d61e6649SAlexander Langer
1095d61e6649SAlexander Langer#
1096d61e6649SAlexander Langer# Mandatory devices:
1097d61e6649SAlexander Langer#
1098d61e6649SAlexander Langer
109923f7bd17SBrian Somers# The keyboard controller; it controls the keyboard and the PS/2 mouse.
1100f71c01ccSPeter Wemmdevice		atkbdc	1
1101f71c01ccSPeter Wemmhint.atkbdc.0.at="isa"
1102f71c01ccSPeter Wemmhint.atkbdc.0.port="0x060"
11032ad872c5SKazutaka YOKOTA
11042ad872c5SKazutaka YOKOTA# The AT keyboard
1105f71c01ccSPeter Wemmdevice		atkbd
1106f71c01ccSPeter Wemmhint.atkbd.0.at="atkbdc"
1107f71c01ccSPeter Wemmhint.atkbd.0.irq="1"
11082ad872c5SKazutaka YOKOTA
11090a0319c2SKazutaka YOKOTA# Options for atkbd:
11100a0319c2SKazutaka YOKOTAoptions 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
11110a0319c2SKazutaka YOKOTAmakeoptions	ATKBD_DFLT_KEYMAP="jp.106"
11120a0319c2SKazutaka YOKOTA
11130a0319c2SKazutaka YOKOTA# These options are valid for other keyboard drivers as well.
11140a0319c2SKazutaka YOKOTAoptions 	KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
11150a0319c2SKazutaka YOKOTAoptions 	KBD_INSTALL_CDEV	# install a CDEV entry in /dev
11160a0319c2SKazutaka YOKOTA
1117e1b5fc4cSKazutaka YOKOTA# `flags' for atkbd:
1118e1b5fc4cSKazutaka YOKOTA#       0x01    Force detection of keyboard, else we always assume a keyboard
1119e1b5fc4cSKazutaka YOKOTA#       0x02    Don't reset keyboard, useful for some newer ThinkPads
1120e1b5fc4cSKazutaka YOKOTA#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
1121e1b5fc4cSKazutaka YOKOTA
11222ad872c5SKazutaka YOKOTA# PS/2 mouse
1123f71c01ccSPeter Wemmdevice		psm
1124f71c01ccSPeter Wemmhint.psm.0.at="atkbdc"
1125f71c01ccSPeter Wemmhint.psm.0.irq="12"
11262ad872c5SKazutaka YOKOTA
11272ad872c5SKazutaka YOKOTA# Options for psm:
1128273157daSKazutaka YOKOTAoptions 	PSM_HOOKRESUME		#hook the system resume event, useful
11292ad872c5SKazutaka YOKOTA					#for some laptops
11302ad872c5SKazutaka YOKOTAoptions 	PSM_RESETAFTERSUSPEND	#reset the device at the resume event
11312ad872c5SKazutaka YOKOTA
11322ad872c5SKazutaka YOKOTA# The video card driver.
1133f71c01ccSPeter Wemmdevice		vga
1134f71c01ccSPeter Wemmhint.vga.0.at="isa"
11352ad872c5SKazutaka YOKOTA
1136c619f2acSKazutaka YOKOTA# Options for vga:
1137c619f2acSKazutaka YOKOTA# Try the following option if the mouse pointer is not drawn correctly
1138c619f2acSKazutaka YOKOTA# or font does not seem to be loaded properly.  May cause flicker on
1139c619f2acSKazutaka YOKOTA# some systems.
1140c619f2acSKazutaka YOKOTAoptions 	VGA_ALT_SEQACCESS
1141c619f2acSKazutaka YOKOTA
1142c619f2acSKazutaka YOKOTA# If you can dispense with some vga driver features, you may want to
1143c619f2acSKazutaka YOKOTA# use the following options to save some memory.
11441b1728adSPoul-Henning Kamp#options 	VGA_NO_FONT_LOADING	# don't save/load font
11451b1728adSPoul-Henning Kamp#options 	VGA_NO_MODE_CHANGE	# don't change video modes
1146c619f2acSKazutaka YOKOTA
1147c619f2acSKazutaka YOKOTA# Older video cards may require this option for proper operation.
1148c619f2acSKazutaka YOKOTAoptions 	VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
1149c619f2acSKazutaka YOKOTA
11506e8394b8SKazutaka YOKOTA# The following option probably won't work with the LCD displays.
11516e8394b8SKazutaka YOKOTAoptions 	VGA_WIDTH90		# support 90 column modes
11526e8394b8SKazutaka YOKOTA
11530a0319c2SKazutaka YOKOTA# To include support for VESA video modes
115477835954SJonathan Lemonoptions 	VESA
11550a0319c2SKazutaka YOKOTA
1156edd5302dSJeroen Ruigrok van der Wervenoptions 	FB_DEBUG		# Frame buffer debugging
1157edd5302dSJeroen Ruigrok van der Wervenoptions 	FB_INSTALL_CDEV		# install a CDEV entry in /dev
1158edd5302dSJeroen Ruigrok van der Werven
11592ad872c5SKazutaka YOKOTA# Splash screen at start up!  Screen savers require this too.
1160f71c01ccSPeter Wemmdevice		splash
11612ad872c5SKazutaka YOKOTA
1162c19da41eSPeter Wemm# The pcvt console driver (vt220 compatible).
1163f71c01ccSPeter Wemmdevice		vt
1164f71c01ccSPeter Wemmhint.vt.0.at="isa"
1165528b8853SKazutaka YOKOTAoptions 	XSERVER			# support for running an X server on vt
1166c19da41eSPeter Wemmoptions 	FAT_CURSOR		# start with block cursor
1167c19da41eSPeter Wemm# This PCVT option is for keyboards such as those used on IBM ThinkPad laptops
1168c19da41eSPeter Wemmoptions 	PCVT_SCANSET=2 		# IBM keyboards are non-std
1169a467384bSJoerg Wunsch# Other PCVT options are documented in pcvt(4).
11705895e3c8SPeter Wemmoptions 	PCVT_24LINESDEF
1171a467384bSJoerg Wunschoptions 	PCVT_CTRL_ALT_DEL
1172a467384bSJoerg Wunschoptions 	PCVT_META_ESC
1173a467384bSJoerg Wunschoptions 	PCVT_NSCREENS=9
1174a467384bSJoerg Wunschoptions 	PCVT_PRETTYSCRNS
1175a467384bSJoerg Wunschoptions 	PCVT_SCREENSAVER
1176a467384bSJoerg Wunschoptions 	PCVT_USEKBDSEC
11775895e3c8SPeter Wemmoptions 	PCVT_VT220KEYB
1178a06da083SHellmuth Michaelisoptions 	PCVT_GREENSAVER
1179c19da41eSPeter Wemm
1180ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
1181f71c01ccSPeter Wemmdevice		sc	1
1182f71c01ccSPeter Wemmhint.sc.0.at="isa"
1183683cbdf4SBruce Evansoptions 	MAXCONS=16		# number of virtual consoles
11846e8394b8SKazutaka YOKOTAoptions 	SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
11856e8394b8SKazutaka YOKOTAoptions 	SC_DFLT_FONT		# compile font in
1186cc6c2ad0SPeter Wemmmakeoptions	SC_DFLT_FONT=cp850
11876e8394b8SKazutaka YOKOTAoptions 	SC_DISABLE_DDBKEY	# disable `debug' key
1188c4118fc0SKazutaka YOKOTAoptions 	SC_DISABLE_REBOOT	# disable reboot key sequence
11896e8394b8SKazutaka YOKOTAoptions 	SC_HISTORY_SIZE=200	# number of history buffer lines
11906e8394b8SKazutaka YOKOTAoptions 	SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
11916e8394b8SKazutaka YOKOTAoptions 	SC_PIXEL_MODE		# add support for the raster text mode
119285e36760SJordan K. Hubbard
11937a88382dSKazutaka YOKOTA# The following options will let you change the default colors of syscons.
11947a88382dSKazutaka YOKOTAoptions 	SC_NORM_ATTR="(FG_GREEN|BG_BLACK)"
11957a88382dSKazutaka YOKOTAoptions 	SC_NORM_REV_ATTR="(FG_YELLOW|BG_GREEN)"
11967a88382dSKazutaka YOKOTAoptions 	SC_KERNEL_CONS_ATTR="(FG_RED|BG_BLACK)"
11977a88382dSKazutaka YOKOTAoptions 	SC_KERNEL_CONS_REV_ATTR="(FG_BLACK|BG_RED)"
11987a88382dSKazutaka YOKOTA
11997a88382dSKazutaka YOKOTA# If you have a two button mouse, you may want to add the following option
12007a88382dSKazutaka YOKOTA# to use the right button of the mouse to paste text.
12017a88382dSKazutaka YOKOTAoptions 	SC_TWOBUTTON_MOUSE
12027a88382dSKazutaka YOKOTA
12036e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
12046e8394b8SKazutaka YOKOTAoptions 	SC_NO_CUTPASTE
12056e8394b8SKazutaka YOKOTAoptions 	SC_NO_FONT_LOADING
12066e8394b8SKazutaka YOKOTAoptions 	SC_NO_HISTORY
12076e8394b8SKazutaka YOKOTAoptions 	SC_NO_SYSMOUSE
12082ac8be82SAndreas Schulz
12098a28ce0eSJohn Baldwin# `flags' for sc
12108a28ce0eSJohn Baldwin#	0x80	Put the video card in the VESA 800x600 dots, 16 color mode
12118a28ce0eSJohn Baldwin#	0x100	Probe for a keyboard device periodically if one is not present
12128a28ce0eSJohn Baldwin
12137670e012SColeman Kane# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support. This will create
12147670e012SColeman Kane# the /dev/3dfx0 device to work with glide implementations. This should get
12157670e012SColeman Kane# linked to /dev/3dfx and /dev/voodoo. Note that this is not the same as
12167670e012SColeman Kane# the tdfx DRI module from XFree86 and is completely unrelated.
12177670e012SColeman Kane#
12187670e012SColeman Kane# To enable Linuxulator support, one must also include COMPAT_LINUX in the
12197670e012SColeman Kane# config as well, or you will not have the dependencies. The other option
12207670e012SColeman Kane# is to load both as modules.
12217670e012SColeman Kane
1222899266e3SJeroen Ruigrok van der Wervendevice 		tdfx			# Enable 3Dfx Voodoo support
1223899266e3SJeroen Ruigrok van der Wervenoptions 	TDFX_LINUX		# Enable Linuxulator support
1224899266e3SJeroen Ruigrok van der Werven
12256a8d6623SGarrett Wollman#
1226a7674320SMartin Cracauer# The Numeric Processing eXtension driver.  In addition to this, you
1227a7674320SMartin Cracauer# may configure a math emulator (see above).  If your machine has a
1228a7674320SMartin Cracauer# hardware FPU and the kernel configuration includes the npx device
1229a7674320SMartin Cracauer# *and* a math emulator compiled into the kernel, the hardware FPU
1230a7674320SMartin Cracauer# will be used, unless it is found to be broken or unless "flags" to
1231a7674320SMartin Cracauer# npx0 includes "0x08", which requests preference for the emulator.
1232f71c01ccSPeter Wemmdevice		npx
1233f71c01ccSPeter Wemmhint.npx.0.at="nexus"
1234f71c01ccSPeter Wemmhint.npx.0.port="0x0F0"
1235f71c01ccSPeter Wemmhint.npx.0.flags="0x0"
1236f71c01ccSPeter Wemmhint.npx.0.irq="13"
12371fe04850SBruce Evans
123898e9e66cSNate Williams#
12391fe04850SBruce Evans# `flags' for npx0:
1240a7674320SMartin Cracauer#	0x01	don't use the npx registers to optimize bcopy.
1241a7674320SMartin Cracauer#	0x02	don't use the npx registers to optimize bzero.
12421fe04850SBruce Evans#	0x04	don't use the npx registers to optimize copyin or copyout.
1243a7674320SMartin Cracauer#	0x08	use emulator even if hardware FPU is available.
12441fe04850SBruce Evans# The npx registers are normally used to optimize copying and zeroing when
12451fe04850SBruce Evans# all of the following conditions are satisfied:
12465895e3c8SPeter Wemm#	I586_CPU is an option
12471fe04850SBruce Evans#	the cpu is an i586 (perhaps not a Pentium)
12481fe04850SBruce Evans#	the probe for npx0 succeeds
12491fe04850SBruce Evans#	INT 16 exception handling works.
12501fe04850SBruce Evans# Then copying and zeroing using the npx registers is normally 30-100% faster.
12511fe04850SBruce Evans# The flags can be used to control cases where it doesn't work or is slower.
12521fe04850SBruce Evans# Setting them at boot time using userconfig works right (the optimizations
12531fe04850SBruce Evans# are not used until later in the bootstrap when npx0 is attached).
1254784648c6SMartin Cracauer# Flag 0x08 automatically disables the i586 optimized routines.
12551fe04850SBruce Evans#
12561fe04850SBruce Evans
12570da9b781SMike Smith#
12580da9b781SMike Smith# ACPI support using the Intel ACPI Component Architecture reference
12590da9b781SMike Smith# implementation.
12600da9b781SMike Smith#
12610da9b781SMike Smith# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
12620da9b781SMike Smith# kernel environment variables to select initial debugging levels for the
12630da9b781SMike Smith# Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
12640da9b781SMike Smith# defined when it is built).
12650da9b781SMike Smith#
12660da9b781SMike Smithdevice		acpica
12670da9b781SMike Smithoptions		ACPI_DEBUG
12680da9b781SMike Smith
12691fe04850SBruce Evans#
1270d61e6649SAlexander Langer# Optional devices:
12716a8d6623SGarrett Wollman#
12726a8d6623SGarrett Wollman
12736a8d6623SGarrett Wollman#
1274d61e6649SAlexander Langer# SCSI host adapters:
12756a8d6623SGarrett Wollman#
1276859244a6SJustin T. Gibbs# adv: All Narrow SCSI bus AdvanSys controllers.
1277859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
1278d61e6649SAlexander Langer# aha: Adaptec 154x/1535/1640
127990d3341eSPeter Wemm# ahb: Adaptec 174x EISA controllers
1280d61e6649SAlexander Langer# ahc: Adaptec 274x/284x/2910/293x/294x/394x/3950x/3960x/398X/4944/
1281d61e6649SAlexander Langer#      19160x/29160x, aic7770/aic78xx
12826d04301dSAlexander Langer# aic: Adaptec 6260/6360, APA-1460 (PC Card), NEC PC9801-100 (C-BUS)
1283d61e6649SAlexander Langer# amd: Support for the AMD 53C974 SCSI host adapter chip as found on devices
1284d61e6649SAlexander Langer#      such as the Tekram DC-390(T).
1285d61e6649SAlexander Langer# bt:  Most Buslogic controllers: including BT-445, BT-54x, BT-64x, BT-74x,
1286d61e6649SAlexander Langer#      BT-75x, BT-946, BT-948, BT-956, BT-958, SDC3211B, SDC3211F, SDC3222F
1287d61e6649SAlexander Langer# isp: Qlogic ISP 1020, 1040 and 1040B PCI SCSI host adapters,
1288d61e6649SAlexander Langer#      ISP 1240 Dual Ultra SCSI, ISP 1080 and 1280 (Dual) Ultra2,
1289d61e6649SAlexander Langer#      ISP 12160 Ultra3 SCSI,
1290d61e6649SAlexander Langer#      Qlogic ISP 2100 and ISP 2200 Fibre Channel host adapters.
1291ac918c84SMatt Jacob# ispfw: Firmware module for Qlogic host adapters
1292d61e6649SAlexander Langer# ncr: NCR 53C810, 53C825 self-contained SCSI host adapters.
1293ae94720dSNoriaki Mitsunaga# ncv: NCR 53C500 based SCSI host adapters.
1294ae94720dSNoriaki Mitsunaga# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
1295fb91fd69SGerard Roudier# sym: Symbios/Logic 53C8XX family of PCI-SCSI I/O processors:
1296fb91fd69SGerard Roudier#      53C810, 53C810A, 53C815, 53C825,  53C825A, 53C860, 53C875,
1297fb91fd69SGerard Roudier#      53C876, 53C885,  53C895, 53C895A, 53C896,  53C897, 53C1510D,
1298fb91fd69SGerard Roudier#      53C1010-33, 53C1010-66.
1299ae94720dSNoriaki Mitsunaga# stg: TMC 18C30, 18C50 based SCSI host adapters.
1300821c54a1SSergey Babkin# wds: WD7000
1301d61e6649SAlexander Langer
13026a8d6623SGarrett Wollman#
1303d61e6649SAlexander Langer# Note that the order is important in order for Buslogic ISA/EISA cards to be
13046a8d6623SGarrett Wollman# probed correctly.
13056a8d6623SGarrett Wollman#
1306f71c01ccSPeter Wemmdevice		bt
1307f71c01ccSPeter Wemmhint.bt.0.at="isa"
1308f71c01ccSPeter Wemmhint.bt.0.port="0x330"
1309f71c01ccSPeter Wemmdevice		adv
1310f71c01ccSPeter Wemmhint.adv.0.at="isa"
1311c9953c3bSPeter Wemmdevice		adw
1312b9e3a5d3SPeter Wemmdevice		aha
1313f71c01ccSPeter Wemmhint.aha.0.at="isa"
1314f71c01ccSPeter Wemmdevice		aic
1315f71c01ccSPeter Wemmhint.aic.0.at="isa"
131690d3341eSPeter Wemmdevice		ahb
1317d61e6649SAlexander Langerdevice		ahc
1318d61e6649SAlexander Langerdevice		amd
1319d61e6649SAlexander Langerdevice		isp
13200787f2b8SMatt Jacobhint.isp.0.disable="1"
13210787f2b8SMatt Jacobhint.isp.0.role="3"
13220787f2b8SMatt Jacobhint.isp.0.prefer_iomap="1"
13230787f2b8SMatt Jacobhint.isp.0.prefer_memmap="1"
13240787f2b8SMatt Jacobhint.isp.0.fwload_disable="1"
13250787f2b8SMatt Jacobhint.isp.0.ignore_nvram="1"
13260787f2b8SMatt Jacobhint.isp.0.fullduplex="1"
13270787f2b8SMatt Jacobhint.isp.0.topology="lport"
13280787f2b8SMatt Jacobhint.isp.0.topology="nport"
13290787f2b8SMatt Jacobhint.isp.0.topology="lport-only"
13300787f2b8SMatt Jacobhint.isp.0.topology="nport-only"
13310787f2b8SMatt Jacob# we can't get u_int64_t types, nor can we get strings if it's got
13320787f2b8SMatt Jacob# a leading 0x, hence this silly dodge.
13330787f2b8SMatt Jacobhint.isp.0.portwnn="w50000000aaaa0000"
13340787f2b8SMatt Jacobhint.isp.0.nodewnn="w50000000aaaa0001"
1335d61e6649SAlexander Langerdevice		ispfw
1336d61e6649SAlexander Langerdevice		ncr
1337ae94720dSNoriaki Mitsunagadevice		ncv
1338ae94720dSNoriaki Mitsunagadevice		nsp
1339d61e6649SAlexander Langerdevice		sym
1340ae94720dSNoriaki Mitsunagadevice		stg
1341918dbed3SNoriaki Mitsunagahint.stg.0.at="isa"
1342918dbed3SNoriaki Mitsunagahint.stg.0.port="0x140"
1343918dbed3SNoriaki Mitsunagahint.stg.0.port="11"
1344821c54a1SSergey Babkindevice		wds
1345821c54a1SSergey Babkinhint.wds.0.at="isa"
1346821c54a1SSergey Babkinhint.wds.0.port="0x350"
1347821c54a1SSergey Babkinhint.wds.0.irq="11"
1348821c54a1SSergey Babkinhint.wds.0.drq="6"
1349d61e6649SAlexander Langer
1350d61e6649SAlexander Langer# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
1351d61e6649SAlexander Langer# controllers that have it configured only if this option is set. Unfortunately,
1352d61e6649SAlexander Langer# this doesn't work on some motherboards, which prevents it from being the
1353d61e6649SAlexander Langer# default.
1354d61e6649SAlexander Langeroptions 	AHC_ALLOW_MEMIO
1355d61e6649SAlexander Langer
1356fac70739SJeroen Ruigrok van der Werven# Enable diagnostic sequencer code.
1357fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DEBUG_SEQUENCER
1358fac70739SJeroen Ruigrok van der Werven
1359fac70739SJeroen Ruigrok van der Werven# Dump the contents of the ahc controller configuration PROM.
1360fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_DUMP_EEPROM
1361fac70739SJeroen Ruigrok van der Werven
1362fac70739SJeroen Ruigrok van der Werven# Bitmap of units to enable targetmode operations.
1363fac70739SJeroen Ruigrok van der Wervenoptions 	AHC_TMODE_ENABLE
1364fac70739SJeroen Ruigrok van der Werven
1365d61e6649SAlexander Langer# The adw driver will attempt to use memory mapped I/O for all PCI
1366d61e6649SAlexander Langer# controllers that have it configured only if this option is set.
1367d61e6649SAlexander Langeroptions 	ADW_ALLOW_MEMIO
1368d61e6649SAlexander Langer
1369d61e6649SAlexander Langer# Options used in dev/isp/ (Qlogic SCSI/FC driver).
1370d61e6649SAlexander Langer#
1371d61e6649SAlexander Langer#	ISP_TARGET_MODE		-	enable target mode operation
1372d61e6649SAlexander Langer#
1373d61e6649SAlexander Langer#options 	ISP_TARGET_MODE=1
1374d61e6649SAlexander Langer
1375d61e6649SAlexander Langer# Options used in dev/sym/ (Symbios SCSI driver).
1376d61e6649SAlexander Langer#options 	SYM_SETUP_LP_PROBE_MAP	#-Low Priority Probe Map (bits)
1377d61e6649SAlexander Langer					# Allows the ncr to take precedence
1378d61e6649SAlexander Langer					# 1 (1<<0) -> 810a, 860
1379d61e6649SAlexander Langer					# 2 (1<<1) -> 825a, 875, 885, 895
1380d61e6649SAlexander Langer					# 4 (1<<2) -> 895a, 896, 1510d
1381d61e6649SAlexander Langer#options 	SYM_SETUP_SCSI_DIFF	#-HVD support for 825a, 875, 885
1382d61e6649SAlexander Langer					# disabled:0 (default), enabled:1
1383d61e6649SAlexander Langer#options 	SYM_SETUP_PCI_PARITY	#-PCI parity checking
1384d61e6649SAlexander Langer					# disabled:0, enabled:1 (default)
1385d61e6649SAlexander Langer#options 	SYM_SETUP_MAX_LUN	#-Number of LUNs supported
1386d61e6649SAlexander Langer					# default:8, range:[1..64]
13876a8d6623SGarrett Wollman
1388ef137fd3SMike Smith# The 'asr' driver provides support for current DPT/Adaptec SCSI RAID
1389ef137fd3SMike Smith# controllers (SmartRAID V and VI and later).
1390ef137fd3SMike Smith# These controllers require the CAM infrastructure.
1391ef137fd3SMike Smith#
1392ef137fd3SMike Smithdevice		asr
1393ef137fd3SMike Smith
1394153cbcc3SMike Smith# The 'dpt' driver provides support for old DPT controllers (http://www.dpt.com/).
1395153cbcc3SMike Smith# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
1396153cbcc3SMike Smith# The DPT controllers are commonly re-licensed under other brand-names -
1397153cbcc3SMike Smith# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
1398153cbcc3SMike Smith# Compaq are actually DPT controllers.
1399153cbcc3SMike Smith#
1400153cbcc3SMike Smith# See src/sys/dev/dpt for debugging and other subtle options.
1401153cbcc3SMike Smith#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
1402153cbcc3SMike Smith#                           instruments are enabled.  The tools in
1403153cbcc3SMike Smith#                           /usr/sbin/dpt_* assume these to be enabled.
1404153cbcc3SMike Smith#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
1405153cbcc3SMike Smith#                           If you ant the driver to handle timeouts, enable
1406153cbcc3SMike Smith#                           this option.  If your system is very busy, this
1407153cbcc3SMike Smith#                           option will create more trouble than solve.
1408153cbcc3SMike Smith#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
1409153cbcc3SMike Smith#                           wait when timing out with the above option.
1410153cbcc3SMike Smith#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
1411153cbcc3SMike Smith#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
1412153cbcc3SMike Smith#                           any interrupt that got lost.  Seems to help in some
1413153cbcc3SMike Smith#                           DPT-firmware/Motherboard combinations.  Minimal
1414153cbcc3SMike Smith#                           cost, great benefit.
1415153cbcc3SMike Smith#  DPT_RESET_HBA            Make "reset" actually reset the controller
1416153cbcc3SMike Smith#                           instead of fudging it.  Only enable this if you
1417153cbcc3SMike Smith#			    are 100% certain you need it.
1418153cbcc3SMike Smith
1419153cbcc3SMike Smithdevice		dpt
1420153cbcc3SMike Smith
1421153cbcc3SMike Smith# DPT options
1422153cbcc3SMike Smith#!CAM# options 	DPT_MEASURE_PERFORMANCE
1423153cbcc3SMike Smith#!CAM# options 	DPT_HANDLE_TIMEOUTS
1424153cbcc3SMike Smithoptions 	DPT_TIMEOUT_FACTOR=4
1425153cbcc3SMike Smithoptions 	DPT_LOST_IRQ
1426153cbcc3SMike Smithoptions 	DPT_RESET_HBA
1427153cbcc3SMike Smithoptions 	DPT_ALLOW_MEMIO
1428153cbcc3SMike Smith
1429153cbcc3SMike Smith#
1430153cbcc3SMike Smith# Mylex AcceleRAID and eXtremeRAID controllers with v6 and later
1431153cbcc3SMike Smith# firmware.  These controllers have a SCSI-like interface, and require
1432153cbcc3SMike Smith# the CAM infrastructure.
1433153cbcc3SMike Smith#
1434153cbcc3SMike Smithdevice		mly
1435153cbcc3SMike Smith
14368b89ef0aSSøren Schmidt#
143735863739SMike Smith# Adaptec FSA RAID controllers, including integrated DELL controllers,
143835863739SMike Smith# the Dell PERC 2/QC and the HP NetRAID-4M
1439ead270f1SMike Smith#
1440ead270f1SMike Smith# AAC_COMPAT_LINUX	Include code to support Linux-binary management
1441ead270f1SMike Smith#			utilities (requires Linux compatibility
1442ead270f1SMike Smith#			support).
1443ead270f1SMike Smith#
144435863739SMike Smithdevice		aac
144535863739SMike Smith
144635863739SMike Smith#
14475e3488e3SJonathan Lemon# Compaq Smart RAID, Mylex DAC960 and AMI MegaRAID controllers.  Only
14485e3488e3SJonathan Lemon# one entry is needed; the code will find and configure all supported
14495e3488e3SJonathan Lemon# controllers.
145013066c5fSJonathan Lemon#
14515e3488e3SJonathan Lemondevice		ida		# Compaq Smart RAID
1452c9953c3bSPeter Wemmdevice		mlx		# Mylex DAC960
1453c9953c3bSPeter Wemmdevice		amr		# AMI MegaRAID
14546ac4727aSMike Smith
14556ac4727aSMike Smith#
145690d3341eSPeter Wemm# 3ware ATA RAID
145790d3341eSPeter Wemm#
145890d3341eSPeter Wemmdevice		twe		# 3ware ATA RAID
145990d3341eSPeter Wemm
146090d3341eSPeter Wemm#
14616d04301dSAlexander Langer# The 'ATA' driver supports all ATA and ATAPI devices, including PC Card
14626d04301dSAlexander Langer# devices. You only need one "device ata" for it to find all
14636d04301dSAlexander Langer# PCI and PC Card ATA/ATAPI devices on modern machines.
1464c9953c3bSPeter Wemmdevice		ata
1465c9953c3bSPeter Wemmdevice		atadisk		# ATA disk drives
1466c9953c3bSPeter Wemmdevice		atapicd		# ATAPI CDROM drives
1467c9953c3bSPeter Wemmdevice		atapifd		# ATAPI floppy drives
1468c9953c3bSPeter Wemmdevice		atapist		# ATAPI tape drives
146974d8e840SSøren Schmidt
14708b89ef0aSSøren Schmidt#
14716d04301dSAlexander Langer# For older non-PCI, non-PnPBIOS systems, these are the hints lines to add:
14726d04301dSAlexander Langerhint.ata.0.at="isa"
14736d04301dSAlexander Langerhint.ata.0.port="0x1f0"
14746d04301dSAlexander Langerhint.ata.0.irq="14"
14756d04301dSAlexander Langerhint.ata.1.at="isa"
14766d04301dSAlexander Langerhint.ata.1.port="0x170"
14776d04301dSAlexander Langerhint.ata.1.irq="15"
14786d04301dSAlexander Langer
14796d04301dSAlexander Langer#
1480000da71aSSøren Schmidt# The following options are valid on the ATA driver:
1481000da71aSSøren Schmidt#
1482000da71aSSøren Schmidt# ATA_STATIC_ID:	controller numbering is static ie depends on location
148374d8e840SSøren Schmidt#			else the device numbers are dynamically allocated.
148474d8e840SSøren Schmidt
148574d8e840SSøren Schmidtoptions 	ATA_STATIC_ID
148674d8e840SSøren Schmidt
14878b89ef0aSSøren Schmidt#
14886d04301dSAlexander Langer# Standard floppy disk controllers and floppy tapes, supports
14896d04301dSAlexander Langer# the Y-E DATA External FDD (PC Card)
14906a8d6623SGarrett Wollman#
1491f71c01ccSPeter Wemmdevice		fdc
1492f71c01ccSPeter Wemmhint.fdc.0.at="isa"
1493f71c01ccSPeter Wemmhint.fdc.0.port="0x3F0"
1494f71c01ccSPeter Wemmhint.fdc.0.irq="6"
1495f71c01ccSPeter Wemmhint.fdc.0.drq="2"
149685827d9cSJoerg Wunsch#
1497d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1498d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1499d2fb4892SJoerg Wunsch# however.
1500d2fb4892SJoerg Wunschoptions 	FDC_DEBUG
1501d2fb4892SJoerg Wunsch#
1502f71c01ccSPeter Wemm# Activate this line if you happen to have an Insight floppy tape.
1503f71c01ccSPeter Wemm# Probing them proved to be dangerous for people with floppy disks only,
1504f71c01ccSPeter Wemm# so it's "hidden" behind a flag:
1505f71c01ccSPeter Wemm#hint.fdc.0.flags="1"
150685827d9cSJoerg Wunsch
1507f71c01ccSPeter Wemm# Specify floppy devices
1508f71c01ccSPeter Wemmhint.fd.0.at="fdc0"
1509f71c01ccSPeter Wemmhint.fd.0.drive="0"
1510f71c01ccSPeter Wemmhint.fd.1.at="fdc0"
1511f71c01ccSPeter Wemmhint.fd.1.drive="1"
151285827d9cSJoerg Wunsch
1513d4ebee28SPoul-Henning Kamp# M-systems DiskOnchip products see src/sys/contrib/dev/fla/README
1514f71c01ccSPeter Wemmdevice		fla
1515f71c01ccSPeter Wemmhint.fla.0.at="isa"
1516d4ebee28SPoul-Henning Kamp
15176a8d6623SGarrett Wollman#
1518d61e6649SAlexander Langer# Other standard PC hardware:
15196a8d6623SGarrett Wollman#
15206a8d6623SGarrett Wollman# mse: Logitech and ATI InPort bus mouse ports
15216d04301dSAlexander Langer# sio: serial ports (see sio(4)), including support for various
15226d04301dSAlexander Langer#      PC Card devices, such as Modem and NICs (see etc/defaults/pccard.conf)
15236a8d6623SGarrett Wollman
1524f71c01ccSPeter Wemmdevice		mse
1525f71c01ccSPeter Wemmhint.mse.0.at="isa"
1526f71c01ccSPeter Wemmhint.mse.0.port="0x23c"
1527f71c01ccSPeter Wemmhint.mse.0.irq="5"
1528975c53c7SDoug Rabson
1529f71c01ccSPeter Wemmdevice		sio
1530f71c01ccSPeter Wemmhint.sio.0.at="isa"
1531f71c01ccSPeter Wemmhint.sio.0.port="0x3F8"
1532f71c01ccSPeter Wemmhint.sio.0.flags="0x10"
1533f71c01ccSPeter Wemmhint.sio.0.irq="4"
15349546766aSBruce Evans
15359546766aSBruce Evans#
15369546766aSBruce Evans# `flags' for serial drivers that support consoles (only for sio now):
15379546766aSBruce Evans#	0x10	enable console support for this unit.  The other console flags
15389546766aSBruce Evans#		are ignored unless this is set.  Enabling console support does
15399546766aSBruce Evans#		not make the unit the preferred console - boot with -h or set
15409546766aSBruce Evans#		the 0x20 flag for that.  Currently, at most one unit can have
15419546766aSBruce Evans#		console support; the first one (in config file order) with
15429546766aSBruce Evans#		this flag set is preferred.  Setting this flag for sio0 gives
15439546766aSBruce Evans#		the old behaviour.
15449546766aSBruce Evans#	0x20	force this unit to be the console (unless there is another
15459546766aSBruce Evans#		higher priority console).  This replaces the COMCONSOLE option.
15469546766aSBruce Evans#	0x40	reserve this unit for low level console operations.  Do not
154704fb8e53SAlexander Langer#		access the device in any normal way.
1548a7674320SMartin Cracauer#	0x80	use this port for serial line gdb support in ddb.
15499546766aSBruce Evans#
15506a796ce0SJohn-Mark Gurney# PnP `flags' (set via userconfig using pnp x flags y)
15516a796ce0SJohn-Mark Gurney#	0x1	disable probing of this device.  Used to prevent your modem
15526a796ce0SJohn-Mark Gurney#		from being attached as a PnP modem.
15536a796ce0SJohn-Mark Gurney#
15549546766aSBruce Evans
15559546766aSBruce Evans# Options for serial drivers that support consoles (only for sio now):
15569546766aSBruce Evansoptions 	BREAK_TO_DEBUGGER	#a BREAK on a comconsole goes to
15579546766aSBruce Evans					#DDB, if available.
15585ea6cb03SPaul Trainaoptions 	CONSPEED=9600		#default speed for serial console (default 9600)
15596a8d6623SGarrett Wollman
156026b6ea69SPaul Saab# Solaris implements a new BREAK which is initiated by a character
156126b6ea69SPaul Saab# sequence CR ~ ^b which is similar to a familiar pattern used on
156226b6ea69SPaul Saab# Sun servers by the Remote Console.
156326b6ea69SPaul Saaboptions 	ALT_BREAK_TO_DEBUGGER
156426b6ea69SPaul Saab
15656a8d6623SGarrett Wollman# Options for sio:
1566768fd661SBruce Evansoptions 	COM_ESP			#code for Hayes ESP
15679ba0e7c3SBruce Evansoptions 	COM_MULTIPORT		#code for some cards with shared IRQs
15686a8d6623SGarrett Wollman
156996b89afcSBruce Evans# Other flags for sio that aren't documented in the man page.
157096b89afcSBruce Evans#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
157196b89afcSBruce Evans#		ST16650A-compatible UARTs.
157296b89afcSBruce Evans
15736a8d6623SGarrett Wollman#
1574d61e6649SAlexander Langer# Network interfaces:
15756a8d6623SGarrett Wollman#
1576d61e6649SAlexander Langer# MII bus support is required for some PCI 10/100 ethernet NICs,
1577d61e6649SAlexander Langer# namely those which use MII-compliant transceivers or implement
1578d61e6649SAlexander Langer# tranceiver control interfaces that operate like an MII. Adding
1579d61e6649SAlexander Langer# "device miibus0" to the kernel config pulls in support for
1580d61e6649SAlexander Langer# the generic miibus API and all of the PHY drivers, including a
1581d61e6649SAlexander Langer# generic one for PHYs that aren't specifically handled by an
1582d61e6649SAlexander Langer# individual driver.
1583d61e6649SAlexander Langerdevice		miibus
1584d61e6649SAlexander Langer
1585d61e6649SAlexander Langer# an:   Aironet 4500/4800 802.11 wireless adapters. Supports the PCMCIA,
1586d61e6649SAlexander Langer#       PCI and ISA varieties.
1587d61e6649SAlexander Langer# ar:   Arnet SYNC/570i hdlc sync 2/4 port V.35/X.21 serial driver
1588d61e6649SAlexander Langer#       (requires sppp)
15896d04301dSAlexander Langer# awi:  Support for IEEE 802.11 PC Card devices using the AMD Am79C930 and
15906d04301dSAlexander Langer#       Harris (Intersil) Chipset with PCnetMobile firmware by AMD.
1591d6f40bb4SWarner Losh# cnw:  Xircom CNW/Netware Airsurfer PC Card adapter
1592b16d163dSMike Smith# cs:   IBM Etherjet and other Crystal Semi CS89x0-based adapters
159383401efaSGarrett Wollman# cx:   Cronyx/Sigma multiport sync/async (with Cisco or PPP framing)
1594d61e6649SAlexander Langer# dc:   Support for PCI fast ethernet adapters based on the DEC/Intel 21143
1595d61e6649SAlexander Langer#       and various workalikes including:
1596d61e6649SAlexander Langer#       the ADMtek AL981 Comet and AN985 Centaur, the ASIX Electronics
1597d61e6649SAlexander Langer#       AX88140A and AX88141, the Davicom DM9100 and DM9102, the Lite-On
1598d61e6649SAlexander Langer#       82c168 and 82c169 PNIC, the Lite-On/Macronix LC82C115 PNIC II
1599d61e6649SAlexander Langer#       and the Macronix 98713/98713A/98715/98715A/98725 PMAC. This driver
1600d61e6649SAlexander Langer#       replaces the old al, ax, dm, pn and mx drivers.  List of brands:
1601d61e6649SAlexander Langer#       Digital DE500-BA, Kingston KNE100TX, D-Link DFE-570TX, SOHOware SFA110,
1602d61e6649SAlexander Langer#       SVEC PN102-TX, CNet Pro110B, 120A, and 120B, Compex RL100-TX,
1603d61e6649SAlexander Langer#       LinkSys LNE100TX, LNE100TX V2.0, Jaton XpressNet, Alfa Inc GFC2204,
1604d61e6649SAlexander Langer#       KNE110TX.
1605d61e6649SAlexander Langer# de:   Digital Equipment DC21040
16066a8d6623SGarrett Wollman# ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
16076d04301dSAlexander Langer#       HP PC Lan+, various PC Card devices (refer to etc/defauls/pccard.conf)
16086a8d6623SGarrett Wollman# el:   3Com 3C501 (slow!)
1609855e2f19SAlexander Langer# ep:   3Com 3C509, 3C529, 3C556, 3C562D, 3C563D, 3C572, 3C574X, 3C579, 3C589
16106d04301dSAlexander Langer#       and PC Card devices using these chipsets.
16116d04301dSAlexander Langer# ex:   Intel EtherExpress Pro/10 and other i82595-based adapters,
16126d04301dSAlexander Langer#       Olicom Ethernet PC Card devices.
16131a7c583cSGarrett Wollman# fe:   Fujitsu MB86960A/MB86965A Ethernet
1614d61e6649SAlexander Langer# fea:  DEC DEFEA EISA FDDI adapter
1615d61e6649SAlexander Langer# fpa:  Support for the Digital DEFPA PCI FDDI. `device fddi' is also needed.
1616d61e6649SAlexander Langer# fxp:  Intel EtherExpress Pro/100B
1617cf87044eSMatt Jacob#	(hint of prefer_iomap can be done to prefer I/O instead of Mem mapping)
1618d61e6649SAlexander Langer# ie:   AT&T StarLAN 10 and EN100; 3Com 3C507; unknown NI5210;
1619d61e6649SAlexander Langer#       Intel EtherExpress
16206a8d6623SGarrett Wollman# le:   Digital Equipment EtherWorks 2 and EtherWorks 3 (DEPCA, DE100,
16216a8d6623SGarrett Wollman#       DE101, DE200, DE201, DE202, DE203, DE204, DE205, DE422)
1622d61e6649SAlexander Langer# lnc:  Lance/PCnet cards (Isolan, Novell NE2100, NE32-VL, AMD Am7990 and
1623d61e6649SAlexander Langer#       Am79C960)
1624d61e6649SAlexander Langer# oltr: Olicom ISA token-ring adapters OC-3115, OC-3117, OC-3118 and OC-3133
1625d61e6649SAlexander Langer#       (no hints needed).
1626d61e6649SAlexander Langer#       Olicom PCI token-ring adapters OC-3136, OC-3137, OC-3139, OC-3140,
1627d61e6649SAlexander Langer#       OC-3141, OC-3540, OC-3250
162830cfb5b6SJoerg Wunsch# rdp:  RealTek RTL 8002-based pocket ethernet adapters
162941f7d2d5SBill Paul# pcn:	Support for PCI fast ethernet adapters based on the AMD Am79c97x
163041f7d2d5SBill Paul#	chipsets, including the PCnet/FAST, PCnet/FAST+, PCnet/PRO and
163141f7d2d5SBill Paul#	PCnet/Home. These were previously handled by the lnc driver (and
163241f7d2d5SBill Paul#	still will be if you leave this driver out of the kernel).
1633d61e6649SAlexander Langer# rl:   Support for PCI fast ethernet adapters based on the RealTek 8129/8139
1634d61e6649SAlexander Langer#       chipset.  Note that the RealTek driver defaults to using programmed
1635d61e6649SAlexander Langer#       I/O to do register accesses because memory mapped mode seems to cause
1636d61e6649SAlexander Langer#       severe lockups on SMP hardware.  This driver also supports the
1637d61e6649SAlexander Langer#       Accton EN1207D `Cheetah' adapter, which uses a chip called
1638d61e6649SAlexander Langer#       the MPX 5030/5038, which is either a RealTek in disguise or a
1639d61e6649SAlexander Langer#       RealTek workalike.  Note that the D-Link DFE-530TX+ uses the RealTek
1640d61e6649SAlexander Langer#       chipset and is supported by this driver, not the 'vr' driver.
1641d61e6649SAlexander Langer# sf:   Support for Adaptec Duralink PCI fast ethernet adapters based on the
1642d61e6649SAlexander Langer#       Adaptec AIC-6915 "starfire" controller.
1643d61e6649SAlexander Langer#       This includes dual and quad port cards, as well as one 100baseFX card.
1644d61e6649SAlexander Langer#       Most of these are 64-bit PCI devices, except for one single port
1645d61e6649SAlexander Langer#       card which is 32-bit.
1646b2ca5572SAlexander Langer# sis:  Support for NICs based on the Silicon Integrated Systems SiS 900,
1647b2ca5572SAlexander Langer#       SiS 7016 and NS DP83815 PCI fast ethernet controller chips.
1648d61e6649SAlexander Langer# sk:   Support for the SysKonnect SK-984x series PCI gigabit ethernet NICs.
1649d61e6649SAlexander Langer#       This includes the SK-9841 and SK-9842 single port cards (single mode
1650d61e6649SAlexander Langer#       and multimode fiber) and the SK-9843 and SK-9844 dual port cards
1651d61e6649SAlexander Langer#       (also single mode and multimode).
1652d61e6649SAlexander Langer#       The driver will autodetect the number of ports on the card and
1653d61e6649SAlexander Langer#       attach each one as a separate network interface.
16546d04301dSAlexander Langer# sn:   Support for ISA and PC Card Ethernet devices using the
16556d04301dSAlexander Langer#       SMC91C90/92/94/95 chips.
1656d805b866SJohn Hay# sr:   RISCom/N2 hdlc sync 1/2 port V.35/X.21 serial driver (requires sppp)
1657d61e6649SAlexander Langer# ste:  Sundance Technologies ST201 PCI fast ethernet controller, includes
1658d61e6649SAlexander Langer#       the D-Link DFE-550TX.
1659d61e6649SAlexander Langer# ti:   Support for PCI gigabit ethernet NICs based on the Alteon Networks
1660d61e6649SAlexander Langer#       Tigon 1 and Tigon 2 chipsets.  This includes the Alteon AceNIC, the
1661d61e6649SAlexander Langer#       3Com 3c985, the Netgear GA620 and various others.  Note that you will
1662d61e6649SAlexander Langer#       probably want to bump up NMBCLUSTERS a lot to use this driver.
1663d61e6649SAlexander Langer# tl:   Support for the Texas Instruments TNETE100 series 'ThunderLAN'
1664d61e6649SAlexander Langer#       cards and integrated ethernet controllers.  This includes several
1665d61e6649SAlexander Langer#       Compaq Netelligent 10/100 cards and the built-in ethernet controllers
1666d61e6649SAlexander Langer#       in several Compaq Prosignia, Proliant and Deskpro systems.  It also
1667d61e6649SAlexander Langer#       supports several Olicom 10Mbps and 10/100 boards.
16680cc2be21SSemen Ustimenko# tx:   SMC 9432 TX, BTX and FTX cards. (SMC EtherPower II serie)
1669d61e6649SAlexander Langer# vr:   Support for various fast ethernet adapters based on the VIA
1670d61e6649SAlexander Langer#       Technologies VT3043 `Rhine I' and VT86C100A `Rhine II' chips,
1671d61e6649SAlexander Langer#       including the D-Link DFE530TX (see 'rl' for DFE530TX+), the Hawking
1672d61e6649SAlexander Langer#       Technologies PN102TX, and the AOpen/Acer ALN-320.
1673d61e6649SAlexander Langer# vx:   3Com 3C590 and 3C595
1674d61e6649SAlexander Langer# wb:   Support for fast ethernet adapters based on the Winbond W89C840F chip.
1675d61e6649SAlexander Langer#       Note: this is not the same as the Winbond W89C940F, which is a
1676d61e6649SAlexander Langer#       NE2000 clone.
167798d46ad0SMike Smith# wl:   Lucent Wavelan (ISA card only).
167831a08ab0SBill Paul# wi:   Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
16795f0d0590SPeter Wemm#       the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
16805f0d0590SPeter Wemm#       bridge with a PCMCIA adapter plugged into it.
1681d61e6649SAlexander Langer# wx:   Intel Gigabit Ethernet PCI card (`Wiseman')
16826d04301dSAlexander Langer# xe:   Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller,
16836d04301dSAlexander Langer#       Accton Fast EtherCard-16, Compaq Netelligent 10/100 PC Card,
16846d04301dSAlexander Langer#       Toshiba 10/100 Ethernet PC Card, Xircom 16-bit Ethernet + Modem 56
1685d61e6649SAlexander Langer# xl:   Support for the 3Com 3c900, 3c905, 3c905B and 3c905C (Fast)
1686d61e6649SAlexander Langer#       Etherlink XL cards and integrated controllers.  This includes the
1687d61e6649SAlexander Langer#       integrated 3c905B-TX chips in certain Dell Optiplex and Dell
1688d61e6649SAlexander Langer#       Precision desktop machines and the integrated 3c905-TX chips
1689d61e6649SAlexander Langer#       in Dell Latitude laptop docking stations.
1690d61e6649SAlexander Langer#       Also supported: 3Com 3c980(C)-TX, 3Com 3cSOHO100-TX, 3Com 3c450-TX
1691d61e6649SAlexander Langer
1692d61e6649SAlexander Langer# Order for ISA/EISA devices is important here
1693d61e6649SAlexander Langer
1694f71c01ccSPeter Wemmdevice		ar	1
1695f71c01ccSPeter Wemmhint.ar.0.at="isa"
1696f71c01ccSPeter Wemmhint.ar.0.port="0x300"
1697f71c01ccSPeter Wemmhint.ar.0.irq="10"
169842b04349SPeter Wemmhint.ar.0.maddr="0xd0000"
1699f71c01ccSPeter Wemmdevice		cs
1700f71c01ccSPeter Wemmhint.cs.0.at="isa"
1701f71c01ccSPeter Wemmhint.cs.0.port="0x300"
1702f71c01ccSPeter Wemmdevice		cx	1
1703f71c01ccSPeter Wemmhint.cx.0.at="isa"
1704f71c01ccSPeter Wemmhint.cx.0.port="0x240"
1705f71c01ccSPeter Wemmhint.cx.0.irq="15"
1706f71c01ccSPeter Wemmhint.cx.0.drq="7"
1707f71c01ccSPeter Wemmdevice		ed
1708f71c01ccSPeter Wemmhint.ed.0.at="isa"
1709f71c01ccSPeter Wemmhint.ed.0.port="0x280"
1710f71c01ccSPeter Wemmhint.ed.0.irq="5"
171142b04349SPeter Wemmhint.ed.0.maddr="0xd8000"
1712f71c01ccSPeter Wemmdevice		el	1
1713f71c01ccSPeter Wemmhint.el.0.at="isa"
1714f71c01ccSPeter Wemmhint.el.0.port="0x300"
1715f71c01ccSPeter Wemmhint.el.0.irq="9"
1716c9953c3bSPeter Wemmdevice		ep
1717c9953c3bSPeter Wemmdevice		ex
1718f71c01ccSPeter Wemmdevice		fe	1
1719edd5302dSJeroen Ruigrok van der Wervenoptions 	FE_8BIT_SUPPORT		# LAC-98 support
1720f71c01ccSPeter Wemmhint.fe.0.at="isa"
1721f71c01ccSPeter Wemmhint.fe.0.port="0x300"
1722d61e6649SAlexander Langerdevice		fea
1723f71c01ccSPeter Wemmdevice		ie	2
1724f71c01ccSPeter Wemmhint.ie.0.at="isa"
1725f71c01ccSPeter Wemmhint.ie.0.port="0x300"
1726f71c01ccSPeter Wemmhint.ie.0.irq="5"
172742b04349SPeter Wemmhint.ie.0.maddr="0xd0000"
1728f71c01ccSPeter Wemmhint.ie.1.at="isa"
1729f71c01ccSPeter Wemmhint.ie.1.port="0x360"
1730f71c01ccSPeter Wemmhint.ie.1.irq="7"
173142b04349SPeter Wemmhint.ie.1.maddr="0xd0000"
1732f71c01ccSPeter Wemmdevice		le	1
1733f71c01ccSPeter Wemmhint.le.0.at="isa"
1734f71c01ccSPeter Wemmhint.le.0.port="0x300"
1735f71c01ccSPeter Wemmhint.le.0.irq="5"
173642b04349SPeter Wemmhint.le.0.maddr="0xd0000"
1737f71c01ccSPeter Wemmdevice		lnc	1
1738f71c01ccSPeter Wemmhint.lnc.0.at="isa"
1739f71c01ccSPeter Wemmhint.lnc.0.port="0x280"
1740f71c01ccSPeter Wemmhint.lnc.0.irq="10"
1741f71c01ccSPeter Wemmhint.lnc.0.drq="0"
1742f71c01ccSPeter Wemmdevice		rdp	1
1743f71c01ccSPeter Wemmhint.rdp.0.at="isa"
1744f71c01ccSPeter Wemmhint.rdp.0.port="0x378"
1745f71c01ccSPeter Wemmhint.rdp.0.irq="7"
1746f71c01ccSPeter Wemmhint.rdp.0.flags="2"
1747f71c01ccSPeter Wemmdevice		sr	1
1748f71c01ccSPeter Wemmhint.sr.0.at="isa"
1749f71c01ccSPeter Wemmhint.sr.0.port="0x300"
1750f71c01ccSPeter Wemmhint.sr.0.irq="5"
175142b04349SPeter Wemmhint.sr.0.maddr="0xd0000"
1752f71c01ccSPeter Wemmdevice		sn
1753f71c01ccSPeter Wemmhint.sn.0.at="isa"
1754f71c01ccSPeter Wemmhint.sn.0.port="0x300"
1755f71c01ccSPeter Wemmhint.sn.0.irq="10"
1756c9953c3bSPeter Wemmdevice		an
17570d5c223dSWarner Loshdevice		awi
1758d6f40bb4SWarner Loshdevice		cnw
17590d5c223dSWarner Loshdevice		wi
17603476cdb9SMike Smithoptions 	WLCACHE		# enables the signal-strength cache
17613476cdb9SMike Smithoptions 	WLDEBUG		# enables verbose debugging output
1762f71c01ccSPeter Wemmdevice		wl	1
1763f71c01ccSPeter Wemmhint.wl.0.at="isa"
1764f71c01ccSPeter Wemmhint.wl.0.port="0x300"
17650d5c223dSWarner Loshdevice		xe
1766648c711bSPoul-Henning Kamp
1767f71c01ccSPeter Wemmdevice		oltr
1768f71c01ccSPeter Wemmoptions 	OLTR_NO_BULLSEYE_MAC
1769f71c01ccSPeter Wemmoptions 	OLTR_NO_HAWKEYE_MAC
1770f71c01ccSPeter Wemmoptions 	OLTR_NO_TMS_MAC
1771f71c01ccSPeter Wemmhint.oltr.0.at="isa"
1772722012ccSJulian Elischer
1773d61e6649SAlexander Langer# PCI Ethernet NICs that use the common MII bus controller code.
1774d61e6649SAlexander Langerdevice		dc		# DEC/Intel 21143 and various workalikes
17754664a8d5SJonathan Lemondevice		fxp		# Intel EtherExpress PRO/100B (82557, 82558)
17764664a8d5SJonathan Lemonhint.fxp.0.prefer_iomap="0"
1777d61e6649SAlexander Langerdevice		rl		# RealTek 8129/8139
177841f7d2d5SBill Pauldevice		pcn		# AMD Am79C79x PCI 10/100 NICs
1779d61e6649SAlexander Langerdevice		sf		# Adaptec AIC-6915 (``Starfire'')
1780d61e6649SAlexander Langerdevice		sis		# Silicon Integrated Systems SiS 900/SiS 7016
1781d61e6649SAlexander Langerdevice		ste		# Sundance ST201 (D-Link DFE-550TX)
1782d61e6649SAlexander Langerdevice		tl		# Texas Instruments ThunderLAN
1783eed59f52SSemen Ustimenkodevice		tx		# SMC EtherPower II (83c170 ``EPIC'')
1784d61e6649SAlexander Langerdevice		vr		# VIA Rhine, Rhine II
1785d61e6649SAlexander Langerdevice		wb		# Winbond W89C840F
1786d61e6649SAlexander Langerdevice		xl		# 3Com 3c90x (``Boomerang'', ``Cyclone'')
1787d61e6649SAlexander Langer
1788d61e6649SAlexander Langer# PCI Ethernet NICs.
1789d61e6649SAlexander Langerdevice		de		# DEC/Intel DC21x4x (``Tulip'')
1790c7ba4194SWarner Loshdevice		vx		# 3Com 3c590, 3c595 (``Vortex'')
1791d61e6649SAlexander Langer
1792d61e6649SAlexander Langer# PCI Gigabit & FDDI NICs.
1793d61e6649SAlexander Langerdevice		sk
1794d61e6649SAlexander Langerdevice		ti
1795d61e6649SAlexander Langerdevice		wx
1796d61e6649SAlexander Langerdevice		fpa	1
1797d61e6649SAlexander Langer
179868713f97SKenjiro Cho#
179944b5247dSKenjiro Cho# ATM related options (Cranor version)
180044b5247dSKenjiro Cho# (note: this driver cannot be used with the HARP ATM stack)
180168713f97SKenjiro Cho#
180268713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
180368713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
180468713f97SKenjiro Cho#
1805f71c01ccSPeter Wemm# atm device provides generic atm functions and is required for
180668713f97SKenjiro Cho# atm devices.
18073cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
180868713f97SKenjiro Cho# bypass TCP/IP.
180968713f97SKenjiro Cho#
181068713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
181168713f97SKenjiro Cho# for more details, please read the original documents at
181298a44096SSheldon Hearn# http://www.ccrc.wustl.edu/pub/chuck/tech/bsdatm/bsdatm.html
181368713f97SKenjiro Cho#
1814f71c01ccSPeter Wemmdevice		atm
181544b5247dSKenjiro Chodevice		en
18163cbceb82SKenjiro Chooptions 	NATM			#native ATM
1817f4567b9cSJulian Elischer
1818c19da41eSPeter Wemm#
1819f71c01ccSPeter Wemm# Audio drivers: `pcm', `sbc', `gusc', `pca'
1820c19da41eSPeter Wemm#
1821c7406082SJohn-Mark Gurney# pcm: PCM audio through various sound cards.
1822c7406082SJohn-Mark Gurney#
182368ec4eb6SLuigi Rizzo# This has support for a large number of new audio cards, based on
182468ec4eb6SLuigi Rizzo# CS423x, OPTi931, Yamaha OPL-SAx, and also for SB16, GusPnP.
182568ec4eb6SLuigi Rizzo# For more information about this driver and supported cards,
182698a44096SSheldon Hearn# see the pcm.4 man page.
1827c7406082SJohn-Mark Gurney#
1828c7406082SJohn-Mark Gurney# The flags of the device tells the device a bit more info about the
1829c7406082SJohn-Mark Gurney# device that normally is obtained through the PnP interface.
1830c7406082SJohn-Mark Gurney#	bit  2..0   secondary DMA channel;
1831c7406082SJohn-Mark Gurney#	bit  4      set if the board uses two dma channels;
1832c7406082SJohn-Mark Gurney#	bit 15..8   board type, overrides autodetection; leave it
1833c7406082SJohn-Mark Gurney#		    zero if don't know what to put in (and you don't,
1834c7406082SJohn-Mark Gurney#		    since this is unsupported at the moment...).
1835c7406082SJohn-Mark Gurney#
1836c19da41eSPeter Wemm# This driver will use the new PnP code if it's available.
1837c19da41eSPeter Wemm#
18386a8d6623SGarrett Wollman# pca: PCM audio through your PC speaker
18398b8cd792SJordan K. Hubbard#
184081bb901eSPeter Wemm# Supported cards include:
184181bb901eSPeter Wemm# Creative SoundBlaster ISA PnP/non-PnP
184281bb901eSPeter Wemm# Supports ESS and Avance ISA chips as well.
184381bb901eSPeter Wemm# Gravis UltraSound ISA PnP/non-PnP
184481bb901eSPeter Wemm# Crystal Semiconductor CS461x/428x PCI
184581bb901eSPeter Wemm# Neomagic 256AV (ac97)
184681bb901eSPeter Wemm# Most of the more common ISA/PnP sb/mss/ess compatable cards.
184781bb901eSPeter Wemm
184867245194SPeter Wemmdevice		pcm
1849c19da41eSPeter Wemm
1850f71c01ccSPeter Wemm# For non-pnp sound cards with no bridge drivers only:
1851f71c01ccSPeter Wemmhint.pcm.0.at="isa"
1852f71c01ccSPeter Wemmhint.pcm.0.irq="10"
1853f71c01ccSPeter Wemmhint.pcm.0.drq="1"
1854f71c01ccSPeter Wemmhint.pcm.0.flags="0x0"
1855f71c01ccSPeter Wemm
1856f71c01ccSPeter Wemm# For PnP/PCI sound cards, no hints are required.
1857f71c01ccSPeter Wemm
1858fb0ef528SSeigo Tanimura#
1859fb0ef528SSeigo Tanimura# midi: MIDI interfaces and synthesizers
1860fb0ef528SSeigo Tanimura#
1861fb0ef528SSeigo Tanimura
1862fb0ef528SSeigo Tanimuradevice		midi
1863fb0ef528SSeigo Tanimura
1864fb0ef528SSeigo Tanimura# For non-pnp sound cards with no bridge drivers:
1865fb0ef528SSeigo Tanimurahint.midi.0.at="isa"
1866fb0ef528SSeigo Tanimurahint.midi.0.irq="5"
1867fb0ef528SSeigo Tanimurahint.midi.0.flags="0x0"
1868fb0ef528SSeigo Tanimura
1869fb0ef528SSeigo Tanimura# For serial ports (this example configures port 2):
1870fb0ef528SSeigo Tanimura# TODO: implement generic tty-midi interface so that we can use
1871fb0ef528SSeigo Tanimura#	other uarts.
1872fb0ef528SSeigo Tanimurahint.midi.0.at="isa"
1873fb0ef528SSeigo Tanimurahint.midi.0.port="0x2F8"
1874fb0ef528SSeigo Tanimurahint.midi.0.irq="3"
1875fb0ef528SSeigo Tanimura
1876fb0ef528SSeigo Tanimura#
1877fb0ef528SSeigo Tanimura# seq: MIDI sequencer
1878fb0ef528SSeigo Tanimura#
1879fb0ef528SSeigo Tanimura
1880fb0ef528SSeigo Tanimuradevice		seq
1881fb0ef528SSeigo Tanimura
18821a6e52d0SJeroen Ruigrok van der Werven# The bridge drivers for sound cards.  These can be separately configured
1883fb0ef528SSeigo Tanimura# for providing services to the likes of new-midi.
188481bb901eSPeter Wemm# When used with 'device pcm' they also provide pcm sound services.
188546d6fe72SSeigo Tanimura#
1886e3c43911SSeigo Tanimura# sbc:  Creative SoundBlaster ISA PnP/non-PnP
1887c2f8aaa8SSeigo Tanimura#	Supports ESS and Avance ISA chips as well.
188846d6fe72SSeigo Tanimura# gusc: Gravis UltraSound ISA PnP/non-PnP
188981bb901eSPeter Wemm# csa:  Crystal Semiconductor CS461x/428x PCI
189046d6fe72SSeigo Tanimura
1891869f459cSSeigo Tanimura# For non-PnP cards:
1892f71c01ccSPeter Wemmdevice		sbc
1893f71c01ccSPeter Wemmhint.sbc.0.at="isa"
1894f71c01ccSPeter Wemmhint.sbc.0.port="0x220"
1895f71c01ccSPeter Wemmhint.sbc.0.irq="5"
1896f71c01ccSPeter Wemmhint.sbc.0.drq="1"
1897f71c01ccSPeter Wemmhint.sbc.0.flags="0x15"
1898f71c01ccSPeter Wemmdevice		gusc
1899f71c01ccSPeter Wemmhint.gusc.0.at="isa"
1900f71c01ccSPeter Wemmhint.gusc.0.port="0x220"
1901f71c01ccSPeter Wemmhint.gusc.0.irq="5"
1902f71c01ccSPeter Wemmhint.gusc.0.drq="1"
1903f71c01ccSPeter Wemmhint.gusc.0.flags="0x13"
1904869f459cSSeigo Tanimura
1905f71c01ccSPeter Wemmdevice		pca
1906f71c01ccSPeter Wemmhint.pca.0.at="isa"
1907f71c01ccSPeter Wemmhint.pca.0.port="0x040"
19089ad380abSGarrett Wollman
19096a8d6623SGarrett Wollman#
1910567e21c2SBruce Evans# Miscellaneous hardware:
19116a8d6623SGarrett Wollman#
19126a8d6623SGarrett Wollman# mcd: Mitsumi CD-ROM
19132d859864SAndreas Schulz# scd: Sony CD-ROM
191405e1d9d4SJordan K. Hubbard# matcd: Matsushita/Panasonic CD-ROM
19156a8d6623SGarrett Wollman# wt: Wangtek and Archive QIC-02/QIC-36 tape drives
19166a8d6623SGarrett Wollman# ctx: Cortex-I frame grabber
19176a8d6623SGarrett Wollman# apm: Laptop Advanced Power Management (experimental)
1918ff3f2f5cSMitsuru IWASAKI# pmtimer: Timer device driver for power management events (APM or ACPI)
19196c5e9bbdSMike Pritchard# spigot: The Creative Labs Video Spigot video-acquisition board
19201d86961eSJordan K. Hubbard# meteor: Matrox Meteor video capture board
19211c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
19222849b131SBruce Evans# cy: Cyclades serial driver
1923a50cd483SJordan K. Hubbard# dgb: Digiboard PC/Xi and PC/Xe series driver (ALPHA QUALITY!)
1924c35bda94SBrian Somers# dgm: Digiboard PC/Xem driver
19256d04301dSAlexander Langer# gp:  National Instruments AT-GPIB and AT-GPIB/TNT board, PCMCIA-GPIB
1926a800f455SJulian Elischer# asc: GI1904-based hand scanners, e.g. the Trust Amiscan Grey
19271a7c583cSGarrett Wollman# gsc: Genius GS-4500 hand scanner.
19286d04301dSAlexander Langer# joy: joystick (including IO DATA PCJOY PC Card joystick)
1929edd5302dSJeroen Ruigrok van der Werven# The LOUTB option specifies a slower outb() for debugging purposes.
1930d0930614SAndrey A. Chernov# rc: RISCom/8 multiport card
19313b577e1fSJordan K. Hubbard# rp: Comtrol Rocketport(ISA) - single card
1932567e21c2SBruce Evans# tw: TW-523 power line interface for use with X-10 home control products
19330d04cf6aSPeter Wemm# si: Specialix SI/XIO 4-32 port terminal multiplexor
19344323578dSNick Sayer# spic: Sony Programmable I/O controller (VAIO notebooks)
1935c9da1b81SPeter Wemm# stl: Stallion EasyIO and EasyConnection 8/32 (cd1400 based)
1936c9da1b81SPeter Wemm# stli: Stallion EasyConnection 8/64, ONboard, Brumby (intelligent)
1937657e73c4SPeter Dufault
1938e597b497SNate Williams# Notes on APM
19393d4d8fe9SPoul-Henning Kamp#  The flags takes the following meaning for apm0:
19403d4d8fe9SPoul-Henning Kamp#    0x0020  Statclock is broken.
1941c9c350b7SBill Fumerola#  If apm is omitted, some systems require sysctl -w kern.timecounter.method=1
194238ebe562SAdam David#  for correct timekeeping.
194338ebe562SAdam David
19442cd01159SJordan K. Hubbard# Notes on the spigot:
19452cd01159SJordan K. Hubbard#  The video spigot is at 0xad6.  This port address can not be changed.
19462cd01159SJordan K. Hubbard#  The irq values may only be 10, 11, or 15
19472cd01159SJordan K. Hubbard#  I/O memory is an 8kb region.  Possible values are:
19482cd01159SJordan K. Hubbard#    0a0000, 0a2000, ..., 0fffff, f00000, f02000, ..., ffffff
1949d01b6680SJordan K. Hubbard#    The start address must be on an even boundary.
1950d01b6680SJordan K. Hubbard#  Add the following option if you want to allow non-root users to be able
1951d01b6680SJordan K. Hubbard#  to access the spigot.  This option is not secure because it allows users
1952d01b6680SJordan K. Hubbard#  direct access to the I/O page.
1953d01b6680SJordan K. Hubbard#  	options SPIGOT_UNSECURE
19548819d6ecSPoul-Henning Kamp
19553b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
19563b577e1fSJordan K. Hubbard#
19573b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
19583b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
19593b577e1fSJordan K. Hubbard#
1960f71c01ccSPeter Wemm#               device  rp	# core driver support
1961f71c01ccSPeter Wemm#
19623b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1963f71c01ccSPeter Wemm#		hints.rp.0.at="isa"
1964f71c01ccSPeter Wemm#		hints.rp.0.port="0x280"
19653b577e1fSJordan K. Hubbard#
19663b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
19673b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
1968f71c01ccSPeter Wemm#   your kernel probe hints:
1969f71c01ccSPeter Wemm#		hints.rp.0.at="isa"
1970f71c01ccSPeter Wemm#		hints.rp.0.port="0x100"
1971f71c01ccSPeter Wemm#		hints.rp.1.at="isa"
1972f71c01ccSPeter Wemm#		hints.rp.1.port="0x180"
19733b577e1fSJordan K. Hubbard#
19743b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
1975f71c01ccSPeter Wemm#		hints.rp.0.at="isa"
1976f71c01ccSPeter Wemm#		hints.rp.0.port="0x180"
1977f71c01ccSPeter Wemm#		hints.rp.1.at="isa"
1978f71c01ccSPeter Wemm#		hints.rp.1.port="0x100"
1979f71c01ccSPeter Wemm#		hints.rp.2.at="isa"
1980f71c01ccSPeter Wemm#		hints.rp.2.port="0x340"
1981f71c01ccSPeter Wemm#		hints.rp.3.at="isa"
1982f71c01ccSPeter Wemm#		hints.rp.3.port="0x240"
19833b577e1fSJordan K. Hubbard#
1984f71c01ccSPeter Wemm#   And for PCI cards, you need no hints.
19853b577e1fSJordan K. Hubbard
1986a50cd483SJordan K. Hubbard# Notes on the Digiboard driver:
1987a50cd483SJordan K. Hubbard#
1988a50cd483SJordan K. Hubbard# The following flag values have special meanings:
1989c35bda94SBrian Somers#	0x01 - alternate layout of pins (dgb & dgm)
1990c35bda94SBrian Somers#	0x02 - use the windowed PC/Xe in 64K mode (dgb only)
19910d04cf6aSPeter Wemm
19920d04cf6aSPeter Wemm# Notes on the Specialix SI/XIO driver:
1993c4823710SPeter Wemm#  The host card is memory, not IO mapped.
1994c4823710SPeter Wemm#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
1995c4823710SPeter Wemm#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
1996c4823710SPeter Wemm#  The cards can use an IRQ of 11, 12 or 15.
1997c4823710SPeter Wemm
19984323578dSNick Sayer# Notes on the Sony Programmable I/O controller
19994323578dSNick Sayer#  This is a temporary driver that should someday be replaced by something
20004323578dSNick Sayer#  that hooks into the ACPI layer. The device is hooked to the PIIX4's
20014323578dSNick Sayer#  General Device 10 decoder, which means you have to fiddle with PCI
20024323578dSNick Sayer#  registers to map it in, even though it is otherwise treated here as
20034323578dSNick Sayer#  an ISA device. At the moment, the driver polls, although the device
20044323578dSNick Sayer#  is capable of generating interrupts. It largely undocumented.
20054323578dSNick Sayer#  The port location in the hint is where you WANT the device to be
20064323578dSNick Sayer#  mapped. 0x10a0 seems to be traditional. At the moment the jogdial
20074323578dSNick Sayer#  is the only thing truly supported, but aparently a fair percentage
20084323578dSNick Sayer#  of the Vaio extra features are controlled by this device.
20094323578dSNick Sayer
2010c9da1b81SPeter Wemm# Notes on the Stallion stl and stli drivers:
2011c9da1b81SPeter Wemm#  See src/i386/isa/README.stl for complete instructions.
2012c9da1b81SPeter Wemm#  This is version 0.0.5alpha, unsupported by Stallion.
2013c9da1b81SPeter Wemm#  The stl driver has a secondary IO port hard coded at 0x280.  You need
2014c9da1b81SPeter Wemm#     to change src/i386/isa/stallion.c if you reconfigure this on the boards.
201542b04349SPeter Wemm#  The "flags" and "msize" settings on the stli driver depend on the board:
201642b04349SPeter Wemm#	EasyConnection 8/64 ISA:     flags 23         msize 0x1000
201742b04349SPeter Wemm#	EasyConnection 8/64 EISA:    flags 24         msize 0x10000
201842b04349SPeter Wemm#	EasyConnection 8/64 MCA:     flags 25         msize 0x1000
201942b04349SPeter Wemm#	ONboard ISA:                 flags 4          msize 0x10000
202042b04349SPeter Wemm#	ONboard EISA:                flags 7          msize 0x10000
202142b04349SPeter Wemm#	ONboard MCA:                 flags 3          msize 0x10000
202242b04349SPeter Wemm#	Brumby:                      flags 2          msize 0x4000
202342b04349SPeter Wemm#	Stallion:                    flags 1          msize 0x10000
2024c9da1b81SPeter Wemm
2025f71c01ccSPeter Wemmdevice		mcd	1
2026f71c01ccSPeter Wemmhint.mcd.0.at="isa"
2027f71c01ccSPeter Wemmhint.mcd.0.port="0x300"
2028f71c01ccSPeter Wemmhint.mcd.0.irq="10"
202905e1d9d4SJordan K. Hubbard# for the Sony CDU31/33A CDROM
2030f71c01ccSPeter Wemmdevice		scd	1
2031f71c01ccSPeter Wemmhint.scd.0.at="isa"
2032f71c01ccSPeter Wemmhint.scd.0.port="0x230"
20336c5e9bbdSMike Pritchard# for the SoundBlaster 16 multicd - up to 4 devices
2034f71c01ccSPeter Wemmdevice		matcd	1
2035f71c01ccSPeter Wemmhint.matcd.0.at="isa"
2036f71c01ccSPeter Wemmhint.matcd.0.port="0x230"
2037f71c01ccSPeter Wemmdevice		wt	1
2038f71c01ccSPeter Wemmhint.wt.0.at="isa"
2039f71c01ccSPeter Wemmhint.wt.0.port="0x300"
2040f71c01ccSPeter Wemmhint.wt.0.irq="5"
2041f71c01ccSPeter Wemmhint.wt.0.drq="1"
2042f71c01ccSPeter Wemmdevice		ctx	1
2043f71c01ccSPeter Wemmhint.ctx.0.at="isa"
2044f71c01ccSPeter Wemmhint.ctx.0.port="0x230"
204542b04349SPeter Wemmhint.ctx.0.maddr="0xd0000"
2046f71c01ccSPeter Wemmdevice		spigot	1
2047f71c01ccSPeter Wemmhint.spigot.0.at="isa"
2048f71c01ccSPeter Wemmhint.spigot.0.port="0xad6"
2049f71c01ccSPeter Wemmhint.spigot.0.irq="15"
205042b04349SPeter Wemmhint.spigot.0.maddr="0xee000"
2051f71c01ccSPeter Wemmdevice		apm
2052f71c01ccSPeter Wemmhint.apm.0.flags="0x20"
2053ff3f2f5cSMitsuru IWASAKIdevice		pmtimer			# Adjust system timer at wakeup time
2054215e338bSMitsuru IWASAKIhint.pmtimer.0.at="isa"
2055f71c01ccSPeter Wemmdevice		gp
2056f71c01ccSPeter Wemmhint.gp.0.at="isa"
2057f71c01ccSPeter Wemmhint.gp.0.port="0x2c0"
2058f71c01ccSPeter Wemmdevice		gsc	1
2059f71c01ccSPeter Wemmhint.gsc.0.at="isa"
2060f71c01ccSPeter Wemmhint.gsc.0.port="0x270"
2061f71c01ccSPeter Wemmhint.gsc.0.drq="3"
2062f71c01ccSPeter Wemmdevice		joy			# PnP aware, hints for nonpnp only
2063f71c01ccSPeter Wemmhint.joy.0.at="isa"
2064f71c01ccSPeter Wemmhint.joy.0.port="0x201"
20652849b131SBruce Evansdevice		cy	1
20662849b131SBruce Evansoptions 	CY_PCI_FASTINTR		# Use with cy_pci unless irq is shared
20672849b131SBruce Evanshint.cy.0.at="isa"
20682849b131SBruce Evanshint.cy.0.irq="10"
20692849b131SBruce Evanshint.cy.0.maddr="0xd4000"
20702849b131SBruce Evanshint.cy.0.msize="0x2000"
2071f71c01ccSPeter Wemmdevice		dgb	1
20725895e3c8SPeter Wemmoptions 	NDGBPORTS=16		# Defaults to 16*NDGB
2073f71c01ccSPeter Wemmhint.dgb.0.at="isa"
2074f71c01ccSPeter Wemmhint.dgb.0.port="0x220"
207542b04349SPeter Wemmhint.dgb.0.maddr="0xfc000"
2076f71c01ccSPeter Wemmdevice		dgm	1
2077f71c01ccSPeter Wemmhint.dgm.0.at="isa"
2078f71c01ccSPeter Wemmhint.dgm.0.port="0x104"
207942b04349SPeter Wemmhint.dgm.0.maddr="0xd0000"
2080f71c01ccSPeter Wemmdevice		rc	1
2081f71c01ccSPeter Wemmhint.rc.0.at="isa"
2082f71c01ccSPeter Wemmhint.rc.0.port="0x220"
2083f71c01ccSPeter Wemmhint.rc.0.irq="12"
2084f71c01ccSPeter Wemmdevice		rp
2085f71c01ccSPeter Wemmhint.rp.0.at="isa"
2086f71c01ccSPeter Wemmhint.rp.0.port="0x280"
2087567e21c2SBruce Evans# the port and irq for tw0 are fictitious
2088f71c01ccSPeter Wemmdevice		tw	1
2089f71c01ccSPeter Wemmhint.tw.0.at="isa"
2090f71c01ccSPeter Wemmhint.tw.0.port="0x380"
2091f71c01ccSPeter Wemmhint.tw.0.irq="11"
2092f71c01ccSPeter Wemmdevice		si
2093f71c01ccSPeter Wemmoptions 	SI_DEBUG
2094f71c01ccSPeter Wemmhint.si.0.at="isa"
209542b04349SPeter Wemmhint.si.0.maddr="0xd0000"
2096f71c01ccSPeter Wemmhint.si.0.irq="12"
2097f71c01ccSPeter Wemmdevice		asc	1
2098f71c01ccSPeter Wemmhint.asc.0.at="isa"
2099f71c01ccSPeter Wemmhint.asc.0.port="0x3EB"
2100f71c01ccSPeter Wemmhint.asc.0.drq="3"
2101f71c01ccSPeter Wemmhint.asc.0.irq="10"
21024323578dSNick Sayerdevice		spic
21034323578dSNick Sayerhint.spic.0.at="isa"
21044323578dSNick Sayerhint.spic.0.port="0x10a0"
2105f71c01ccSPeter Wemmdevice		stl
2106f71c01ccSPeter Wemmhint.stl.0.at="isa"
2107f71c01ccSPeter Wemmhint.stl.0.port="0x2a0"
2108f71c01ccSPeter Wemmhint.stl.0.irq="10"
2109f71c01ccSPeter Wemmdevice		stli
2110f71c01ccSPeter Wemmhint.stli.0.at="isa"
2111f71c01ccSPeter Wemmhint.stli.0.port="0x2a0"
211242b04349SPeter Wemmhint.stli.0.maddr="0xcc000"
2113f71c01ccSPeter Wemmhint.stli.0.flags="23"
211442b04349SPeter Wemmhint.stli.0.msize="0x1000"
2115f71c01ccSPeter Wemm# You are unlikely to have the hardware for loran <phk@FreeBSD.org>
2116f71c01ccSPeter Wemmdevice		loran
2117f71c01ccSPeter Wemmhint.loran.0.at="isa"
2118f71c01ccSPeter Wemmhint.loran.0.irq="5"
211998a44096SSheldon Hearn# HOT1 Xilinx 6200 card (http://www.vcc.com/)
2120c9953c3bSPeter Wemmdevice		xrpu
2121a800f455SJulian Elischer
2122eeb706c0SJustin T. Gibbs#
2123bba9a7a0SGarrett Wollman# The `meteor' device is a PCI video capture board. It can also have the
21241d86961eSJordan K. Hubbard# following options:
2125b1529bdaSPeter Wemm#   options METEOR_ALLOC_PAGES=xxx	preallocate kernel pages for data entry
21261d86961eSJordan K. Hubbard#	figure (ROWS*COLUMN*BYTES_PER_PIXEL*FRAME+PAGE_SIZE-1)/PAGE_SIZE
21271d86961eSJordan K. Hubbard#   options METEOR_DEALLOC_PAGES	remove all allocated pages on close(2)
2128b1529bdaSPeter Wemm#   options METEOR_DEALLOC_ABOVE=xxx	remove all allocated pages above the
21291d86961eSJordan K. Hubbard#	specified amount. If this value is below the allocated amount no action
21301d86961eSJordan K. Hubbard#	taken
21314f5f3f07SBrian Somers#   options METEOR_SYSTEM_DEFAULT={METEOR_PAL|METEOR_NTSC|METEOR_SECAM}, used
2132734d08a2SJordan K. Hubbard#	for initialization of fps routine when a signal is not present.
21331d86961eSJordan K. Hubbard#
2134a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
21351c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
2136a9c5b8d0SSøren Schmidt# TV card, eg Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
21371c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
21381c2b5939SRoger Hardiman#
2139a9c5b8d0SSøren Schmidt# options 	OVERRIDE_CARD=xxx
2140a9c5b8d0SSøren Schmidt# options 	OVERRIDE_TUNER=xxx
2141a9c5b8d0SSøren Schmidt# options 	OVERRIDE_MSP=1
2142a9c5b8d0SSøren Schmidt# options 	OVERRIDE_DBX=1
21431c2b5939SRoger Hardiman# These options can be used to override the auto detection
214498a44096SSheldon Hearn# The current values for xxx are found in src/sys/dev/bktr/bktr_card.h
21451c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
21469ff07e32SAmancio Hasty#
21474f5f3f07SBrian Somers# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
21481c2b5939SRoger Hardiman# or
21491c2b5939SRoger Hardiman# options 	BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
21501c2b5939SRoger Hardiman# Specifes the default video capture mode.
2151a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
2152a9c5b8d0SSøren Schmidt# to prevent hangs during initialisation.  eg VideoLogic Captivator PCI.
2153a9c5b8d0SSøren Schmidt#
21544f5f3f07SBrian Somers# options 	BKTR_USE_PLL
21551c2b5939SRoger Hardiman# PAL or SECAM users who have a 28Mhz crystal (and no 35Mhz crystal)
21561c2b5939SRoger Hardiman# must enable PLL mode with this option. eg some new Bt878 cards.
2157a9c5b8d0SSøren Schmidt#
21581c2b5939SRoger Hardiman# options 	BKTR_GPIO_ACCESS
21591c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
21601c2b5939SRoger Hardiman#
21611c2b5939SRoger Hardiman# options 	BKTR_NO_MSP_RESET
21621c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
21631c2b5939SRoger Hardiman#
21641c2b5939SRoger Hardiman# options 	BKTR_430_FX_MODE
21651c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
21661c2b5939SRoger Hardiman#
21671c2b5939SRoger Hardiman# options 	BKTR_SIS_VIA_MODE
21681c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
21691c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
21701c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
21711c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
21721c2b5939SRoger Hardiman# As a rough guess, old = before 1998
21731c2b5939SRoger Hardiman#
2174017b0edcSMatt Jacob
2175f71c01ccSPeter Wemmdevice		meteor	1
21760f3563b6SRoger Hardiman
217728ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
21780f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
217937973e86SPeter Wemm#     device smbus
218037973e86SPeter Wemm#     device iicbus
218137973e86SPeter Wemm#     device iicbb
21820f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
21830f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
218428ebb692SNicolas Souchu#
2185f71c01ccSPeter Wemmdevice		bktr	1
2186446cee6eSJoerg Wunsch
2187dc9deb29SPoul-Henning Kamp#
21886d04301dSAlexander Langer# PC Card/PCMCIA
2189dc9deb29SPoul-Henning Kamp#
2190b5137699SWarner Losh# card: pccard slots
2191b5137699SWarner Losh# pcic: isa/pccard bridge
2192f71c01ccSPeter Wemmdevice		pcic
2193f71c01ccSPeter Wemmhint.pcic.0.at="isa"
2194f71c01ccSPeter Wemmhint.pcic.1.at="isa"
2195c9953c3bSPeter Wemmdevice		card
2196dc9deb29SPoul-Henning Kamp
21978aa25588SBrian Somers# You may need to reset all pccards after resuming
21988aa25588SBrian Somersoptions 	PCIC_RESUME_RESET	# reset after resume
21998aa25588SBrian Somers
2200446cee6eSJoerg Wunsch#
2201446cee6eSJoerg Wunsch# Laptop/Notebook options:
2202446cee6eSJoerg Wunsch#
2203446cee6eSJoerg Wunsch# See also:
22046c5e9bbdSMike Pritchard#  apm under `Miscellaneous hardware'
2205446cee6eSJoerg Wunsch# above.
2206446cee6eSJoerg Wunsch
2207446cee6eSJoerg Wunsch# For older notebooks that signal a powerfail condition (external
2208446cee6eSJoerg Wunsch# power supply dropped, or battery state low) by issuing an NMI:
2209446cee6eSJoerg Wunsch
2210446cee6eSJoerg Wunschoptions 	POWERFAIL_NMI	# make it beep instead of panicing
221165e8111fSBruce Evans
2212ab4c624bSMike Smith#
22138afa373cSNicolas Souchu# SMB bus
22148afa373cSNicolas Souchu#
22153c5656bfSArchie Cobbs# System Management Bus support is provided by the 'smbus' device.
22163c5656bfSArchie Cobbs# Access to the SMBus device is via the 'smb' device (/dev/smb*),
22173c5656bfSArchie Cobbs# which is a child of the 'smbus' device.
22188afa373cSNicolas Souchu#
22198afa373cSNicolas Souchu# Supported devices:
22203c5656bfSArchie Cobbs# smb		standard io through /dev/smb*
22218afa373cSNicolas Souchu#
22223c5656bfSArchie Cobbs# Supported SMB interfaces:
222328ebb692SNicolas Souchu# iicsmb	I2C to SMB bridge with any iicbus interface
222428ebb692SNicolas Souchu# bktr		brooktree848 I2C hardware interface
222504fb1490SNicolas Souchu# intpm		Intel PIIX4 Power Management Unit
2226c5ea635cSNicolas Souchu# alpm		Acer Aladdin-IV/V/Pro2 Power Management Unit
22273c5656bfSArchie Cobbs# ichsmb	Intel ICH SMBus controller chips (82801AA, 82801AB, 82801BA)
22288afa373cSNicolas Souchu#
2229c9953c3bSPeter Wemmdevice		smbus		# Bus support, required for smb below.
22303c5656bfSArchie Cobbs
2231c9953c3bSPeter Wemmdevice		intpm
2232c89863e8SNicolas Souchudevice		alpm
22333c5656bfSArchie Cobbsdevice		ichsmb
22348afa373cSNicolas Souchu
2235c9953c3bSPeter Wemmdevice		smb
22368afa373cSNicolas Souchu
22378afa373cSNicolas Souchu#
22388afa373cSNicolas Souchu# I2C Bus
22398afa373cSNicolas Souchu#
22408afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
22418afa373cSNicolas Souchu#
22428afa373cSNicolas Souchu# Supported devices:
22438afa373cSNicolas Souchu# ic	i2c network interface
22448afa373cSNicolas Souchu# iic	i2c standard io
2245f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
22468afa373cSNicolas Souchu#
22478afa373cSNicolas Souchu# Supported interfaces:
22488afa373cSNicolas Souchu# pcf	Philips PCF8584 ISA-bus controller
224928ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
225028ebb692SNicolas Souchu#
225128ebb692SNicolas Souchu# Other:
225228ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
22538afa373cSNicolas Souchu#
2254c9953c3bSPeter Wemmdevice		iicbus		# Bus support, required for ic/iic/iicsmb below.
2255c9953c3bSPeter Wemmdevice		iicbb
22568afa373cSNicolas Souchu
2257c9953c3bSPeter Wemmdevice		ic
2258c9953c3bSPeter Wemmdevice		iic
2259c9953c3bSPeter Wemmdevice		iicsmb		# smb over i2c bridge
22608afa373cSNicolas Souchu
2261f71c01ccSPeter Wemmdevice		pcf
2262f71c01ccSPeter Wemmhint.pcf.0.at="isa"
2263f71c01ccSPeter Wemmhint.pcf.0.port="0x320"
2264f71c01ccSPeter Wemmhint.pcf.0.irq="5"
22658afa373cSNicolas Souchu
226631a539a5SHellmuth Michaelis#---------------------------------------------------------------------------
226731a539a5SHellmuth Michaelis# ISDN4BSD
226880037d6eSHellmuth Michaelis#
2269e5981bd1SHellmuth Michaelis# See /usr/share/examples/isdn/ROADMAP for an introduction to isdn4bsd.
227080037d6eSHellmuth Michaelis#
227131a539a5SHellmuth Michaelis# i4b passive ISDN cards support contains the following hardware drivers:
22728afa373cSNicolas Souchu#
22738ccc600fSHellmuth Michaelis#	isic  - Siemens/Infineon ISDN ISAC/HSCX/IPAC chipset driver
22748ccc600fSHellmuth Michaelis#	iwic  - Winbond W6692 PCI bus ISDN S/T interface controller
22758ccc600fSHellmuth Michaelis#	ifpi  - AVM Fritz!Card PCI driver
22768ccc600fSHellmuth Michaelis#	ihfc  - Cologne Chip HFC ISA/ISA-PnP chipset driver
22778ccc600fSHellmuth Michaelis#	ifpnp - AVM Fritz!Card PnP driver
22788301794fSHellmuth Michaelis#	itjc  - Siemens ISAC / TJNet Tiger300/320 chipset
2279e5981bd1SHellmuth Michaelis#
228031a539a5SHellmuth Michaelis# Note that the ``options'' (if given) and ``device'' lines must BOTH
228131a539a5SHellmuth Michaelis# be uncommented to enable support for a given card !
228231a539a5SHellmuth Michaelis#
228331a539a5SHellmuth Michaelis# In addition to a hardware driver (and probably an option) the mandatory
228431a539a5SHellmuth Michaelis# ISDN protocol stack devices and the mandatory support device must be
228531a539a5SHellmuth Michaelis# enabled as well as one or more devices from the optional devices section.
228631a539a5SHellmuth Michaelis#
228731a539a5SHellmuth Michaelis#---------------------------------------------------------------------------
228831a539a5SHellmuth Michaelis#	isic driver (Siemens/Infineon chipsets)
228931a539a5SHellmuth Michaelis#
229031a539a5SHellmuth Michaelisdevice	isic
229131a539a5SHellmuth Michaelis#
2292e5981bd1SHellmuth Michaelis# ISA bus non-PnP Cards:
2293e5981bd1SHellmuth Michaelis# ----------------------
229419c74962SPoul-Henning Kamp#
229519c74962SPoul-Henning Kamp# Teles S0/8 or Niccy 1008
22965895e3c8SPeter Wemmoptions 	TEL_S0_8
2297f71c01ccSPeter Wemmhint.isic.0.at="isa"
229842b04349SPeter Wemmhint.isic.0.maddr="0xd0000"
2299f71c01ccSPeter Wemmhint.isic.0.irq="5"
2300f71c01ccSPeter Wemmhint.isic.0.flags="1"
230119c74962SPoul-Henning Kamp#
230219c74962SPoul-Henning Kamp# Teles S0/16 or Creatix ISDN-S0 or Niccy 1016
23035895e3c8SPeter Wemmoptions 	TEL_S0_16
2304f71c01ccSPeter Wemmhint.isic.0.at="isa"
2305f71c01ccSPeter Wemmhint.isic.0.port="0xd80"
230642b04349SPeter Wemmhint.isic.0.maddr="0xd0000"
2307f71c01ccSPeter Wemmhint.isic.0.irq="5"
2308f71c01ccSPeter Wemmhint.isic.0.flags="2"
230919c74962SPoul-Henning Kamp#
231019c74962SPoul-Henning Kamp# Teles S0/16.3
23115895e3c8SPeter Wemmoptions 	TEL_S0_16_3
2312f71c01ccSPeter Wemmhint.isic.0.at="isa"
231319dde963SPeter Wemmhint.isic.0.port="0xd80"
2314f71c01ccSPeter Wemmhint.isic.0.irq="5"
2315f71c01ccSPeter Wemmhint.isic.0.flags="3"
231619c74962SPoul-Henning Kamp#
231719c74962SPoul-Henning Kamp# AVM A1 or AVM Fritz!Card
23185895e3c8SPeter Wemmoptions 	AVM_A1
2319f71c01ccSPeter Wemmhint.isic.0.at="isa"
232019dde963SPeter Wemmhint.isic.0.port="0x340"
2321f71c01ccSPeter Wemmhint.isic.0.irq="5"
2322f71c01ccSPeter Wemmhint.isic.0.flags="4"
232319c74962SPoul-Henning Kamp#
232431a539a5SHellmuth Michaelis# USRobotics Sportster ISDN TA intern
232531a539a5SHellmuth Michaelisoptions 	USR_STI
232631a539a5SHellmuth Michaelishint.isic.0.at="isa"
232731a539a5SHellmuth Michaelishint.isic.0.port="0x268"
232831a539a5SHellmuth Michaelishint.isic.0.irq="5"
232931a539a5SHellmuth Michaelishint.isic.0.flags="7"
233019c74962SPoul-Henning Kamp#
233131a539a5SHellmuth Michaelis# ITK ix1 Micro ( < V.3, non-PnP version )
233231a539a5SHellmuth Michaelisoptions 	ITKIX1
233331a539a5SHellmuth Michaelishint.isic.0.at="isa"
233431a539a5SHellmuth Michaelishint.isic.0.port="0x398"
233531a539a5SHellmuth Michaelishint.isic.0.irq="10"
233631a539a5SHellmuth Michaelishint.isic.0.flags="18"
233719c74962SPoul-Henning Kamp#
233880037d6eSHellmuth Michaelis# ELSA PCC-16
2339cb211653SJeroen Ruigrok van der Wervenoptions 	ELSA_PCC16
2340f71c01ccSPeter Wemmhint.isic.0.at="isa"
234119dde963SPeter Wemmhint.isic.0.port="0x360"
2342f71c01ccSPeter Wemmhint.isic.0.irq="10"
2343f71c01ccSPeter Wemmhint.isic.0.flags="20"
234480037d6eSHellmuth Michaelis#
2345e5981bd1SHellmuth Michaelis# ISA bus PnP Cards:
2346e5981bd1SHellmuth Michaelis# ------------------
234719c74962SPoul-Henning Kamp#
234819c74962SPoul-Henning Kamp# Teles S0/16.3 PnP
23495895e3c8SPeter Wemmoptions 	TEL_S0_16_3_P
235019c74962SPoul-Henning Kamp#
235119c74962SPoul-Henning Kamp# Creatix ISDN-S0 P&P
23525895e3c8SPeter Wemmoptions 	CRTX_S0_P
235319c74962SPoul-Henning Kamp#
235419c74962SPoul-Henning Kamp# Dr. Neuhaus Niccy Go@
23555895e3c8SPeter Wemmoptions 	DRN_NGO
235619c74962SPoul-Henning Kamp#
235719c74962SPoul-Henning Kamp# Sedlbauer Win Speed
23585895e3c8SPeter Wemmoptions 	SEDLBAUER
235919c74962SPoul-Henning Kamp#
236031a539a5SHellmuth Michaelis# Dynalink IS64PH
236131a539a5SHellmuth Michaelisoptions 	DYNALINK
236219c74962SPoul-Henning Kamp#
236319c74962SPoul-Henning Kamp# ELSA QuickStep 1000pro ISA
23645895e3c8SPeter Wemmoptions 	ELSA_QS1ISA
236519c74962SPoul-Henning Kamp#
23660df6adecSHellmuth Michaelis# Siemens I-Surf 2.0
2367cb211653SJeroen Ruigrok van der Wervenoptions 	SIEMENS_ISURF2
23680df6adecSHellmuth Michaelis#
23699d45f435SJeroen Ruigrok van der Werven# Asuscom ISDNlink 128K ISA
237031a539a5SHellmuth Michaelisoptions 	ASUSCOM_IPAC
23711eeb917cSJeroen Ruigrok van der Werven#
23724a29e8f9SHellmuth Michaelis# Eicon Diehl DIVA 2.0 and 2.02
23734a29e8f9SHellmuth Michaelisoptions       EICON_DIVA
23744a29e8f9SHellmuth Michaelis#
2375e5981bd1SHellmuth Michaelis# PCI bus Cards:
2376e5981bd1SHellmuth Michaelis# --------------
237719c74962SPoul-Henning Kamp#
2378e5981bd1SHellmuth Michaelis# ELSA MicroLink ISDN/PCI (same as ELSA QuickStep 1000pro PCI)
23795895e3c8SPeter Wemmoptions 	ELSA_QS1PCI
238019c74962SPoul-Henning Kamp#
238131a539a5SHellmuth Michaelis#
238231a539a5SHellmuth Michaelis#---------------------------------------------------------------------------
238331a539a5SHellmuth Michaelis#	ifpnp driver for AVM Fritz!Card PnP
238431a539a5SHellmuth Michaelis#
238531a539a5SHellmuth Michaelis# AVM Fritz!Card PnP
238631a539a5SHellmuth Michaelisdevice ifpnp
238731a539a5SHellmuth Michaelis#
238831a539a5SHellmuth Michaelis#---------------------------------------------------------------------------
238931a539a5SHellmuth Michaelis#	ihfc driver for Cologne Chip ISA chipsets (experimental!)
239031a539a5SHellmuth Michaelis#
239131a539a5SHellmuth Michaelis# Teles 16.3c ISA PnP
239231a539a5SHellmuth Michaelis# AcerISDN P10 ISA PnP
239331a539a5SHellmuth Michaelis# TELEINT ISDN SPEED No.1
239431a539a5SHellmuth Michaelisdevice ihfc
239531a539a5SHellmuth Michaelis#
239631a539a5SHellmuth Michaelis#---------------------------------------------------------------------------
239731a539a5SHellmuth Michaelis#	ifpi driver for AVM Fritz!Card PCI
239831a539a5SHellmuth Michaelis#
239980037d6eSHellmuth Michaelis# AVM Fritz!Card PCI
240031a539a5SHellmuth Michaelisdevice  ifpi
240180037d6eSHellmuth Michaelis#
240231a539a5SHellmuth Michaelis#---------------------------------------------------------------------------
240331a539a5SHellmuth Michaelis#	iwic driver for Winbond W6692 chipset
240419c74962SPoul-Henning Kamp#
240531a539a5SHellmuth Michaelis# ASUSCOM P-IN100-ST-D (and other Winbond W6692 based cards)
24063374f8ccSHellmuth Michaelisdevice  iwic
240719c74962SPoul-Henning Kamp#
240831a539a5SHellmuth Michaelis#---------------------------------------------------------------------------
24098301794fSHellmuth Michaelis#	itjc driver for Simens ISAC / TJNet Tiger300/320 chipset
24108301794fSHellmuth Michaelis#
24118301794fSHellmuth Michaelis# Traverse Technologies NETjet-S
24128301794fSHellmuth Michaelis# Teles PCI-TJ
24138301794fSHellmuth Michaelisdevice  itjc
24148301794fSHellmuth Michaelis#
24158301794fSHellmuth Michaelis#---------------------------------------------------------------------------
241631a539a5SHellmuth Michaelis#	ISDN Protocol Stack - mandatory for all hardware drivers
241719c74962SPoul-Henning Kamp#
241819c74962SPoul-Henning Kamp# Q.921 / layer 2 - i4b passive cards D channel handling
2419f71c01ccSPeter Wemmdevice		"i4bq921"
242019c74962SPoul-Henning Kamp#
242119c74962SPoul-Henning Kamp# Q.931 / layer 3 - i4b passive cards D channel handling
2422f71c01ccSPeter Wemmdevice		"i4bq931"
242319c74962SPoul-Henning Kamp#
242419c74962SPoul-Henning Kamp# layer 4 - i4b common passive and active card handling
2425f71c01ccSPeter Wemmdevice		"i4b"
242619c74962SPoul-Henning Kamp#
242731a539a5SHellmuth Michaelis#---------------------------------------------------------------------------
242831a539a5SHellmuth Michaelis#	ISDN devices - mandatory for all hardware drivers
242919c74962SPoul-Henning Kamp#
243019c74962SPoul-Henning Kamp# userland driver to do ISDN tracing (for passive cards only)
2431f71c01ccSPeter Wemmdevice		"i4btrc"	4
243219c74962SPoul-Henning Kamp#
243319c74962SPoul-Henning Kamp# userland driver to control the whole thing
2434f71c01ccSPeter Wemmdevice		"i4bctl"
243519c74962SPoul-Henning Kamp#
243631a539a5SHellmuth Michaelis#---------------------------------------------------------------------------
243731a539a5SHellmuth Michaelis#	ISDN devices - optional
243831a539a5SHellmuth Michaelis#
243919c74962SPoul-Henning Kamp# userland driver for access to raw B channel
2440f71c01ccSPeter Wemmdevice		"i4brbch"	4
244119c74962SPoul-Henning Kamp#
244219c74962SPoul-Henning Kamp# userland driver for telephony
2443f71c01ccSPeter Wemmdevice		"i4btel"	2
244419c74962SPoul-Henning Kamp#
244519c74962SPoul-Henning Kamp# network driver for IP over raw HDLC ISDN
2446f71c01ccSPeter Wemmdevice		"i4bipr"	4
244719c74962SPoul-Henning Kamp# enable VJ header compression detection for ipr i/f
244819c74962SPoul-Henning Kampoptions 	IPR_VJ
2449e5981bd1SHellmuth Michaelis# enable logging of the first n IP packets to isdnd (n=32 here)
2450f71c01ccSPeter Wemmoptions 	IPR_LOG=32
245119c74962SPoul-Henning Kamp#
2452aaf8e082SJoerg Wunsch# network driver for sync PPP over ISDN; requires an equivalent
2453f71c01ccSPeter Wemm# number of sppp device to be configured
2454f71c01ccSPeter Wemmdevice		"i4bisppp"	4
245531a539a5SHellmuth Michaelis#
245631a539a5SHellmuth Michaelis# B-channel inteface to the netgraph subsystem
245731a539a5SHellmuth Michaelisdevice		"i4bing"	2
245831a539a5SHellmuth Michaelis#
245931a539a5SHellmuth Michaelis#---------------------------------------------------------------------------
246019c74962SPoul-Henning Kamp
2461ab4c624bSMike Smith# Parallel-Port Bus
2462ab4c624bSMike Smith#
2463ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
2464ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
2465ab4c624bSMike Smith# are automatically probed and attached when found.
2466ab4c624bSMike Smith#
2467ab4c624bSMike Smith# Supported devices:
2468ab4c624bSMike Smith# vpo	Iomega Zip Drive
2469f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
2470f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
2471fdf94d1aSNicolas Souchu# lpt	Parallel Printer
247246f3ff79SMike Smith# plip	Parallel network interface
2473fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
2474f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
247528ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
2476ab4c624bSMike Smith#
2477ab4c624bSMike Smith# Supported interfaces:
2478ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
2479ab4c624bSMike Smith#
2480ef8f7626SNicolas Souchu
24810f210c92SNicolas Souchuoptions		PPC_PROBE_CHIPSET # Enable chipset specific detection
24820f210c92SNicolas Souchu				  # (see flags in ppc(4))
24835895e3c8SPeter Wemmoptions 	DEBUG_1284	# IEEE1284 signaling protocol debug
24845895e3c8SPeter Wemmoptions 	PERIPH_1284	# Makes your computer act as a IEEE1284
2485ef8f7626SNicolas Souchu				# compliant peripheral
24865895e3c8SPeter Wemmoptions 	DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
24875895e3c8SPeter Wemmoptions 	VP0_DEBUG	# ZIP/ZIP+ debug
24885895e3c8SPeter Wemmoptions 	LPT_DEBUG	# Printer driver debug
24895895e3c8SPeter Wemmoptions 	PPC_DEBUG	# Parallel chipset level debug
24905895e3c8SPeter Wemmoptions 	PLIP_DEBUG	# Parallel network IP interface debug
24913b2d592cSJordan K. Hubbardoptions		PCFCLOCK_VERBOSE         # Verbose pcfclock driver
24923b2d592cSJordan K. Hubbardoptions		PCFCLOCK_MAX_RETRIES=5   # Maximum read tries (default 10)
2493ef8f7626SNicolas Souchu
2494f71c01ccSPeter Wemmdevice		ppc
2495f71c01ccSPeter Wemmhint.ppc.0.at="isa"
2496f71c01ccSPeter Wemmhint.ppc.0.irq="7"
24970d31b179SPeter Wemmdevice		ppbus
24980d31b179SPeter Wemmdevice		vpo
24990d31b179SPeter Wemmdevice		lpt
25000d31b179SPeter Wemmdevice		plip
25010d31b179SPeter Wemmdevice		ppi
25020d31b179SPeter Wemmdevice		pps
25030d31b179SPeter Wemmdevice		lpbb
25040d31b179SPeter Wemmdevice		pcfclock
2505ab4c624bSMike Smith
2506432aad0eSTor Egge# Kernel BOOTP support
2507432aad0eSTor Egge
2508432aad0eSTor Eggeoptions 	BOOTP		# Use BOOTP to obtain IP address/hostname
2509432aad0eSTor Eggeoptions 	BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
25105895e3c8SPeter Wemmoptions 	BOOTP_NFSV3	# Use NFS v3 to NFS mount root
2511432aad0eSTor Eggeoptions 	BOOTP_COMPAT	# Workaround for broken bootp daemons.
25125895e3c8SPeter Wemmoptions 	BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
2513432aad0eSTor Egge
2514d94f38acSEivind Eklund#
2515d94f38acSEivind Eklund# Add tie-ins for a hardware watchdog.  This only enable the hooks;
2516d94f38acSEivind Eklund# the user must still supply the actual driver.
2517d94f38acSEivind Eklund#
2518d94f38acSEivind Eklundoptions 	HW_WDOG
2519d94f38acSEivind Eklund
2520005092bbSEivind Eklund#
2521005092bbSEivind Eklund# Set the number of PV entries per process.  Increasing this can
2522005092bbSEivind Eklund# stop panics related to heavy use of shared memory. However, that can
2523005092bbSEivind Eklund# (combined with large amounts of physical memory) cause panics at
2524005092bbSEivind Eklund# boot time due the kernel running out of VM space.
2525005092bbSEivind Eklund#
2526005092bbSEivind Eklund# If you're tweaking this, you might also want to increase the sysctls
2527005092bbSEivind Eklund# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target".
2528005092bbSEivind Eklund#
252904fa1e6cSEivind Eklund# The value below is the one more than the default.
2530005092bbSEivind Eklund#
25315895e3c8SPeter Wemmoptions 	PMAP_SHPGPERPROC=201
2532005092bbSEivind Eklund
2533c796cfa1SAndrzej Bialecki#
2534c796cfa1SAndrzej Bialecki# Disable swapping. This option removes all code which actually performs
2535c796cfa1SAndrzej Bialecki# swapping, so it's not possible to turn it back on at run-time.
2536c796cfa1SAndrzej Bialecki#
2537c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2538c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2539c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2540c796cfa1SAndrzej Bialecki#
254119dde963SPeter Wemm#options 	NO_SWAPPING
2542c796cfa1SAndrzej Bialecki
25439dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
25449dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
25459dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
25469dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
25479dab0776SDavid Greenman#
25485895e3c8SPeter Wemmoptions 	NSFBUFS=1024
25499dab0776SDavid Greenman
255015a1057cSEivind Eklund#
2551053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2552ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2553053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2554053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2555053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2556053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
255715a1057cSEivind Eklund#
255815a1057cSEivind Eklundoptions 	DEBUG_LOCKS
255915a1057cSEivind Eklund
256026086a03SPeter Wemm
256126086a03SPeter Wemm#####################################################################
256226086a03SPeter Wemm# ABI Emulation
256326086a03SPeter Wemm
256426086a03SPeter Wemm# Enable iBCS2 runtime support for SCO and ISC binaries
256526086a03SPeter Wemmoptions 	IBCS2
256626086a03SPeter Wemm
256726086a03SPeter Wemm# Emulate spx device for client side of SVR3 local X interface
256826086a03SPeter Wemmoptions 	SPX_HACK
256926086a03SPeter Wemm
257026086a03SPeter Wemm# Enable Linux ABI emulation
257126086a03SPeter Wemmoptions 	COMPAT_LINUX
257226086a03SPeter Wemm
25735a44842bSMark Murray# Enable the linux-like proc filesystem support (requires COMPAT_LINUX)
25745a44842bSMark Murrayoptions 	LINPROCFS
25755a44842bSMark Murray
257626086a03SPeter Wemm# Linux debugging
257726086a03SPeter Wemmoptions 	DEBUG_LINUX
257826086a03SPeter Wemm
25796e2972b8SMark Newton#
25806e2972b8SMark Newton# SysVR4 ABI emulation
25816e2972b8SMark Newton#
25826e2972b8SMark Newton# The svr4 ABI emulator can be statically compiled into the kernel or loaded as
25836e2972b8SMark Newton# a KLD module.
25846e2972b8SMark Newton# The STREAMS network emulation code can also be compiled statically or as a
25856e2972b8SMark Newton# module.  If loaded as a module, it must be loaded before the svr4 module
25866e2972b8SMark Newton# (the /usr/sbin/svr4 script does this for you).  If compiling statically,
2587f71c01ccSPeter Wemm# the `streams' device must be configured into any kernel which also
25886e2972b8SMark Newton# specifies COMPAT_SVR4.  It is possible to have a statically-configured
25896e2972b8SMark Newton# STREAMS device and a dynamically loadable svr4 emulator;  the /usr/sbin/svr4
25906e2972b8SMark Newton# script understands that it doesn't need to load the `streams' module under
25916e2972b8SMark Newton# those circumstances.
25926e2972b8SMark Newton# Caveat:  At this time, `options KTRACE' is required for the svr4 emulator
25936e2972b8SMark Newton# (whether static or dynamic).
25946e2972b8SMark Newton#
25956e2972b8SMark Newtonoptions		COMPAT_SVR4	# build emulator statically
25966e2972b8SMark Newtonoptions		DEBUG_SVR4	# enable verbose debugging
2597f71c01ccSPeter Wemmdevice		streams		# STREAMS network driver (required for svr4).
25986e2972b8SMark Newton
259926086a03SPeter Wemm
260026086a03SPeter Wemm#####################################################################
26011d33cf3dSNick Hibma# USB support
26021d33cf3dSNick Hibma# UHCI controller
2603c9953c3bSPeter Wemmdevice		uhci
26041d33cf3dSNick Hibma# OHCI controller
2605c9953c3bSPeter Wemmdevice		ohci
26061d33cf3dSNick Hibma# General USB code (mandatory for USB)
2607c9953c3bSPeter Wemmdevice		usb
26081d33cf3dSNick Hibma#
2609b5ea1f0cSNick Hibma# USB Double Bulk Pipe devices
2610b5ea1f0cSNick Hibmadevice		udbp
2611f26c33d2SNick Hibma# Generic USB device driver
2612c9953c3bSPeter Wemmdevice		ugen
2613f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2614c9953c3bSPeter Wemmdevice		uhid
26151d33cf3dSNick Hibma# USB keyboard
2616c9953c3bSPeter Wemmdevice		ukbd
26171d33cf3dSNick Hibma# USB printer
2618c9953c3bSPeter Wemmdevice		ulpt
2619f26c33d2SNick Hibma# USB Iomega Zip 100 Drive
2620c9953c3bSPeter Wemmdevice		umass
2621e9fb12d3SNick Hibma# USB modem support
2622e9fb12d3SNick Hibmadevice		umodem
2623f26c33d2SNick Hibma# USB mouse
2624c9953c3bSPeter Wemmdevice		ums
2625e2dbd15fSNick Hibma# Diamond Rio 500 Mp3 player
2626e2dbd15fSNick Hibmadevice		urio
26272fd84f56SNick Hibma# USB scanners
26282fd84f56SNick Hibmadevice		uscanner
2629f26c33d2SNick Hibma#
2630ed63a7aaSBill Paul# ADMtek USB ethernet. Supports the LinkSys USB100TX,
2631d04bb221SBill Paul# the Billionton USB100, the Melco LU-ATX, the D-Link DSB-650TX
2632d04bb221SBill Paul# and the SMC 2202USB. Also works with the ADMtek AN986 Pegasus
2633d04bb221SBill Paul# eval board.
2634c9953c3bSPeter Wemmdevice		aue
2635dfd1e98eSBill Paul#
263601779872SBill Paul# CATC USB-EL1201A USB ethernet. Supports the CATC Netmate
263701779872SBill Paul# and Netmate II, and the Belkin F5U111.
2638c9953c3bSPeter Wemmdevice		cue
263901779872SBill Paul#
2640dfd1e98eSBill Paul# Kawasaki LSI ethernet. Supports the LinkSys USB10T,
2641d04bb221SBill Paul# Entrega USB-NET-E45, Peracom Ethernet Adapter, the
2642d04bb221SBill Paul# 3Com 3c19250, the ADS Technologies USB-10BT, the ATen UC10T,
264301779872SBill Paul# the Netgear EA101, the D-Link DSB-650, the SMC 2102USB
264401779872SBill Paul# and 2104USB, and the Corega USB-T.
2645c9953c3bSPeter Wemmdevice		kue
2646f26c33d2SNick Hibma
2647f26c33d2SNick Hibma# debugging options for the USB subsystem
26481d33cf3dSNick Hibma#
26497dc1a5bdSNick Hibmaoptions 	UHCI_DEBUG
26507dc1a5bdSNick Hibmaoptions 	OHCI_DEBUG
26511d33cf3dSNick Hibmaoptions 	USB_DEBUG
2652f26c33d2SNick Hibma
26537dc1a5bdSNick Hibmaoptions 	UGEN_DEBUG
2654f26c33d2SNick Hibmaoptions 	UHID_DEBUG
2655f26c33d2SNick Hibmaoptions 	UHUB_DEBUG
2656f26c33d2SNick Hibmaoptions 	UKBD_DEBUG
26577dc1a5bdSNick Hibmaoptions 	ULPT_DEBUG
2658f26c33d2SNick Hibmaoptions 	UMASS_DEBUG
2659f26c33d2SNick Hibmaoptions 	UMS_DEBUG
2660e2dbd15fSNick Hibmaoptions 	URIO_DEBUG
2661f26c33d2SNick Hibma
26626e8394b8SKazutaka YOKOTA# options for ukbd:
26636e8394b8SKazutaka YOKOTAoptions 	UKBD_DFLT_KEYMAP	# specify the built-in keymap
2664cc6c2ad0SPeter Wemmmakeoptions	UKBD_DFLT_KEYMAP=it.iso
26656e8394b8SKazutaka YOKOTA
2666785d2100SJohn Birrell#
2667785d2100SJohn Birrell# Embedded system options:
2668785d2100SJohn Birrell#
2669785d2100SJohn Birrell# An embedded system might want to run something other than init.
26708a13a924SJohn Birrelloptions 	INIT_PATH="/sbin/init:/stand/sysinstall"
2671bc0e3a03SJeroen Ruigrok van der Werven
2672bc0e3a03SJeroen Ruigrok van der Werven# Debug options
2673bc0e3a03SJeroen Ruigrok van der Wervenoptions 	BUS_DEBUG	# enable newbus debugging
2674bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG_VFS_LOCKS	# enable vfs lock debugging
2675bc0e3a03SJeroen Ruigrok van der Wervenoptions 	NPX_DEBUG	# enable npx debugging (FPU/math emu)
2676bc0e3a03SJeroen Ruigrok van der Werven
2677446af86dSJohn Baldwin#####################################################################
2678446af86dSJohn Baldwin# SYSV IPC KERNEL PARAMETERS
2679446af86dSJohn Baldwin#
2680446af86dSJohn Baldwin# Maximum number of entries in a semaphore map.
2681446af86dSJohn Baldwinoptions 	SEMMAP=31
2682446af86dSJohn Baldwin
2683446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used on the system at
2684446af86dSJohn Baldwin# one time.
2685446af86dSJohn Baldwinoptions 	SEMMNI=11
2686446af86dSJohn Baldwin
2687446af86dSJohn Baldwin# Total number of semaphores system wide
2688446af86dSJohn Baldwinoptions 	SEMMNS=61
2689446af86dSJohn Baldwin
2690446af86dSJohn Baldwin# Total number of undo structures in system
2691446af86dSJohn Baldwinoptions 	SEMMNU=31
2692446af86dSJohn Baldwin
2693446af86dSJohn Baldwin# Maximum number of System V semaphores that can be used by a single process
2694446af86dSJohn Baldwin# at one time.
2695446af86dSJohn Baldwinoptions 	SEMMSL=61
2696446af86dSJohn Baldwin
2697446af86dSJohn Baldwin# Maximum number of operations that can be outstanding on a single System V
2698446af86dSJohn Baldwin# semaphore at one time.
2699446af86dSJohn Baldwinoptions 	SEMOPM=101
2700446af86dSJohn Baldwin
2701446af86dSJohn Baldwin# Maximum number of undo operations that can be outstanding on a single
2702446af86dSJohn Baldwin# System V semaphore at one time.
2703446af86dSJohn Baldwinoptions 	SEMUME=11
2704446af86dSJohn Baldwin
2705446af86dSJohn Baldwin# Maximum number of shared memory pages system wide.
2706446af86dSJohn Baldwinoptions 	SHMALL=1025
2707446af86dSJohn Baldwin
2708446af86dSJohn Baldwin# Maximum size, in bytes, of a single System V shared memory region.
2709446af86dSJohn Baldwinoptions 	SHMMAX="(SHMMAXPGS*PAGE_SIZE+1)"
2710446af86dSJohn Baldwinoptions 	SHMMAXPGS=1025
2711446af86dSJohn Baldwin
2712446af86dSJohn Baldwin# Minimum size, in bytes, of a single System V shared memory region.
2713446af86dSJohn Baldwinoptions 	SHMMIN=2
2714446af86dSJohn Baldwin
2715446af86dSJohn Baldwin# Maximum number of shared memory regions that can be used on the system
2716446af86dSJohn Baldwin# at one time.
2717446af86dSJohn Baldwinoptions 	SHMMNI=33
2718446af86dSJohn Baldwin
2719446af86dSJohn Baldwin# Maximum number of System V shared memory regions that can be attached to
2720446af86dSJohn Baldwin# a single process at one time.
2721446af86dSJohn Baldwinoptions 	SHMSEG=9
2722446af86dSJohn Baldwin
2723446af86dSJohn Baldwin#####################################################################
2724446af86dSJohn Baldwin
2725bc0e3a03SJeroen Ruigrok van der Werven# More undocumented options for linting.
2726bc0e3a03SJeroen Ruigrok van der Werven# Note that documenting these are not considered an affront.
2727bc0e3a03SJeroen Ruigrok van der Werven
2728bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CAM_DEBUG_DELAY
272928d7984fSJeroen Ruigrok van der Werven
273028d7984fSJeroen Ruigrok van der Werven# VFS cluster debugging.
2731bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CLUSTERDEBUG
273228d7984fSJeroen Ruigrok van der Werven
273328d7984fSJeroen Ruigrok van der Werven# Eliminate unneeded cache flush instruction(s).
2734bc0e3a03SJeroen Ruigrok van der Wervenoptions 	CPU_UPGRADE_HW_CACHE
273528d7984fSJeroen Ruigrok van der Werven
2736bc0e3a03SJeroen Ruigrok van der Wervenoptions 	DEBUG
27378b6f5e65SJeroen Ruigrok van der Werven
2738bffb191eSTakanori Watanabe# PECOFF module (Win32 Execution Format)
2739bffb191eSTakanori Watanabeoptions		PECOFF_SUPPORT
2740bffb191eSTakanori Watanabeoptions		PECOFF_DEBUG
27418b6f5e65SJeroen Ruigrok van der Werven
2742a88d714cSJeroen Ruigrok van der Werven# Disable the 4 MByte PSE CPU feature.
2743bc0e3a03SJeroen Ruigrok van der Werven#options 	DISABLE_PSE
27448b6f5e65SJeroen Ruigrok van der Werven
2745bc0e3a03SJeroen Ruigrok van der Wervenoptions 	ENABLE_ALART
2746bc0e3a03SJeroen Ruigrok van der Wervenoptions 	I4B_SMP_WORKAROUND
2747bc0e3a03SJeroen Ruigrok van der Wervenoptions 	I586_PMC_GUPROF=0x70000
2748bc0e3a03SJeroen Ruigrok van der Wervenoptions 	KBDIO_DEBUG=2
2749bc0e3a03SJeroen Ruigrok van der Wervenoptions 	KBD_MAXRETRY=4
2750bc0e3a03SJeroen Ruigrok van der Wervenoptions 	KBD_MAXWAIT=6
2751bc0e3a03SJeroen Ruigrok van der Wervenoptions 	KBD_RESETDELAY=201
2752edd5302dSJeroen Ruigrok van der Werven
2753edd5302dSJeroen Ruigrok van der Werven# Enable the PF_KEY Key Management API.
2754bc0e3a03SJeroen Ruigrok van der Wervenoptions 	KEY
275528d7984fSJeroen Ruigrok van der Werven
275628d7984fSJeroen Ruigrok van der Werven# Kernel filelock debugging.
2757bc0e3a03SJeroen Ruigrok van der Wervenoptions 	LOCKF_DEBUG
275828d7984fSJeroen Ruigrok van der Werven
27598b6f5e65SJeroen Ruigrok van der Werven# System V compatible message queues
27608b6f5e65SJeroen Ruigrok van der Werven# Please note that the values provided here are used to test kernel
27618b6f5e65SJeroen Ruigrok van der Werven# building.  The defaults in the sources provide almost the same numbers.
27628b6f5e65SJeroen Ruigrok van der Werven# MSGSSZ must be a power of 2 between 8 and 1024.
27638b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNB=2049	# Max number of chars in queue
27648b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGMNI=41	# Max number of message queue identifiers
27658b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSEG=2049	# Max number of message segments
27668b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGSSZ=16	# Size of a message segment
27678b6f5e65SJeroen Ruigrok van der Wervenoptions 	MSGTQL=41	# Max number of messages in system
27688b6f5e65SJeroen Ruigrok van der Werven
27698b6f5e65SJeroen Ruigrok van der Wervenoptions 	NBUF=512	# Number of buffer headers
27708b6f5e65SJeroen Ruigrok van der Werven
27718b6f5e65SJeroen Ruigrok van der Wervenoptions 	NMBCLUSTERS=1024	# Number of mbuf clusters
27728b6f5e65SJeroen Ruigrok van der Werven
2773bc0e3a03SJeroen Ruigrok van der Wervenoptions 	PANIC_REBOOT_WAIT_TIME=16
27748b6f5e65SJeroen Ruigrok van der Werven
2775bc0e3a03SJeroen Ruigrok van der Wervenoptions 	PSM_DEBUG=1
27768b6f5e65SJeroen Ruigrok van der Werven
2777bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_DEBUG
2778bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_SYNC=10000
2779bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MAX_WIDE=1
2780bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SCSI_NCR_MYADDR=7
27818b6f5e65SJeroen Ruigrok van der Werven
27828b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_DEBUG_LEVEL=5	# Syscons debug level
27838b6f5e65SJeroen Ruigrok van der Wervenoptions 	SC_RENDER_DEBUG	# syscons rendering debugging
27848b6f5e65SJeroen Ruigrok van der Werven
2785bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SHOW_BUSYBUFS	# List buffers that prevent root unmount
2786bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SIMPLELOCK_DEBUG
2787bc0e3a03SJeroen Ruigrok van der Wervenoptions 	SLIP_IFF_OPTS
2788bc0e3a03SJeroen Ruigrok van der Wervenoptions 	TIMER_FREQ="((14318182+6)/12)"
27898b6f5e65SJeroen Ruigrok van der Wervenoptions 	VFS_BIO_DEBUG	# VFS buffer I/O debugging
27908b6f5e65SJeroen Ruigrok van der Werven
2791bc0e3a03SJeroen Ruigrok van der Wervenoptions 	VM_KMEM_SIZE
2792bc0e3a03SJeroen Ruigrok van der Wervenoptions 	VM_KMEM_SIZE_MAX
2793bc0e3a03SJeroen Ruigrok van der Wervenoptions 	VM_KMEM_SIZE_SCALE
2794