xref: /freebsd/sys/conf/NOTES (revision b5f3861b6fe737eedff3a643d9d9938f90c04624)
12365e64fSRodney W. Grimes#
22365e64fSRodney W. Grimes# LINT -- config file for checking all the sources, tries to pull in
32365e64fSRodney W. Grimes#	as much of the source tree as it can.
42365e64fSRodney W. Grimes#
5b5f3861bSMatt Jacob#	$Id: LINT,v 1.609 1999/06/24 03:54:54 jlemon Exp $
62365e64fSRodney W. Grimes#
73aa06999SGarrett Wollman# NB: You probably don't want to try running a kernel built from this
83aa06999SGarrett Wollman# file.  Instead, you should start from GENERIC, and add options from
93aa06999SGarrett Wollman# this file as required.
102365e64fSRodney W. Grimes#
112365e64fSRodney W. Grimes
126a8d6623SGarrett Wollman#
136a8d6623SGarrett Wollman# This directive is mandatory; it defines the architecture to be
1456be1833SKATO Takenori# configured for; in this case, the 386 family based IBM-PC and
1556be1833SKATO Takenori# compatibles.
166a8d6623SGarrett Wollman#
175895e3c8SPeter Wemmmachine		i386
182365e64fSRodney W. Grimes
196a8d6623SGarrett Wollman#
206a8d6623SGarrett Wollman# This is the ``identification'' of the kernel.  Usually this should
216a8d6623SGarrett Wollman# be the same as the name of your kernel.
226a8d6623SGarrett Wollman#
236a8d6623SGarrett Wollmanident		LINT
246a8d6623SGarrett Wollman
256a8d6623SGarrett Wollman#
266a8d6623SGarrett Wollman# The `maxusers' parameter controls the static sizing of a number of
276a8d6623SGarrett Wollman# internal system tables by a complicated formula defined in param.c.
286a8d6623SGarrett Wollman#
296a8d6623SGarrett Wollmanmaxusers	10
306a8d6623SGarrett Wollman
316a8d6623SGarrett Wollman#
327bf01a14SPeter Wemm# The `makeoptions' parameter allows variables to be passed to the
337bf01a14SPeter Wemm# generated Makefile in the build area.  DEBUG happens to be magic.
347bf01a14SPeter Wemm# The following is equivalent to 'config -g KERNELNAME' and creates
357bf01a14SPeter Wemm# 'kernel.debug' compiled with -g debugging as well as a normal
367bf01a14SPeter Wemm# 'kernel'.  Use 'make install.debug' to install the debug kernel
377bf01a14SPeter Wemm# but that isn't normally necessary as the debug symbols are not loaded
387bf01a14SPeter Wemm# by the kernel and are not useful there anyway.
397bf01a14SPeter Wemm#
402c8635c6SPeter Wemm# KERNEL can be overridden so that you can change the default name of your
412c8635c6SPeter Wemm# kernel.
422c8635c6SPeter Wemm#
435895e3c8SPeter Wemm#makeoptions	DEBUG=-g		#Build kernel with gdb(1) debug symbols
442c8635c6SPeter Wemm#makeoptions	KERNEL=foo		#Build kernel "foo" and install "/foo"
457bf01a14SPeter Wemm
467bf01a14SPeter Wemm#
47d43f0f0aSJohn Dyson# Certain applications can grow to be larger than the 128M limit
48d43f0f0aSJohn Dyson# that FreeBSD initially imposes.  Below are some options to
49d43f0f0aSJohn Dyson# allow that limit to grow to 256MB, and can be increased further
50d43f0f0aSJohn Dyson# with changing the parameters.  MAXDSIZ is the maximum that the
51d43f0f0aSJohn Dyson# limit can be set to, and the DFLDSIZ is the default value for
52d43f0f0aSJohn Dyson# the limit.  You might want to set the default lower than the
53d43f0f0aSJohn Dyson# max, and explicitly set the maximum with a shell command for processes
54d43f0f0aSJohn Dyson# that regularly exceed the limit like INND.
55d43f0f0aSJohn Dyson#
565895e3c8SPeter Wemmoptions		MAXDSIZ="(256*1024*1024)"
575895e3c8SPeter Wemmoptions		DFLDSIZ="(256*1024*1024)"
58d43f0f0aSJohn Dyson
5920f71813SJohn-Mark Gurney# Options for the VM subsystem
6020f71813SJohn-Mark Gurney#options	PQ_NOOPT		# No coloring
6120f71813SJohn-Mark Gurneyoptions		PQ_LARGECACHE		# color for 512k/16k cache
6220f71813SJohn-Mark Gurney#options	PQ_HUGECACHE		# color for 1024k/16k cache
6320f71813SJohn-Mark Gurney
64827d623eSJordan K. Hubbard# This allows you to actually store this configuration file into
65827d623eSJordan K. Hubbard# the kernel binary itself, where it may be later read by saying:
6671c1bf9fSJoseph Koshy#    strings -aout -n 3 /kernel | grep ^___ | sed -e 's/^___//' > MYKERNEL
67827d623eSJordan K. Hubbard#
68827d623eSJordan K. Hubbardoptions         INCLUDE_CONFIG_FILE     # Include this file in kernel
69827d623eSJordan K. Hubbard
706a8d6623SGarrett Wollman
716a8d6623SGarrett Wollman#####################################################################
72477a642cSPeter Wemm# SMP OPTIONS:
73477a642cSPeter Wemm#
74477a642cSPeter Wemm# SMP enables building of a Symmetric MultiProcessor Kernel.
75477a642cSPeter Wemm# APIC_IO enables the use of the IO APIC for Symmetric I/O.
76477a642cSPeter Wemm# NCPU sets the number of CPUs, defaults to 2.
77477a642cSPeter Wemm# NBUS sets the number of busses, defaults to 4.
78477a642cSPeter Wemm# NAPIC sets the number of IO APICs on the motherboard, defaults to 1.
79477a642cSPeter Wemm# NINTR sets the total number of INTs provided by the motherboard.
80477a642cSPeter Wemm#
81477a642cSPeter Wemm# Notes:
82477a642cSPeter Wemm#
83477a642cSPeter Wemm#  An SMP kernel will ONLY run on an Intel MP spec. qualified motherboard.
84477a642cSPeter Wemm#
855895e3c8SPeter Wemm#  Be sure to disable 'cpu I386_CPU' && 'cpu I486_CPU' for SMP kernels.
86477a642cSPeter Wemm#
87477a642cSPeter Wemm#  Check the 'Rogue SMP hardware' section to see if additional options
88477a642cSPeter Wemm#   are required by your hardware.
89477a642cSPeter Wemm#
90477a642cSPeter Wemm
91477a642cSPeter Wemm# Mandatory:
92477a642cSPeter Wemmoptions		SMP			# Symmetric MultiProcessor Kernel
93477a642cSPeter Wemmoptions		APIC_IO			# Symmetric (APIC) I/O
94477a642cSPeter Wemm
9506daa051SBruce Evans# Optional, these are the defaults plus 1:
9625717e99SSteve Passeoptions		NCPU=5			# number of CPUs
9706daa051SBruce Evansoptions		NBUS=5			# number of busses
9806daa051SBruce Evansoptions		NAPIC=2			# number of IO APICs
9906daa051SBruce Evansoptions		NINTR=25		# number of INTs
100477a642cSPeter Wemm
101477a642cSPeter Wemm#
102477a642cSPeter Wemm# Rogue SMP hardware:
103477a642cSPeter Wemm#
104477a642cSPeter Wemm
105477a642cSPeter Wemm# Bridged PCI cards:
106477a642cSPeter Wemm#
107477a642cSPeter Wemm# The MP tables of most of the current generation MP motherboards
108477a642cSPeter Wemm#  do NOT properly support bridged PCI cards.  To use one of these
109477a642cSPeter Wemm#  cards you should refer to ???
110477a642cSPeter Wemm
111477a642cSPeter Wemm
112477a642cSPeter Wemm#####################################################################
11356be1833SKATO Takenori# CPU OPTIONS
11456be1833SKATO Takenori
11556be1833SKATO Takenori#
11656be1833SKATO Takenori# You must specify at least one CPU (the one you intend to run on);
11756be1833SKATO Takenori# deleting the specification for CPUs you don't need to use may make
11856be1833SKATO Takenori# parts of the system run faster.  This is especially true removing
11956be1833SKATO Takenori# I386_CPU.
12056be1833SKATO Takenori#
1215895e3c8SPeter Wemmcpu		I386_CPU
1225895e3c8SPeter Wemmcpu		I486_CPU
1235895e3c8SPeter Wemmcpu		I586_CPU		# aka Pentium(tm)
1245895e3c8SPeter Wemmcpu		I686_CPU		# aka Pentium Pro(tm)
12556be1833SKATO Takenori
12656be1833SKATO Takenori#
12756be1833SKATO Takenori# Options for CPU features.
12856be1833SKATO Takenori#
12956be1833SKATO Takenori# CPU_BLUELIGHTNING_FPU_OP_CACHE enables FPU operand cache on IBM
13056be1833SKATO Takenori# BlueLightning CPU.  It works only with Cyrix FPU, and this option
13156be1833SKATO Takenori# should not be used with Intel FPU.
13256be1833SKATO Takenori#
13356be1833SKATO Takenori# CPU_BLUELIGHTNING_3X enables triple-clock mode on IBM Blue Lightning
13456be1833SKATO Takenori# CPU if CPU supports it. The default is double-clock mode on
13556be1833SKATO Takenori# BlueLightning CPU box.
13656be1833SKATO Takenori#
13756be1833SKATO Takenori# CPU_BTB_EN enables branch target buffer on Cyrix 5x86 (NOTE 1).
13856be1833SKATO Takenori#
1394962d938SKATO Takenori# CPU_DIRECT_MAPPED_CACHE sets L1 cache of Cyrix 486DLC CPU in direct
1404962d938SKATO Takenori# mapped mode.  Default is 2-way set associative mode.
1414962d938SKATO Takenori#
1426593be60SKATO Takenori# CPU_CYRIX_NO_LOCK enables weak locking for the entire address space
1439b953cf6SDag-Erling Smørgrav# of Cyrix 6x86 and 6x86MX CPUs by setting the NO_LOCK bit of CCR1.
1449b953cf6SDag-Erling Smørgrav# Otherwise, the NO_LOCK bit of CCR1 is cleared.  (NOTE 3)
1456593be60SKATO Takenori#
14656be1833SKATO Takenori# CPU_DISABLE_5X86_LSSER disables load store serialize (i.e. enables
14756be1833SKATO Takenori# reorder).  This option should not be used if you use memory mapped
14856be1833SKATO Takenori# I/O device(s).
14956be1833SKATO Takenori#
15056be1833SKATO Takenori# CPU_FASTER_5X86_FPU enables faster FPU exception handler.
15156be1833SKATO Takenori#
15256be1833SKATO Takenori# CPU_I486_ON_386 enables CPU cache on i486 based CPU upgrade products
15356be1833SKATO Takenori# for i386 machines.
1544962d938SKATO Takenori#
155ec4e5afbSRobert Nordier# CPU_IORT defines I/O clock delay time (NOTE 1).  Default values of
15656be1833SKATO Takenori# I/O clock delay time on Cyrix 5x86 and 6x86 are 0 and 7,respectively
15756be1833SKATO Takenori# (no clock delay).
15856be1833SKATO Takenori#
15956be1833SKATO Takenori# CPU_LOOP_EN prevents flushing the prefetch buffer if the destination
16056be1833SKATO Takenori# of a jump is already present in the prefetch buffer on Cyrix 5x86(NOTE
16156be1833SKATO Takenori# 1).
16256be1833SKATO Takenori#
16356be1833SKATO Takenori# CPU_RSTK_EN enables return stack on Cyrix 5x86 (NOTE 1).
16456be1833SKATO Takenori#
16556be1833SKATO Takenori# CPU_SUSP_HLT enables suspend on HALT.  If this option is set, CPU
16656be1833SKATO Takenori# enters suspend mode following execution of HALT instruction.
16756be1833SKATO Takenori#
1684536af6aSKATO Takenori# CPU_WT_ALLOC enables write allocation on Cyrix 6x86/6x86MX and AMD
1694536af6aSKATO Takenori# K5/K6/K6-2 cpus.
1706593be60SKATO Takenori#
17156be1833SKATO Takenori# CYRIX_CACHE_WORKS enables CPU cache on Cyrix 486 CPUs with cache
17256be1833SKATO Takenori# flush at hold state.
17356be1833SKATO Takenori#
17456be1833SKATO Takenori# CYRIX_CACHE_REALLY_WORKS enables (1) CPU cache on Cyrix 486 CPUs
17556be1833SKATO Takenori# without cache flush at hold state, and (2) write-back CPU cache on
17656be1833SKATO Takenori# Cyrix 6x86 whose revision < 2.7 (NOTE 2).
17756be1833SKATO Takenori#
178b0050656SJohn-Mark Gurney# NO_F00F_HACK disables the hack that prevents Pentiums (and ONLY
179b0050656SJohn-Mark Gurney# Pentiums) from locking up when a LOCK CMPXCHG8B instruction is
180b0050656SJohn-Mark Gurney# executed.  This should be included for ALL kernels that won't run
181b0050656SJohn-Mark Gurney# on a Pentium.
182b0050656SJohn-Mark Gurney#
183925f3681SMike Smith# NO_MEMORY_HOLE is an optimisation for systems with AMD K6 processors
184925f3681SMike Smith# which indicates that the 15-16MB range is *definitely* not being
185925f3681SMike Smith# occupied by an ISA memory hole.
186925f3681SMike Smith#
18756be1833SKATO Takenori# NOTE 1: The options, CPU_BTB_EN, CPU_LOOP_EN, CPU_IORT,
188ec4e5afbSRobert Nordier# CPU_LOOP_EN and CPU_RSTK_EN should not be used because of CPU bugs.
18956be1833SKATO Takenori# These options may crash your system.
19056be1833SKATO Takenori#
19156be1833SKATO Takenori# NOTE 2: If CYRIX_CACHE_REALLY_WORKS is not set, CPU cache is enabled
19256be1833SKATO Takenori# in write-through mode when revision < 2.7.  If revision of Cyrix
19356be1833SKATO Takenori# 6x86 >= 2.7, CPU cache is always enabled in write-back mode.
19456be1833SKATO Takenori#
1956593be60SKATO Takenori# NOTE 3: This option may cause failures for software that requires
1966593be60SKATO Takenori# locked cycles in order to operate correctly.
1976593be60SKATO Takenori#
1985895e3c8SPeter Wemmoptions		CPU_BLUELIGHTNING_FPU_OP_CACHE
1995895e3c8SPeter Wemmoptions		CPU_BLUELIGHTNING_3X
2005895e3c8SPeter Wemmoptions		CPU_BTB_EN
2015895e3c8SPeter Wemmoptions		CPU_DIRECT_MAPPED_CACHE
2025895e3c8SPeter Wemmoptions		CPU_DISABLE_5X86_LSSER
2035895e3c8SPeter Wemmoptions		CPU_FASTER_5X86_FPU
2045895e3c8SPeter Wemmoptions		CPU_I486_ON_386
2055895e3c8SPeter Wemmoptions		CPU_IORT
2065895e3c8SPeter Wemmoptions		CPU_LOOP_EN
2075895e3c8SPeter Wemmoptions		CPU_RSTK_EN
2085895e3c8SPeter Wemmoptions		CPU_SUSP_HLT
2095895e3c8SPeter Wemmoptions		CPU_WT_ALLOC
2105895e3c8SPeter Wemmoptions		CYRIX_CACHE_WORKS
2115895e3c8SPeter Wemmoptions		CYRIX_CACHE_REALLY_WORKS
2125895e3c8SPeter Wemm#options	NO_F00F_HACK
21356be1833SKATO Takenori
21456be1833SKATO Takenori#
21556be1833SKATO Takenori# A math emulator is mandatory if you wish to run on hardware which
21656be1833SKATO Takenori# does not have a floating-point processor.  Pick either the original,
21756be1833SKATO Takenori# bogus (but freely-distributable) math emulator, or a much more
21856be1833SKATO Takenori# fully-featured but GPL-licensed emulator taken from Linux.
21956be1833SKATO Takenori#
22056be1833SKATO Takenorioptions		MATH_EMULATE		#Support for x87 emulation
22156be1833SKATO Takenori# Don't enable both of these in a real config.
22256be1833SKATO Takenorioptions		GPL_MATH_EMULATE	#Support for x87 emulation via
22356be1833SKATO Takenori					#new math emulator
22456be1833SKATO Takenori
22556be1833SKATO Takenori
22656be1833SKATO Takenori#####################################################################
2276a8d6623SGarrett Wollman# COMPATIBILITY OPTIONS
228690f540cSAndrey A. Chernov
2296a8d6623SGarrett Wollman#
2306a8d6623SGarrett Wollman# Implement system calls compatible with 4.3BSD and older versions of
23156c7a48cSJordan K. Hubbard# FreeBSD.  You probably do NOT want to remove this as much current code
23256c7a48cSJordan K. Hubbard# still relies on the 4.3 emulation.
2336a8d6623SGarrett Wollman#
2345895e3c8SPeter Wemmoptions		COMPAT_43
2356a8d6623SGarrett Wollman
2366a8d6623SGarrett Wollman#
2376c5e9bbdSMike Pritchard# Allow user-mode programs to manipulate their local descriptor tables.
2386a8d6623SGarrett Wollman# This option is required for the WINE Windows(tm) emulator, and is
2396a8d6623SGarrett Wollman# not used by anything else (that we know of).
2406a8d6623SGarrett Wollman#
2416a8d6623SGarrett Wollmanoptions		USER_LDT		#allow user-level control of i386 ldt
2426a8d6623SGarrett Wollman
2436a8d6623SGarrett Wollman#
2446a8d6623SGarrett Wollman# These three options provide support for System V Interface
2456a8d6623SGarrett Wollman# Definition-style interprocess communication, in the form of shared
2466a8d6623SGarrett Wollman# memory, semaphores, and message queues, respectively.
2476a8d6623SGarrett Wollman#
2486a8d6623SGarrett Wollmanoptions		SYSVSHM
2496a8d6623SGarrett Wollmanoptions		SYSVSEM
2506a8d6623SGarrett Wollmanoptions		SYSVMSG
2516a8d6623SGarrett Wollman
25294801746SPoul-Henning Kamp#
25394801746SPoul-Henning Kamp# This option includes a MD5 routine in the kernel, this is used for
25494801746SPoul-Henning Kamp# various authentication and privacy uses.
25594801746SPoul-Henning Kamp#
2565895e3c8SPeter Wemmoptions		MD5
25794801746SPoul-Henning Kamp
2586a8d6623SGarrett Wollman
2596a8d6623SGarrett Wollman#####################################################################
2606a8d6623SGarrett Wollman# DEBUGGING OPTIONS
2616a8d6623SGarrett Wollman
2626a8d6623SGarrett Wollman#
263b5d89ca8SBruce Evans# Enable the kernel debugger.
2646a8d6623SGarrett Wollman#
265b5d89ca8SBruce Evansoptions		DDB
266b5d89ca8SBruce Evans
267b5d89ca8SBruce Evans#
2685ccab2afSGary Palmer# Don't drop into DDB for a panic. Intended for unattended operation
2695ccab2afSGary Palmer# where you may want to drop to DDB from the console, but still want
2705ccab2afSGary Palmer# the machine to recover from a panic
2715ccab2afSGary Palmer#
2725ccab2afSGary Palmeroptions		DDB_UNATTENDED
2735ccab2afSGary Palmer
2745ccab2afSGary Palmer#
275562d05dfSPaul Traina# If using GDB remote mode to debug the kernel, there's a non-standard
276562d05dfSPaul Traina# extension to the remote protocol that can be used to use the serial
277562d05dfSPaul Traina# port as both the debugging port and the system console.  It's non-
278562d05dfSPaul Traina# standard and you're on your own if you enable it.  See also the
279562d05dfSPaul Traina# "remotechat" variables in the FreeBSD specific version of gdb.
280562d05dfSPaul Traina#
281562d05dfSPaul Trainaoptions		GDB_REMOTE_CHAT
282562d05dfSPaul Traina
283562d05dfSPaul Traina#
2846a8d6623SGarrett Wollman# KTRACE enables the system-call tracing facility ktrace(2).
2856a8d6623SGarrett Wollman#
2862365e64fSRodney W. Grimesoptions		KTRACE			#kernel tracing
28721c64a07SAndrey A. Chernov
2886a8d6623SGarrett Wollman#
2895526d2d9SEivind Eklund# The INVARIANTS option is used in a number of source files to enable
2906a8d6623SGarrett Wollman# extra sanity checking of internal structures.  This support is not
2916a8d6623SGarrett Wollman# enabled by default because of the extra time it would take to check
2926a8d6623SGarrett Wollman# for these conditions, which can only occur as a result of
2936a8d6623SGarrett Wollman# programming errors.
2946a8d6623SGarrett Wollman#
2955526d2d9SEivind Eklundoptions		INVARIANTS
2965526d2d9SEivind Eklund
2975526d2d9SEivind Eklund#
2985526d2d9SEivind Eklund# The INVARIANT_SUPPORT option makes us compile in support for
2995526d2d9SEivind Eklund# verifying some of the internal structures.  It is a prerequisite for
3005526d2d9SEivind Eklund# 'INVARIANTS', as enabling 'INVARIANTS' will make these functions be
3015526d2d9SEivind Eklund# called.  The intent is that you can set 'INVARIANTS' for single
3025526d2d9SEivind Eklund# source files (by changing the source file or specifying it on the
3035526d2d9SEivind Eklund# command line) if you have 'INVARIANT_SUPPORT' enabled.
3045526d2d9SEivind Eklund#
3055526d2d9SEivind Eklundoptions		INVARIANT_SUPPORT
3065526d2d9SEivind Eklund
3075526d2d9SEivind Eklund#
3085526d2d9SEivind Eklund# The DIAGNOSTIC option is used to enable extra debugging information
3095526d2d9SEivind Eklund# from some parts of the kernel.  As this makes everything more noisy,
3105526d2d9SEivind Eklund# it is disabled by default.
3115526d2d9SEivind Eklund#
3120dc7d907SPoul-Henning Kampoptions		DIAGNOSTIC
313da59a31cSDavid Greenman
3140dd1eea1SJordan K. Hubbard#
315348acd94SGarrett Wollman# PERFMON causes the driver for Pentium/Pentium Pro performance counters
316348acd94SGarrett Wollman# to be compiled.  See perfmon(4) for more information.
317348acd94SGarrett Wollman#
318348acd94SGarrett Wollmanoptions		PERFMON
319348acd94SGarrett Wollman
320346ebe51SEivind Eklund
321346ebe51SEivind Eklund#
322346ebe51SEivind Eklund# This option let some drivers co-exist that can't co-exist in a running
323346ebe51SEivind Eklund# system.  This is used to be able to compile all kernel code in one go for
324346ebe51SEivind Eklund# quality assurance purposes (like this file, which the option takes it name
325346ebe51SEivind Eklund# from.)
326346ebe51SEivind Eklund#
327346ebe51SEivind Eklundoptions COMPILING_LINT
328346ebe51SEivind Eklund
329346ebe51SEivind Eklund
330348acd94SGarrett Wollman# XXX - this doesn't belong here.
3310dd1eea1SJordan K. Hubbard# Allow ordinary users to take the console - this is useful for X.
3320dd1eea1SJordan K. Hubbardoptions		UCONSOLE
3330dd1eea1SJordan K. Hubbard
33496fc6efbSPoul-Henning Kamp# XXX - this doesn't belong here either
33596fc6efbSPoul-Henning Kampoptions		USERCONFIG		#boot -c editor
336ed91f3baSMike Smithoptions		INTRO_USERCONFIG	#imply -c and show intro screen
33796fc6efbSPoul-Henning Kampoptions		VISUAL_USERCONFIG	#visual boot -c editor
338b307e58fSPoul-Henning Kamp
339b307e58fSPoul-Henning Kamp# XXX - neither does this
340b307e58fSPoul-Henning Kampoptions		ROOTDEVNAME=\"da0s2e\"
3416a8d6623SGarrett Wollman
3426a8d6623SGarrett Wollman#####################################################################
3436a8d6623SGarrett Wollman# NETWORKING OPTIONS
34470c0b54cSAndrey A. Chernov
3456a8d6623SGarrett Wollman#
3466a8d6623SGarrett Wollman# Protocol families:
3476a8d6623SGarrett Wollman#  Only the INET (Internet) family is officially supported in FreeBSD.
34811bfa65aSBruce Evans#  Source code for the NS (Xerox Network Service) is provided for amusement
34911bfa65aSBruce Evans#  value.
3506a8d6623SGarrett Wollman#
3516a8d6623SGarrett Wollmanoptions		INET			#Internet communications protocols
352f73bbaf2SDavid Greenman
353cc6a66f2SJulian Elischeroptions		IPX			#IPX/SPX communications protocols
354cc6a66f2SJulian Elischeroptions		IPXIP			#IPX in IP encapsulation (not available)
355cc6a66f2SJulian Elischeroptions		IPTUNNEL		#IP in IPX encapsulation (not available)
356cc6a66f2SJulian Elischer
35734b5fca7SJulian Elischeroptions		NETATALK		#Appletalk communications protocols
35834b5fca7SJulian Elischer
35911bfa65aSBruce Evans# These are currently broken but are shipped due to interest.
36011bfa65aSBruce Evans#options		NS			#Xerox NS protocols
36111bfa65aSBruce Evans
362bba9a7a0SGarrett Wollman# These are currently broken and are no longer shipped due to lack
363bba9a7a0SGarrett Wollman# of interest.
364bba9a7a0SGarrett Wollman#options		CCITT			#X.25 network layer
365f73bbaf2SDavid Greenman#options		ISO
366f73bbaf2SDavid Greenman#options		TPIP			#ISO TP class 4 over IP
367f73bbaf2SDavid Greenman#options		TPCONS			#ISO TP class 0 over X.25
368bba9a7a0SGarrett Wollman#options		LLC			#X.25 link layer for Ethernets
369bba9a7a0SGarrett Wollman#options		HDLC			#X.25 link layer for serial lines
370bba9a7a0SGarrett Wollman#options		EON			#ISO CLNP over IP
371dc915e7cSGarrett Wollman#options		NSIP			#XNS over IP
37263a74862SSteven Wallace
3736a8d6623SGarrett Wollman#
3746a8d6623SGarrett Wollman# Network interfaces:
37556c7a48cSJordan K. Hubbard#  The `loop' pseudo-device is MANDATORY when networking is enabled.
3766a8d6623SGarrett Wollman#  The `ether' pseudo-device provides generic code to handle
37756c7a48cSJordan K. Hubbard#  Ethernets; it is MANDATORY when a Ethernet device driver is
378722012ccSJulian Elischer#  configured or token-ring is enabled.
379d41f24e7SDavid Greenman#  The 'fddi' pseudo-device provides generic code to support FDDI.
38083401efaSGarrett Wollman#  The `sppp' pseudo-device serves a similar role for certain types
381e7c234a1SPeter Wemm#  of synchronous PPP links (like `cx', `ar').
3826a8d6623SGarrett Wollman#  The `sl' pseudo-device implements the Serial Line IP (SLIP) service.
383829b5d55SPeter Wemm#  The `ppp' pseudo-device implements the Point-to-Point Protocol.
384fb46af4fSDag-Erling Smørgrav#  The `bpfilter' pseudo-device enables the Berkeley Packet Filter.  Be
385d29895dcSGarrett Wollman#  aware of the legal and administrative consequences of enabling this
386d29895dcSGarrett Wollman#  option.  The number of devices determines the maximum number of
387d29895dcSGarrett Wollman#  simultaneous BPF clients programs runnable.
38859d8d13fSGarrett Wollman#  The `disc' pseudo-device implements a minimal network interface,
38959d8d13fSGarrett Wollman#  which throws away all packets sent and never receives any.  It is
39059d8d13fSGarrett Wollman#  included for testing purposes.
3917b598cd2SBrian Somers#  The `tun' pseudo-device implements (user-)ppp and nos-tun
392d1721fe1SMark Newton#  The `streams' pseudo-device implements SysVR4 STREAMS emulation.
3936a8d6623SGarrett Wollman#
394829b5d55SPeter Wemm# The PPP_BSDCOMP option enables support for compress(1) style entire
395829b5d55SPeter Wemm# packet compression, the PPP_DEFLATE is for zlib/gzip style compression.
396829b5d55SPeter Wemm# PPP_FILTER enables code for filtering the ppp data stream and selecting
397829b5d55SPeter Wemm# events for resetting the demand dial activity timer - requires bpfilter.
398829b5d55SPeter Wemm# See pppd(8) for more details.
39989327d27SPeter Wemm#
4006a8d6623SGarrett Wollmanpseudo-device	ether			#Generic Ethernet
401722012ccSJulian Elischerpseudo-device	token			#Generic TokenRing
402d41f24e7SDavid Greenmanpseudo-device	fddi			#Generic FDDI
40383401efaSGarrett Wollmanpseudo-device	sppp			#Generic Synchronous PPP
4046a8d6623SGarrett Wollmanpseudo-device	loop			#Network loopback device
405fb46af4fSDag-Erling Smørgravpseudo-device	bpfilter 4		#Berkeley packet filter
406829b5d55SPeter Wemmpseudo-device	disc			#Discard device
4077b598cd2SBrian Somerspseudo-device	tun	1		#Tunnel driver (ppp(8), nos-tun(8))
4086a8d6623SGarrett Wollmanpseudo-device	sl	2		#Serial Line IP
4096a8d6623SGarrett Wollmanpseudo-device	ppp	2		#Point-to-point protocol
410d1721fe1SMark Newtonpseudo-device	streams
41189327d27SPeter Wemmoptions PPP_BSDCOMP			#PPP BSD-compress support
41289327d27SPeter Wemmoptions PPP_DEFLATE			#PPP zlib/deflate/gzip support
41396be526aSPeter Wemmoptions PPP_FILTER			#enable bpf filtering (needs bpfilter)
414d29895dcSGarrett Wollman
4156a8d6623SGarrett Wollman#
4166a8d6623SGarrett Wollman# Internet family options:
4176a8d6623SGarrett Wollman#
4186a8d6623SGarrett Wollman# TCP_COMPAT_42 causes the TCP code to emulate certain bugs present in
4196a8d6623SGarrett Wollman# 4.2BSD.  This option should not be used unless you have a 4.2BSD
4206a8d6623SGarrett Wollman# machine and TCP connections fail.
4216a8d6623SGarrett Wollman#
4226a8d6623SGarrett Wollman# MROUTING enables the kernel multicast packet forwarder, which works
4236a8d6623SGarrett Wollman# with mrouted(8).
4246a8d6623SGarrett Wollman#
425d29895dcSGarrett Wollman# IPFIREWALL enables support for IP firewall construction, in
426ff6f025aSAlexander Langer# conjunction with the `ipfw' program.  IPFIREWALL_VERBOSE sends
427ff6f025aSAlexander Langer# logged packets to the system logger.  IPFIREWALL_VERBOSE_LIMIT
428ff6f025aSAlexander Langer# limits the number of times a matching entry can be logged.
429ab6e02daSJordan K. Hubbard#
430ab6e02daSJordan K. Hubbard# WARNING:  IPFIREWALL defaults to a policy of "deny ip from any to any"
431ab6e02daSJordan K. Hubbard# and if you do not add other rules during startup to allow access,
432ab6e02daSJordan K. Hubbard# YOU WILL LOCK YOURSELF OUT.  It is suggested that you set firewall=open
433ab6e02daSJordan K. Hubbard# in /etc/rc.conf when first enabling this feature, then refining the
434ab6e02daSJordan K. Hubbard# firewall rules in /etc/rc.firewall after you've tested that the new kernel
435ab6e02daSJordan K. Hubbard# feature works properly.
4368dd4744eSJordan K. Hubbard#
437ffdd472dSPeter Wemm# IPFIREWALL_DEFAULT_TO_ACCEPT causes the default rule (at boot) to
438ffdd472dSPeter Wemm# allow everything.  Use with care, if a cracker can crash your
439ffdd472dSPeter Wemm# firewall machine, they can get to your protected machines.  However,
440ffdd472dSPeter Wemm# if you are using it as an as-needed filter for specific problems as
441ffdd472dSPeter Wemm# they arise, then this may be for you.  Changing the default to 'allow'
442ffdd472dSPeter Wemm# means that you won't get stuck if the kernel and /sbin/ipfw binary get
443ffdd472dSPeter Wemm# out of sync.
444d29895dcSGarrett Wollman#
44593e0e116SJulian Elischer# IPDIVERT enables the divert IP sockets, used by ``ipfw divert''
44693e0e116SJulian Elischer#
4471689d8bdSPeter Wemm# IPFILTER enables Darren Reed's ipfilter package.
4481689d8bdSPeter Wemm# IPFILTER_LOG enables ipfilter's logging.
4491689d8bdSPeter Wemm# IPFILTER_LKM enables LKM support for an ipfilter module (untested).
4501689d8bdSPeter Wemm#
4511b968362SDag-Erling Smørgrav# IPSTEALTH enables code to support stealth forwarding (i.e., forwarding
4521b968362SDag-Erling Smørgrav# packets without touching the ttl).  This can be useful to hide firewalls
4531b968362SDag-Erling Smørgrav# from traceroute and similar tools.
4541b968362SDag-Erling Smørgrav#
45565e8111fSBruce Evans# TCPDEBUG is undocumented.
45665e8111fSBruce Evans#
4575895e3c8SPeter Wemmoptions		TCP_COMPAT_42		#emulate 4.2BSD TCP bugs
458e3178a06SJordan K. Hubbardoptions		MROUTING		# Multicast routing
459d29895dcSGarrett Wollmanoptions         IPFIREWALL              #firewall
460d29895dcSGarrett Wollmanoptions         IPFIREWALL_VERBOSE      #print information about
461d29895dcSGarrett Wollman					# dropped packets
4621857b6feSDag-Erling Smørgravoptions         IPFIREWALL_FORWARD      #enable transparent proxy support
4635895e3c8SPeter Wemmoptions		IPFIREWALL_VERBOSE_LIMIT=100 #limit verbosity
464e43a9900SAlexander Langeroptions		IPFIREWALL_DEFAULT_TO_ACCEPT #allow everything by default
46593e0e116SJulian Elischeroptions		IPDIVERT		#divert sockets
4661689d8bdSPeter Wemmoptions		IPFILTER		#kernel ipfilter support
4671689d8bdSPeter Wemmoptions		IPFILTER_LOG		#ipfilter logging
4681689d8bdSPeter Wemm#options	IPFILTER_LKM		#kernel support for ip_fil.o LKM
4691b968362SDag-Erling Smørgravoptions		IPSTEALTH		#support for stealth forwarding
47065e8111fSBruce Evansoptions		TCPDEBUG
4716a8d6623SGarrett Wollman
4723b60b6acSMatthew Dillon# ICMP_BANDLIM enables icmp error response bandwidth limiting.   You
4733b60b6acSMatthew Dillon# typically want this option as it will help protect the machine from
4743b60b6acSMatthew Dillon# D.O.S. packet attacks.
4753b60b6acSMatthew Dillon#
4765895e3c8SPeter Wemmoptions         ICMP_BANDLIM
4773b60b6acSMatthew Dillon
47868e9d934SLuigi Rizzo# DUMMYNET enables the "dummynet" bandwidth limiter. You need
47968e9d934SLuigi Rizzo# IPFIREWALL as well. See the dummynet(4) manpage for more info.
48068e9d934SLuigi Rizzo# BRIDGE enables bridging between ethernet cards -- see bridge(4).
48168e9d934SLuigi Rizzo# You can use IPFIREWALL and dummynet together with bridging.
48268ec4eb6SLuigi Rizzooptions	DUMMYNET
48368ec4eb6SLuigi Rizzooptions	BRIDGE
48468e9d934SLuigi Rizzo
4853f8c4506SPoul-Henning Kamp#
4863f8c4506SPoul-Henning Kamp# ATM (HARP version) options
4873f8c4506SPoul-Henning Kamp#
4883f8c4506SPoul-Henning Kamp# ATM_CORE includes the base ATM functionality code.  This must be included
4893f8c4506SPoul-Henning Kamp#	for ATM support.
4903f8c4506SPoul-Henning Kamp#
4913f8c4506SPoul-Henning Kamp# ATM_IP includes support for running IP over ATM.
4923f8c4506SPoul-Henning Kamp#
4933f8c4506SPoul-Henning Kamp# At least one (and usually only one) of the following signalling managers
4943f8c4506SPoul-Henning Kamp# must be included (note that all signalling managers include PVC support):
4953f8c4506SPoul-Henning Kamp# ATM_SIGPVC includes support for the PVC-only signalling manager `sigpvc'.
4963f8c4506SPoul-Henning Kamp# ATM_SPANS includes support for the `spans' signalling manager, which runs
4973f8c4506SPoul-Henning Kamp#	the FORE Systems's proprietary SPANS signalling protocol.
4983f8c4506SPoul-Henning Kamp# ATM_UNI includes support for the `uni30' and `uni31' signalling managers,
4993f8c4506SPoul-Henning Kamp#	which run the ATM Forum UNI 3.x signalling protocols.
5003f8c4506SPoul-Henning Kamp#
5013f8c4506SPoul-Henning Kamp# The `hea' driver provides support for the Efficient Networks, Inc.
5023f8c4506SPoul-Henning Kamp# ENI-155p ATM PCI Adapter.
5033f8c4506SPoul-Henning Kamp#
5043f8c4506SPoul-Henning Kamp# The `hfa' driver provides support for the FORE Systems, Inc.
5053f8c4506SPoul-Henning Kamp# PCA-200E ATM PCI Adapter.
5063f8c4506SPoul-Henning Kamp#
5073f8c4506SPoul-Henning Kampoptions		ATM_CORE		#core ATM protocol family
5083f8c4506SPoul-Henning Kampoptions		ATM_IP			#IP over ATM support
5093f8c4506SPoul-Henning Kampoptions		ATM_SIGPVC		#SIGPVC signalling manager
5103f8c4506SPoul-Henning Kampoptions		ATM_SPANS		#SPANS signalling manager
5113f8c4506SPoul-Henning Kampoptions		ATM_UNI			#UNI signalling manager
5123f8c4506SPoul-Henning Kampdevice		hea0			#Efficient ENI-155p ATM PCI
5133f8c4506SPoul-Henning Kampdevice		hfa0			#FORE PCA-200E ATM PCI
5143f8c4506SPoul-Henning Kamp
5156a8d6623SGarrett Wollman
5166a8d6623SGarrett Wollman#####################################################################
5176a8d6623SGarrett Wollman# FILESYSTEM OPTIONS
518e3178a06SJordan K. Hubbard
5192365e64fSRodney W. Grimes#
5206a8d6623SGarrett Wollman# Only the root, /usr, and /tmp filesystems need be statically
5216a8d6623SGarrett Wollman# compiled; everything else will be automatically loaded at mount
522c5b193bfSPoul-Henning Kamp# time.  (Exception: the UFS family---FFS, and MFS --- cannot
5236a8d6623SGarrett Wollman# currently be demand-loaded.)  Some people still prefer to statically
5246a8d6623SGarrett Wollman# compile other filesystems as well.
5256a8d6623SGarrett Wollman#
526a5b88b01SKATO Takenori# NB: The NULL, PORTAL, UMAP and UNION filesystems are known to be
527a5b88b01SKATO Takenori# buggy, and WILL panic your system if you attempt to do anything with
528a5b88b01SKATO Takenori# them.  They are included here as an incentive for some enterprising
529a5b88b01SKATO Takenori# soul to sit down and fix them.
5302365e64fSRodney W. Grimes#
531f1a9c715SDavid Greenman
5326a8d6623SGarrett Wollman# One of these is mandatory:
5336a8d6623SGarrett Wollmanoptions		FFS			#Fast filesystem
53432a023dcSDavid E. O'Brienoptions		MFS			#Memory File System
5356a8d6623SGarrett Wollmanoptions		NFS			#Network File System
5366a8d6623SGarrett Wollman
5376a8d6623SGarrett Wollman# The rest are optional:
5387c115697SPoul-Henning Kamp# options	NFS_NOSERVER		#Disable the NFS-server code.
5395895e3c8SPeter Wemmoptions		CD9660			#ISO 9660 filesystem
540f1a9c715SDavid Greenmanoptions		FDESC			#File descriptor filesystem
541f1a9c715SDavid Greenmanoptions		KERNFS			#Kernel filesystem
5423f9a6982SDoug Rabsonoptions		MSDOSFS			#MS DOS File System
5433ee9bf69SEivind Eklundoptions		NTFS			#NT File System
544f1a9c715SDavid Greenmanoptions		NULLFS			#NULL filesystem
545f1a9c715SDavid Greenmanoptions		PORTAL			#Portal filesystem
546f1a9c715SDavid Greenmanoptions		PROCFS			#Process filesystem
547f1a9c715SDavid Greenmanoptions		UMAPFS			#UID map filesystem
548f1a9c715SDavid Greenmanoptions		UNION			#Union filesystem
549a788bdc4SDavid E. O'Brien# The xFS_ROOT options REQUIRE the associated ``options xFS''
5505895e3c8SPeter Wemmoptions		CD9660_ROOT		#CD-ROM usable as root device
5517b778b5eSEivind Eklundoptions		FFS_ROOT		#FFS usable as root device
55232a023dcSDavid E. O'Brienoptions		MFS_ROOT		#MFS usable as root device
5537b778b5eSEivind Eklundoptions		NFS_ROOT		#NFS usable as root device
554c796cfa1SAndrzej Bialecki# This code is still experimental (e.g. doesn't handle disk slices well).
555c796cfa1SAndrzej Bialecki# Also, 'options MFS' is currently incompatible with DEVFS.
55646746c3bSJulian Elischeroptions		DEVFS			#devices filesystem
557f1a9c715SDavid Greenman
558f8f8d7afSEivind Eklund# Soft updates is technique for improving file system speed and
559f8f8d7afSEivind Eklund# making abrupt shutdown less risky.  It is not enabled by default due
560f8f8d7afSEivind Eklund# to copyright restraints on the code that implement it.
561f8f8d7afSEivind Eklund#
562a29a2986SRobert Nordier# Read ../../ufs/ffs/README.softupdates to learn what you need to
563f8f8d7afSEivind Eklund# do to enable this.  ../../../contrib/sys/softupdates/README gives
564f8f8d7afSEivind Eklund# more details on how they actually work.
565f8f8d7afSEivind Eklund#
566b1897c19SJulian Elischer#options		SOFTUPDATES
567b1897c19SJulian Elischer
568d52d7365SPoul-Henning Kamp# Make space in the kernel for a MFS root filesystem.  Define to the number
569d52d7365SPoul-Henning Kamp# of kilobytes to reserve for the filesystem.
5701315dabdSBruce Evansoptions		MFS_ROOT_SIZE=10
571a9c94e9bSJohn-Mark Gurney# Allows MFS filesystems to be exported via nfs
572a9c94e9bSJohn-Mark Gurneyoptions		EXPORTMFS
573d52d7365SPoul-Henning Kamp
574a401ebbeSDavid Greenman# Allow this many swap-devices.
575b1529bdaSPeter Wemmoptions		NSWAPDEV=20
576a401ebbeSDavid Greenman
577495967e4SEivind Eklund# Disk quotas are supported when this option is enabled.
5782365e64fSRodney W. Grimesoptions		QUOTA			#enable disk quotas
5796a8d6623SGarrett Wollman
58023d048eeSGary Palmer# Add more checking code to various filesystems
58123d048eeSGary Palmer#options		NULLFS_DIAGNOSTIC
58223d048eeSGary Palmer#options		KERNFS_DIAGNOSTIC
58323d048eeSGary Palmer#options		UMAPFS_DIAGNOSTIC
58423d048eeSGary Palmer#options		UNION_DIAGNOSTIC
58523d048eeSGary Palmer
5865a9714deSJoerg Wunsch# In particular multi-session CD-Rs might require a huge amount of
5875a9714deSJoerg Wunsch# time in order to "settle".  If we are about mounting them as the
5885a9714deSJoerg Wunsch# root f/s, we gotta wait a little.
5895a9714deSJoerg Wunsch#
5905a9714deSJoerg Wunsch# The number is supposed to be in seconds.
5915895e3c8SPeter Wemmoptions		CD9660_ROOTDELAY=20
5925a9714deSJoerg Wunsch
593276756a4SDag-Erling Smørgrav# If you are running a machine just as a fileserver for PC and MAC
594276756a4SDag-Erling Smørgrav# users, using SAMBA or Netatalk, you may consider setting this option
595276756a4SDag-Erling Smørgrav# and keeping all those users' directories on a filesystem that is
596276756a4SDag-Erling Smørgrav# mounted with the suiddir option. This gives new files the same
597ec4e5afbSRobert Nordier# ownership as the directory (similar to group). It's a security hole
5986110161fSDag-Erling Smørgrav# if you let these users run programs, so confine it to file-servers
599276756a4SDag-Erling Smørgrav# (but it'll save you lots of headaches in those cases). Root owned
600276756a4SDag-Erling Smørgrav# directories are exempt and X bits are cleared. The suid bit must be
601276756a4SDag-Erling Smørgrav# set on the directory as well; see chmod(1) PC owners can't see/set
602276756a4SDag-Erling Smørgrav# ownerships so they keep getting their toes trodden on. This saves
603276756a4SDag-Erling Smørgrav# you all the support calls as the filesystem it's used on will act as
604276756a4SDag-Erling Smørgrav# they expect: "It's my dir so it must be my file".
605cb800e34SJulian Elischer#
606cb800e34SJulian Elischeroptions		SUIDDIR
607cb800e34SJulian Elischer
608cb800e34SJulian Elischer
60923d048eeSGary Palmer# Add some error checking code to the null_bypass routine
610c85cfdb2SDavid E. O'Brien# in the NULL filesystem
61123d048eeSGary Palmer#options		SAFETY
61223d048eeSGary Palmer
613df394affSJohn-Mark Gurney
614df394affSJohn-Mark Gurney# NFS options:
6155895e3c8SPeter Wemmoptions		NFS_MINATTRTIMO=3	# VREG attrib cache timeout in sec
6165895e3c8SPeter Wemmoptions		NFS_MAXATTRTIMO=60
6175895e3c8SPeter Wemmoptions		NFS_MINDIRATTRTIMO=30	# VDIR attrib cache timeout in sec
6185895e3c8SPeter Wemmoptions		NFS_MAXDIRATTRTIMO=60
6195895e3c8SPeter Wemmoptions		NFS_GATHERDELAY=10	# Default write gather delay (msec)
6205895e3c8SPeter Wemmoptions		NFS_UIDHASHSIZ=29	# Tune the size of nfssvc_sock with this
6215895e3c8SPeter Wemmoptions		NFS_WDELAYHASHSIZ=16	# and with this
6225895e3c8SPeter Wemmoptions		NFS_MUIDHASHSIZ=63	# Tune the size of nfsmount with this
623df394affSJohn-Mark Gurneyoptions		NFS_DEBUG		# Enable NFS Debugging
624df394affSJohn-Mark Gurney
6259afcea2fSRobert V. Baron# Coda stuff:
6269afcea2fSRobert V. Baronoptions		CODA			#CODA filesystem.
6279afcea2fSRobert V. Baronpseudo-device	vcoda	4		#coda minicache <-> venus comm.
628a1d55890SJordan K. Hubbard
629053a2b61SEivind Eklund#
630053a2b61SEivind Eklund# Add support for the EXT2FS filesystem of Linux fame.  Be a bit
631053a2b61SEivind Eklund# careful with this - the ext2fs code has a tendency to lag behind
632053a2b61SEivind Eklund# changes and not be exercised very much, so mounting read/write could
633053a2b61SEivind Eklund# be dangerous (and even mounting read only could result in panics.)
634053a2b61SEivind Eklund#
6355895e3c8SPeter Wemmoptions		EXT2FS
636053a2b61SEivind Eklund
637053a2b61SEivind Eklund
6386a8d6623SGarrett Wollman
6396a8d6623SGarrett Wollman#####################################################################
640abc97a06SBruce Evans# POSIX P1003.1B
641abc97a06SBruce Evans
642ec4e5afbSRobert Nordier# Real time extensions added in the 1993 Posix
643abc97a06SBruce Evans# P1003_1B: Infrastructure
644abc97a06SBruce Evans# _KPOSIX_PRIORITY_SCHEDULING: Build in _POSIX_PRIORITY_SCHEDULING
645abc97a06SBruce Evans# _KPOSIX_VERSION:             Version kernel is built for
646abc97a06SBruce Evans
6475895e3c8SPeter Wemmoptions		P1003_1B
6485895e3c8SPeter Wemmoptions		_KPOSIX_PRIORITY_SCHEDULING
6495895e3c8SPeter Wemmoptions		_KPOSIX_VERSION=199309L
650abc97a06SBruce Evans
651abc97a06SBruce Evans
652abc97a06SBruce Evans#####################################################################
653de6a307eSPeter Dufault# SCSI DEVICES
654de6a307eSPeter Dufault
6556a8d6623SGarrett Wollman# SCSI DEVICE CONFIGURATION
6566a8d6623SGarrett Wollman
6576a8d6623SGarrett Wollman# The SCSI subsystem consists of the `base' SCSI code, a number of
658ebc1a0e2SPeter Dufault# high-level SCSI device `type' drivers, and the low-level host-adapter
6596a8d6623SGarrett Wollman# device drivers.  The host adapters are listed in the ISA and PCI
6606a8d6623SGarrett Wollman# device configuration sections below.
6616a8d6623SGarrett Wollman#
662265368d4SRodney W. Grimes# Beginning with FreeBSD 2.0.5 you can wire down your SCSI devices so
663ebc1a0e2SPeter Dufault# that a given bus, target, and LUN always come on line as the same
664ebc1a0e2SPeter Dufault# device unit.  In earlier versions the unit numbers were assigned
665ebc1a0e2SPeter Dufault# in the order that the devices were probed on the SCSI bus.  This
666ebc1a0e2SPeter Dufault# means that if you removed a disk drive, you may have had to rewrite
667ebc1a0e2SPeter Dufault# your /etc/fstab file, and also that you had to be careful when adding
668ebc1a0e2SPeter Dufault# a new disk as it may have been probed earlier and moved your device
669ebc1a0e2SPeter Dufault# configuration around.
670ebc1a0e2SPeter Dufault
671ebc1a0e2SPeter Dufault# This old behavior is maintained as the default behavior.  The unit
672ebc1a0e2SPeter Dufault# assignment begins with the first non-wired down unit for a device
673700daf5eSJustin T. Gibbs# type.  For example, if you wire a disk as "da3" then the first
674700daf5eSJustin T. Gibbs# non-wired disk will be assigned da4.
675ebc1a0e2SPeter Dufault
676ebc1a0e2SPeter Dufault# The syntax for wiring down devices is:
677ebc1a0e2SPeter Dufault
6784fbaf9a7SJustin T. Gibbs# controller	scbus0 at ahc0		# Single bus device
6794fbaf9a7SJustin T. Gibbs# controller	scbus1 at ahc1 bus 0	# Single bus device
6804fbaf9a7SJustin T. Gibbs# controller	scbus3 at ahc2 bus 0	# Twin bus device
6814fbaf9a7SJustin T. Gibbs# controller	scbus2 at ahc2 bus 1	# Twin bus device
682700daf5eSJustin T. Gibbs# disk 		da0 at scbus0 target 0 unit 0
683700daf5eSJustin T. Gibbs# disk		da1 at scbus3 target 1
684700daf5eSJustin T. Gibbs# disk		da2 at scbus2 target 3
6854fbaf9a7SJustin T. Gibbs# tape		st1 at scbus1 target 6
686ebc1a0e2SPeter Dufault# device	cd0 at scbus?
687ebc1a0e2SPeter Dufault
688ebc1a0e2SPeter Dufault# "units" (SCSI logical unit number) that are not specified are
689ebc1a0e2SPeter Dufault# treated as if specified as LUN 0.
690ebc1a0e2SPeter Dufault
691ebc1a0e2SPeter Dufault# All SCSI devices allocate as many units as are required.
692ebc1a0e2SPeter Dufault
693265368d4SRodney W. Grimes# The "unknown" device (uk? in pre-2.0.5) is now part of the base SCSI
694ebc1a0e2SPeter Dufault# configuration and doesn't have to be explicitly configured.
695ebc1a0e2SPeter Dufault
6966a8d6623SGarrett Wollmancontroller	scbus0	#base SCSI code
6976a8d6623SGarrett Wollmandevice		ch0	#SCSI media changers
698700daf5eSJustin T. Gibbsdevice		da0	#SCSI direct access devices (aka disks)
699700daf5eSJustin T. Gibbsdevice		sa0	#SCSI tapes
7006a8d6623SGarrett Wollmandevice		cd0	#SCSI CD-ROMs
701700daf5eSJustin T. Gibbs#device		od0	#SCSI optical disk
702700daf5eSJustin T. Gibbsdevice		pass0	#CAM passthrough driver
7036a8d6623SGarrett Wollman
704700daf5eSJustin T. Gibbs# The previous devices (ch, da, st, cd) are recognized by config.
705265368d4SRodney W. Grimes# config doesn't (and shouldn't) know about these newer ones,
706265368d4SRodney W. Grimes# so we have to specify that they are on a SCSI bus with the "at scbus?"
707265368d4SRodney W. Grimes# clause.
708265368d4SRodney W. Grimes
7098909a72bSPeter Dufaultdevice pt0 at scbus?	# SCSI processor type
7108909a72bSPeter Dufaultdevice sctarg0 at scbus? # SCSI target
7118909a72bSPeter Dufault
712700daf5eSJustin T. Gibbs# CAM OPTIONS:
713700daf5eSJustin T. Gibbs# debugging options:
714700daf5eSJustin T. Gibbs# -- NOTE --  If you specify one of the bus/target/lun options, you must
715700daf5eSJustin T. Gibbs#             specify them all!
716700daf5eSJustin T. Gibbs# CAMDEBUG: When defined enables debugging macros
717700daf5eSJustin T. Gibbs# CAM_DEBUG_BUS:  Debug the given bus.  Use -1 to debug all busses.
718700daf5eSJustin T. Gibbs# CAM_DEBUG_TARGET:  Debug the given target.  Use -1 to debug all targets.
719700daf5eSJustin T. Gibbs# CAM_DEBUG_LUN:  Debug the given lun.  Use -1 to debug all luns.
720d05caa00SKenneth D. Merry# CAM_DEBUG_FLAGS:  OR together CAM_DEBUG_INFO, CAM_DEBUG_TRACE,
721d05caa00SKenneth D. Merry#                   CAM_DEBUG_SUBTRACE, and CAM_DEBUG_CDB
722700daf5eSJustin T. Gibbs#
723700daf5eSJustin T. Gibbs# CAM_MAX_HIGHPOWER: Maximum number of concurrent high power (start unit) cmds
724700daf5eSJustin T. Gibbs# SCSI_NO_SENSE_STRINGS: When defined disables sense descriptions
725700daf5eSJustin T. Gibbs# SCSI_NO_OP_STRINGS: When defined disables opcode descriptions
7261a7c583cSGarrett Wollman# SCSI_REPORT_GEOMETRY: Always report disk geometry at boot up instead
727265368d4SRodney W. Grimes#                       of only when booting verbosely.
72856234437SKenneth D. Merry# SCSI_DELAY: The number of MILLISECONDS to freeze the SIM (scsi adapter)
72956234437SKenneth D. Merry#             queue after a bus reset, and the number of milliseconds to
73056234437SKenneth D. Merry#             freeze the device queue after a bus device reset.
731700daf5eSJustin T. Gibbsoptions		CAMDEBUG
7325895e3c8SPeter Wemmoptions		CAM_DEBUG_BUS=-1
7335895e3c8SPeter Wemmoptions		CAM_DEBUG_TARGET=-1
7345895e3c8SPeter Wemmoptions		CAM_DEBUG_LUN=-1
7355895e3c8SPeter Wemmoptions		CAM_DEBUG_FLAGS="CAM_DEBUG_INFO|CAM_DEBUG_TRACE|CAM_DEBUG_CDB"
7365895e3c8SPeter Wemmoptions		CAM_MAX_HIGHPOWER=4
737700daf5eSJustin T. Gibbsoptions		SCSI_NO_SENSE_STRINGS
738700daf5eSJustin T. Gibbsoptions		SCSI_NO_OP_STRINGS
7391a7c583cSGarrett Wollmanoptions		SCSI_REPORT_GEOMETRY
74056234437SKenneth D. Merryoptions		SCSI_DELAY=8000	# Be pessimistic about Joe SCSI device
7411a7c583cSGarrett Wollman
742700daf5eSJustin T. Gibbs# Options for the CAM CDROM driver:
743700daf5eSJustin T. Gibbs# CHANGER_MIN_BUSY_SECONDS: Guaranteed minimum time quantum for a changer LUN
744700daf5eSJustin T. Gibbs# CHANGER_MAX_BUSY_SECONDS: Maximum time quantum per changer LUN, only
745700daf5eSJustin T. Gibbs#                           enforced if there is I/O waiting for another LUN
746700daf5eSJustin T. Gibbs# The compiled in defaults for these variables are 2 and 10 seconds,
747700daf5eSJustin T. Gibbs# respectively.
74893063432SJoerg Wunsch#
749700daf5eSJustin T. Gibbs# These can also be changed on the fly with the following sysctl variables:
750700daf5eSJustin T. Gibbs# kern.cam.cd.changer.min_busy_seconds
751700daf5eSJustin T. Gibbs# kern.cam.cd.changer.max_busy_seconds
75293063432SJoerg Wunsch#
7535895e3c8SPeter Wemmoptions		CHANGER_MIN_BUSY_SECONDS=2
7545895e3c8SPeter Wemmoptions		CHANGER_MAX_BUSY_SECONDS=10
75593063432SJoerg Wunsch
7569dfb4471SKenneth D. Merry# Options for the CAM sequential access driver:
7579dfb4471SKenneth D. Merry# SA_SPACE_TIMEOUT: Timeout for space operations, in minutes
7589dfb4471SKenneth D. Merry# SA_REWIND_TIMEOUT: Timeout for rewind operations, in minutes
7599dfb4471SKenneth D. Merry# SA_ERASE_TIMEOUT: Timeout for erase operations, in minutes
7605895e3c8SPeter Wemmoptions		SA_SPACE_TIMEOUT="(60)"
7615895e3c8SPeter Wemmoptions		SA_REWIND_TIMEOUT="(2*60)"
7625895e3c8SPeter Wemmoptions		SA_ERASE_TIMEOUT="(4*60)"
7639dfb4471SKenneth D. Merry
7646a8d6623SGarrett Wollman
7656a8d6623SGarrett Wollman#####################################################################
7666a8d6623SGarrett Wollman# MISCELLANEOUS DEVICES AND OPTIONS
7676a8d6623SGarrett Wollman
7681160da92SJoerg Wunsch# The `pty' device usually turns out to be ``effectively mandatory'',
7691160da92SJoerg Wunsch# as it is required for `telnetd', `rlogind', `screen', `emacs', and
7701160da92SJoerg Wunsch# `xterm', among others.
7711160da92SJoerg Wunsch
7722aba17b3SGary Palmerpseudo-device	pty	16	#Pseudo ttys - can go as high as 256
7736a8d6623SGarrett Wollmanpseudo-device	speaker		#Play IBM BASIC-style noises out your speaker
7746a8d6623SGarrett Wollmanpseudo-device	gzip		#Exec gzipped a.out's
775784cf072SPoul-Henning Kamppseudo-device	vn		#Vnode driver (turns a file into a device)
7764cba4555SUgen J.S. Antsilevichpseudo-device	snp	3	#Snoop device - to look at pty/vty/etc..
77703b225a3SSatoshi Asamipseudo-device	ccd	4	#Concatenated disk driver
778be174c7eSGreg Lehey
779be174c7eSGreg Lehey# Configuring Vinum into the kernel is not necessary, since the kld
780be174c7eSGreg Lehey# module gets started automatically when vinum(8) starts.  This
781be174c7eSGreg Lehey# device is also untested.  Use at your own risk.
7824cc4752cSGreg Lehey#
7834cc4752cSGreg Lehey# The option VINUMDEBUG must match the value set in CFLAGS
784c867b0e5SPoul-Henning Kamp# in /usr/src/sbin/vinum/Makefile.  Failure to do so will result in
7854cc4752cSGreg Lehey# the following message from vinum(8):
7864cc4752cSGreg Lehey#
7874cc4752cSGreg Lehey# Can't get vinum config: Invalid argument
7884cc4752cSGreg Lehey#
7894cc4752cSGreg Lehey# see vinum(4) for more reasons not to use these options.
7903ea799d5SPeter Wemmpseudo-device	vinum		#Vinum concat/mirror/raid driver
7913ea799d5SPeter Wemmoptions 	VINUMDEBUG	#enable Vinum debugging hooks
7929ba0e7c3SBruce Evans
79365e8111fSBruce Evans# These are only for watching for bitrot in old tty code.
79465e8111fSBruce Evans# broken
79565e8111fSBruce Evans#pseudo-device	tb
79665e8111fSBruce Evans
79758067a99SPoul-Henning Kamp# Size of the kernel message buffer.  Should be N * pagesize.
7985895e3c8SPeter Wemmoptions		MSGBUF_SIZE=40960
79958067a99SPoul-Henning Kamp
8006a8d6623SGarrett Wollman
8016a8d6623SGarrett Wollman#####################################################################
8026a8d6623SGarrett Wollman# HARDWARE DEVICE CONFIGURATION
8036a8d6623SGarrett Wollman
8046a8d6623SGarrett Wollman# ISA and EISA devices:
805c37ddbb8SJoerg Wunsch# EISA support is available for some device, so they can be auto-probed.
8066a8d6623SGarrett Wollman# Micro Channel is not supported at all.
8076a8d6623SGarrett Wollman
8086a8d6623SGarrett Wollman#
80916e164e3SBruce Evans# Mandatory ISA devices: isa, npx
8106a8d6623SGarrett Wollman#
811f71c851cSPeter Wemmcontroller	isa0
8122365e64fSRodney W. Grimes
8136a8d6623SGarrett Wollman#
8146a8d6623SGarrett Wollman# Options for `isa':
8156a8d6623SGarrett Wollman#
816d72ee36fSBruce Evans# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
817d72ee36fSBruce Evans# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
818d72ee36fSBruce Evans# This option breaks suspend/resume on some portables.
819d72ee36fSBruce Evans#
8209ba0e7c3SBruce Evans# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
821d72ee36fSBruce Evans# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
8229ba0e7c3SBruce Evans# Automatic EOI is documented not to work for for the slave with the
8239ba0e7c3SBruce Evans# original i8259A, but it works for some clones and some integrated
8249ba0e7c3SBruce Evans# versions.
8259ba0e7c3SBruce Evans#
826b2796687SNate Williams# MAXMEM specifies the amount of RAM on the machine; if this is not
8279bc192deSDavid E. O'Brien# specified, FreeBSD will first read the amount of memory from the CMOS
8289bc192deSDavid E. O'Brien# RAM, so the amount of memory will initially be limited to 64MB or 16MB
8299bc192deSDavid E. O'Brien# depending on the BIOS.  If the BIOS reports 64MB, a memory probe will
8309bc192deSDavid E. O'Brien# then attempt to detect the installed amount of RAM.  If this probe
8319bc192deSDavid E. O'Brien# fails to detect >64MB RAM you will have to use the MAXMEM option.
8329bc192deSDavid E. O'Brien# The amount is in kilobytes, so for a machine with 128MB of RAM, it would
8339bc192deSDavid E. O'Brien# be 131072 (128 * 1024).
834b2796687SNate Williams#
8353339606dSAndreas Schulz# TUNE_1542 enables the automatic ISA bus speed selection for the
8363339606dSAndreas Schulz# Adaptec 1542 boards. Does not work for all boards, use it with caution.
8373339606dSAndreas Schulz#
8385eb46edfSDavid Greenman# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
8395eb46edfSDavid Greenman# reset the CPU for reboot.  This is needed on some systems with broken
8405eb46edfSDavid Greenman# keyboard controllers.
8413eafdedeSBruce Evans#
84277959e8eSMarc G. Fournier# PAS_JOYSTICK_ENABLE enables the gameport on the ProAudio Spectrum
84377959e8eSMarc G. Fournier
8445895e3c8SPeter Wemmoptions		AUTO_EOI_1
8455895e3c8SPeter Wemm#options	AUTO_EOI_2
8465895e3c8SPeter Wemmoptions		MAXMEM="(128*1024)"
8475895e3c8SPeter Wemmoptions 	TUNE_1542
848b1529bdaSPeter Wemm#options	BROKEN_KEYBOARD_RESET
84977959e8eSMarc G. Fournier#options	PAS_JOYSTICK_ENABLE
8503af6b652SDavid Greenman
851595f6341SPoul-Henning Kamp# Enable support for the kernel PLL to use an external PPS signal,
852595f6341SPoul-Henning Kamp# under supervision of [x]ntpd(8)
853a2210fe1SPoul-Henning Kamp# More info in ntpd documentation: http://www.eecis.udel.edu/~ntp
854595f6341SPoul-Henning Kamp
855595f6341SPoul-Henning Kampoptions		PPS_SYNC
856595f6341SPoul-Henning Kamp
857c2906d55SPoul-Henning Kamp# If you see the "calcru: negative time of %ld usec for pid %d (%s)\n"
858c2906d55SPoul-Henning Kamp# message you probably have some broken sw/hw which disables interrupts
859c2906d55SPoul-Henning Kamp# for too long.  You can make the system more resistant to this by
860c2906d55SPoul-Henning Kamp# choosing a high value for NTIMECOUNTER.  The default is 5, there
861c2906d55SPoul-Henning Kamp# is no upper limit but more than a couple of hundred are not productive.
862a2210fe1SPoul-Henning Kamp# A better strategy may be to sysctl -w kern.timecounter.method=1
863c2906d55SPoul-Henning Kamp
8645895e3c8SPeter Wemmoptions		NTIMECOUNTER=20
865c2906d55SPoul-Henning Kamp
866ec4e5afbSRobert Nordier# Enable PnP support in the kernel.  This allows you to automatically
86753a7a570SJohn-Mark Gurney# attach to PnP cards for drivers that support it and allows you to
86853a7a570SJohn-Mark Gurney# configure cards from USERCONFIG.  See pnp(4) for more info.
86953a7a570SJohn-Mark Gurneycontroller	pnp0
87053a7a570SJohn-Mark Gurney
87123f7bd17SBrian Somers# The keyboard controller; it controls the keyboard and the PS/2 mouse.
8726182fdbdSPeter Wemmcontroller	atkbdc0	at isa? port IO_KBD
8732ad872c5SKazutaka YOKOTA
8742ad872c5SKazutaka YOKOTA# The AT keyboard
875ea7b76b1SPeter Wemmdevice		atkbd0	at atkbdc? irq 1
8762ad872c5SKazutaka YOKOTA
8770a0319c2SKazutaka YOKOTA# Options for atkbd:
8780a0319c2SKazutaka YOKOTAoptions		ATKBD_DFLT_KEYMAP	# specify the built-in keymap
8790a0319c2SKazutaka YOKOTAmakeoptions	ATKBD_DFLT_KEYMAP="jp.106"
8800a0319c2SKazutaka YOKOTA
8810a0319c2SKazutaka YOKOTA# These options are valid for other keyboard drivers as well.
8820a0319c2SKazutaka YOKOTAoptions		KBD_DISABLE_KEYMAP_LOAD	# refuse to load a keymap
8830a0319c2SKazutaka YOKOTAoptions		KBD_INSTALL_CDEV	# install a CDEV entry in /dev
8840a0319c2SKazutaka YOKOTA
885e1b5fc4cSKazutaka YOKOTA# `flags' for atkbd:
886e1b5fc4cSKazutaka YOKOTA#       0x01    Force detection of keyboard, else we always assume a keyboard
887e1b5fc4cSKazutaka YOKOTA#       0x02    Don't reset keyboard, useful for some newer ThinkPads
888e1b5fc4cSKazutaka YOKOTA#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
889e1b5fc4cSKazutaka YOKOTA
8902ad872c5SKazutaka YOKOTA# PS/2 mouse
891ea7b76b1SPeter Wemmdevice		psm0	at atkbdc? irq 12
8922ad872c5SKazutaka YOKOTA
8932ad872c5SKazutaka YOKOTA# Options for psm:
8942ad872c5SKazutaka YOKOTAoptions		PSM_HOOKAPM		#hook the APM resume event, useful
8952ad872c5SKazutaka YOKOTA					#for some laptops
8962ad872c5SKazutaka YOKOTAoptions		PSM_RESETAFTERSUSPEND	#reset the device at the resume event
8972ad872c5SKazutaka YOKOTA
8982ad872c5SKazutaka YOKOTA# The video card driver.
8992ad872c5SKazutaka YOKOTAdevice		vga0	at isa? port ? conflicts
9002ad872c5SKazutaka YOKOTA
901c619f2acSKazutaka YOKOTA# Options for vga:
902c619f2acSKazutaka YOKOTA# Try the following option if the mouse pointer is not drawn correctly
903c619f2acSKazutaka YOKOTA# or font does not seem to be loaded properly.  May cause flicker on
904c619f2acSKazutaka YOKOTA# some systems.
905c619f2acSKazutaka YOKOTAoptions		VGA_ALT_SEQACCESS
906c619f2acSKazutaka YOKOTA
907c619f2acSKazutaka YOKOTA# If you can dispense with some vga driver features, you may want to
908c619f2acSKazutaka YOKOTA# use the following options to save some memory.
909c619f2acSKazutaka YOKOTAoptions		VGA_NO_FONT_LOADING	# don't save/load font
910c619f2acSKazutaka YOKOTAoptions		VGA_NO_MODE_CHANGE	# don't change video modes
911c619f2acSKazutaka YOKOTA
912c619f2acSKazutaka YOKOTA# Older video cards may require this option for proper operation.
913c619f2acSKazutaka YOKOTAoptions		VGA_SLOW_IOACCESS	# do byte-wide i/o's to TS and GDC regs
914c619f2acSKazutaka YOKOTA
9156e8394b8SKazutaka YOKOTA# The following option probably won't work with the LCD displays.
9166e8394b8SKazutaka YOKOTAoptions		VGA_WIDTH90		# support 90 column modes
9176e8394b8SKazutaka YOKOTA
9180a0319c2SKazutaka YOKOTA# To include support for VESA video modes
91977835954SJonathan Lemonoptions		VESA
9200a0319c2SKazutaka YOKOTA
9212ad872c5SKazutaka YOKOTA# Splash screen at start up!  Screen savers require this too.
9222ad872c5SKazutaka YOKOTApseudo-device	splash
9232ad872c5SKazutaka YOKOTA
924c19da41eSPeter Wemm# The pcvt console driver (vt220 compatible).
925ea7b76b1SPeter Wemmdevice		vt0	at isa?
926c19da41eSPeter Wemmoptions		XSERVER			# support for running an X server.
927c19da41eSPeter Wemmoptions		FAT_CURSOR		# start with block cursor
928c19da41eSPeter Wemm# This PCVT option is for keyboards such as those used on IBM ThinkPad laptops
929c19da41eSPeter Wemmoptions		PCVT_SCANSET=2 		# IBM keyboards are non-std
930a467384bSJoerg Wunsch# Other PCVT options are documented in pcvt(4).
9315895e3c8SPeter Wemmoptions		PCVT_24LINESDEF
932a467384bSJoerg Wunschoptions		PCVT_CTRL_ALT_DEL
933a467384bSJoerg Wunschoptions		PCVT_EMU_MOUSE
934a467384bSJoerg Wunschoptions		PCVT_FREEBSD=211
935a467384bSJoerg Wunschoptions		PCVT_META_ESC
936a467384bSJoerg Wunschoptions		PCVT_NSCREENS=9
937a467384bSJoerg Wunschoptions		PCVT_PRETTYSCRNS
938a467384bSJoerg Wunschoptions		PCVT_SCREENSAVER
939a467384bSJoerg Wunschoptions		PCVT_USEKBDSEC
9405895e3c8SPeter Wemmoptions		PCVT_VT220KEYB
941c19da41eSPeter Wemm
942ee16b430SBruce Evans# The syscons console driver (sco color console compatible).
943ea7b76b1SPeter Wemmdevice		sc0	at isa?
944683cbdf4SBruce Evansoptions		MAXCONS=16		# number of virtual consoles
9456e8394b8SKazutaka YOKOTAoptions		SC_ALT_MOUSE_IMAGE	# simplified mouse cursor in text mode
9466e8394b8SKazutaka YOKOTAoptions		SC_DFLT_FONT		# compile font in
9476e8394b8SKazutaka YOKOTAmakeoptions	SC_DFLT_FONT="cp850"
9486e8394b8SKazutaka YOKOTAoptions		SC_DISABLE_DDBKEY	# disable `debug' key
949c4118fc0SKazutaka YOKOTAoptions		SC_DISABLE_REBOOT	# disable reboot key sequence
9506e8394b8SKazutaka YOKOTAoptions		SC_HISTORY_SIZE=200	# number of history buffer lines
9516e8394b8SKazutaka YOKOTAoptions		SC_MOUSE_CHAR=0x3	# char code for text mode mouse cursor
9526e8394b8SKazutaka YOKOTAoptions		SC_PIXEL_MODE		# add support for the raster text mode
95385e36760SJordan K. Hubbard
9546e8394b8SKazutaka YOKOTA# You can selectively disable features in syscons.
9556e8394b8SKazutaka YOKOTAoptions		SC_NO_CUTPASTE
9566e8394b8SKazutaka YOKOTAoptions		SC_NO_FONT_LOADING
9576e8394b8SKazutaka YOKOTAoptions		SC_NO_HISTORY
9586e8394b8SKazutaka YOKOTAoptions		SC_NO_SYSMOUSE
9592ac8be82SAndreas Schulz
9606a8d6623SGarrett Wollman#
96125292acbSBruce Evans# The Numeric Processing eXtension driver.  This should be configured if
96225292acbSBruce Evans# your machine has a math co-processor, unless the coprocessor is very
96325292acbSBruce Evans# buggy. If it is not configured then you *must* configure math emulation
96425292acbSBruce Evans# (see above).  If both npx0 and emulation are configured, then only npx0
96525292acbSBruce Evans# is used (provided it works).
9666182fdbdSPeter Wemmdevice		npx0	at nexus? port IO_NPX iosiz 0x0 flags 0x0 irq 13
9671fe04850SBruce Evans
96898e9e66cSNate Williams#
9691fe04850SBruce Evans# `flags' for npx0:
9701fe04850SBruce Evans#	0x01	don't use the npx registers to optimize bcopy
9711fe04850SBruce Evans#	0x02	don't use the npx registers to optimize bzero
9721fe04850SBruce Evans#	0x04	don't use the npx registers to optimize copyin or copyout.
9731fe04850SBruce Evans# The npx registers are normally used to optimize copying and zeroing when
9741fe04850SBruce Evans# all of the following conditions are satisfied:
9755895e3c8SPeter Wemm#	I586_CPU is an option
9761fe04850SBruce Evans#	the cpu is an i586 (perhaps not a Pentium)
9771fe04850SBruce Evans#	the probe for npx0 succeeds
9781fe04850SBruce Evans#	INT 16 exception handling works.
9791fe04850SBruce Evans# Then copying and zeroing using the npx registers is normally 30-100% faster.
9801fe04850SBruce Evans# The flags can be used to control cases where it doesn't work or is slower.
9811fe04850SBruce Evans# Setting them at boot time using userconfig works right (the optimizations
9821fe04850SBruce Evans# are not used until later in the bootstrap when npx0 is attached).
9831fe04850SBruce Evans#
9841fe04850SBruce Evans
9851fe04850SBruce Evans#
9861fe04850SBruce Evans# `iosiz' for npx0:
9871fe04850SBruce Evans# This can be used instead of the MAXMEM option to set the memory size.  If
9881fe04850SBruce Evans# it is nonzero, then it overrides both the MAXMEM option and the memory
9891fe04850SBruce Evans# size reported by the BIOS.  Setting it at boot time using userconfig takes
9901fe04850SBruce Evans# effect on the next reboot after the change has been recorded in the kernel
9911fe04850SBruce Evans# binary (the size is used early in the boot before userconfig has a chance
9921fe04850SBruce Evans# to change it).
9931fe04850SBruce Evans#
9946a8d6623SGarrett Wollman
9956a8d6623SGarrett Wollman#
9966a8d6623SGarrett Wollman# Optional ISA and EISA devices:
9976a8d6623SGarrett Wollman#
9986a8d6623SGarrett Wollman
9996a8d6623SGarrett Wollman#
10004a64714fSKenneth D. Merry# SCSI host adapters: `aha', `bt'
10016a8d6623SGarrett Wollman#
1002859244a6SJustin T. Gibbs# adv: All Narrow SCSI bus AdvanSys controllers.
1003859244a6SJustin T. Gibbs# adw: Second Generation AdvanSys controllers including the ADV940UW.
10046a8d6623SGarrett Wollman# aha: Adaptec 154x
10059829c3edSJordan K. Hubbard# ahc: Adaptec 274x/284x/294x
10066a8d6623SGarrett Wollman# bt: Most Buslogic controllers
10076a8d6623SGarrett Wollman#
10086a8d6623SGarrett Wollman# Note that the order is important in order for Buslogic cards to be
10096a8d6623SGarrett Wollman# probed correctly.
10106a8d6623SGarrett Wollman#
10116a8d6623SGarrett Wollman
10125895e3c8SPeter Wemmcontroller	bt0	at isa? port IO_BT0 irq ?
1013ea7b76b1SPeter Wemmcontroller	adv0	at isa? port ? irq ?
1014859244a6SJustin T. Gibbscontroller	adw0
1015ea7b76b1SPeter Wemmcontroller      aha0    at isa? port ? irq ?
10166a8d6623SGarrett Wollman
10178b89ef0aSSøren Schmidt#
101813066c5fSJonathan Lemon# Compaq Smart RAID controller.  This driver also uses the major number
101913066c5fSJonathan Lemon# of wd, in order to be able to boot a pure RAID system.
102013066c5fSJonathan Lemon# Only one line of each is needed, the code finds all available controllers
102113066c5fSJonathan Lemon# and devices.
102213066c5fSJonathan Lemon#
102313066c5fSJonathan Lemoncontroller	ida0
102413066c5fSJonathan Lemondevice		id0
102513066c5fSJonathan Lemon
102613066c5fSJonathan Lemon#
10278b89ef0aSSøren Schmidt# ATA and ATAPI devices
10288b89ef0aSSøren Schmidt# This is work in progress, use at your own risk.
1029c867b0e5SPoul-Henning Kamp# It currently reuses the majors of wd.c and friends.
10308b89ef0aSSøren Schmidt# It cannot co-exist with the old system in one kernel.
10318b89ef0aSSøren Schmidt# You only need one "controller ata0" for it to find all
10328b89ef0aSSøren Schmidt# PCI devices on modern machines.
10338b89ef0aSSøren Schmidt#controller	ata0
10348b89ef0aSSøren Schmidt#device		atadisk0	# ATA disk drives
10358b89ef0aSSøren Schmidt#device		atapicd0	# ATAPI CDROM drives
103661f625f0SSøren Schmidt#device		atapifd0	# ATAPI floppy drives
10378b89ef0aSSøren Schmidt#device		atapist0	# ATAPI tape drives
10388b89ef0aSSøren Schmidt#
10398b89ef0aSSøren Schmidt# If you need ISA only devices, this is the lines to add:
10405895e3c8SPeter Wemm#controller	ata1	at isa? port IO_WD1 irq 14
10415895e3c8SPeter Wemm#controller	ata2	at isa? port IO_WD2 irq 15
10428b89ef0aSSøren Schmidt#
10438b89ef0aSSøren Schmidt# All the controller lines can coexist, the driver will
10448b89ef0aSSøren Schmidt# find out which ones are there.
10453c43212aSSøren Schmidt
10466a8d6623SGarrett Wollman#
10476a8d6623SGarrett Wollman# ST-506, ESDI, and IDE hard disks: `wdc' and `wd'
10486a8d6623SGarrett Wollman#
1049e3dd3158SJohn Dyson# The flags fields are used to enable the multi-sector I/O and
1050e3dd3158SJohn Dyson# the 32BIT I/O modes.  The flags may be used in either the controller
1051e3dd3158SJohn Dyson# definition or in the individual disk definitions.  The controller
1052e3dd3158SJohn Dyson# definition is supported for the boot configuration stuff.
1053e3dd3158SJohn Dyson#
1054e3dd3158SJohn Dyson# Each drive has a 16 bit flags value defined:
1055e3dd3158SJohn Dyson#	The low 8 bits are the maximum value for the multi-sector I/O,
1056e3dd3158SJohn Dyson#	where 0xff defaults to the maximum that the drive can handle.
1057e3dd3158SJohn Dyson#	The high bit of the 16 bit flags (0x8000) allows probing for
10581f7727a9SSøren Schmidt#	32 bit transfers.  Bit 14 (0x4000) enables a hack to wake
10591f7727a9SSøren Schmidt#	up powered-down laptop drives.  Bit 13 (0x2000) allows
10601f7727a9SSøren Schmidt#	probing for PCI IDE DMA controllers, such as Intel's PIIX
1061f559a836SSøren Schmidt#	south bridges. Bit 12 (0x1000) sets LBA mode instead of the
1062f559a836SSøren Schmidt#	default CHS mode for accessing the drive. See the wd.4 man page.
1063e3dd3158SJohn Dyson#
1064e3dd3158SJohn Dyson# The flags field for the drives can be specified in the controller
1065e3dd3158SJohn Dyson# specification with the low 16 bits for drive 0, and the high 16 bits
1066e3dd3158SJohn Dyson# for drive 1.
1067e3dd3158SJohn Dyson# e.g.:
10685895e3c8SPeter Wemm#controller	wdc0	at isa? port IO_WD1 irq 14 flags 0x00ff8004
1069e3dd3158SJohn Dyson#
1070e3dd3158SJohn Dyson# specifies that drive 0 will be allowed to probe for 32 bit transfers and
1071e3dd3158SJohn Dyson# a maximum multi-sector transfer of 4 sectors, and drive 1 will not be
1072e3dd3158SJohn Dyson# allowed to probe for 32 bit transfers, but will allow multi-sector
1073e3dd3158SJohn Dyson# transfers up to the maximum that the drive supports.
1074e3dd3158SJohn Dyson#
1075e871e61fSJohn Dyson# If you are using a PCI controller that is not running in compatibility
1076e871e61fSJohn Dyson# mode (for example, it is a 2nd IDE PCI interface), then use config line(s)
1077e871e61fSJohn Dyson# such as:
1078e3dd3158SJohn Dyson#
10795895e3c8SPeter Wemm#controller	wdc2	at isa? port 0 irq ? flags 0xa0ffa0ff
1080e871e61fSJohn Dyson#disk		wd4	at wdc2 drive 0
1081e871e61fSJohn Dyson#disk		wd5	at wdc2 drive 1
1082e871e61fSJohn Dyson#
10835895e3c8SPeter Wemm#controller	wdc3	at isa? port 0 irq ? flags 0xa0ffa0ff
1084e871e61fSJohn Dyson#disk		wd6	at wdc3 drive 0
1085e871e61fSJohn Dyson#disk		wd7	at wdc3 drive 1
1086e871e61fSJohn Dyson#
1087e871e61fSJohn Dyson# Note that the above config would be useful for a Promise card, when used
1088e871e61fSJohn Dyson# on a MB that already has a PIIX controller.  Note the bogus irq and port
1089e871e61fSJohn Dyson# entries.  These are automatically filled in by the IDE/PCI support.
1090e871e61fSJohn Dyson#
1091e871e61fSJohn Dyson
10925895e3c8SPeter Wemmcontroller	wdc0	at isa? port IO_WD1 irq 14
10932620c42eSNate Williamsdisk		wd0	at wdc0 drive 0
10942620c42eSNate Williamsdisk		wd1	at wdc0 drive 1
10955895e3c8SPeter Wemmcontroller	wdc1	at isa? port IO_WD2 irq 15
10962620c42eSNate Williamsdisk		wd2	at wdc1 drive 0
10972620c42eSNate Williamsdisk		wd3	at wdc1 drive 1
10982365e64fSRodney W. Grimes
10996a8d6623SGarrett Wollman#
1100340fe9aeSEivind Eklund# This option allow you to override the default probe time for IDE
1101340fe9aeSEivind Eklund# devices, to get a faster probe.  Setting this below 10000 violate
1102340fe9aeSEivind Eklund# the IDE specs, but may still work for you (it will work for most
1103340fe9aeSEivind Eklund# people).
1104340fe9aeSEivind Eklund#
1105340fe9aeSEivind Eklundoptions		IDE_DELAY=8000	# Be optimistic about Joe IDE device
1106340fe9aeSEivind Eklund
1107a0ca5507SPeter Wemm# IDE CD-ROM & CD-R/RW  driver - requires wdc controller
1108d99434fbSSøren Schmidtdevice          wcd0
1109eeded4d8SSøren Schmidt
1110a0ca5507SPeter Wemm# IDE floppy driver - requires wdc controller
1111aaf86206SPaul Trainadevice          wfd0
1112aaf86206SPaul Traina
1113a0ca5507SPeter Wemm# IDE tape driver - requires wdc controller
1114ea0be999SBruce Evansdevice          wst0
1115ea0be999SBruce Evans
1116aaf86206SPaul Traina
11176788ce49SJordan K. Hubbard#
11186a8d6623SGarrett Wollman# Standard floppy disk controllers and floppy tapes: `fdc', `fd', and `ft'
11196a8d6623SGarrett Wollman#
11205895e3c8SPeter Wemmcontroller	fdc0	at isa? port IO_FD1 irq 6 drq 2
112185827d9cSJoerg Wunsch#
1122d2fb4892SJoerg Wunsch# FDC_DEBUG enables floppy debugging.  Since the debug output is huge, you
1123d2fb4892SJoerg Wunsch# gotta turn it actually on by setting the variable fd_debug with DDB,
1124d2fb4892SJoerg Wunsch# however.
1125d2fb4892SJoerg Wunschoptions		FDC_DEBUG
112669acd21dSWarner Losh# FDC_YE enables support for the floppies used on the Libretto.  This is a
112769acd21dSWarner Losh# pcmcia floppy.  You will also need to add
112869acd21dSWarner Losh#card "Y-E DATA" "External FDD"
112969acd21dSWarner Losh#        config 0x4 "fdc0" 10
113069acd21dSWarner Losh# to your pccard.conf file.
1131d95939afSPeter Wemmoptions		FDC_YE		#XXX newbus broken
1132d2fb4892SJoerg Wunsch#
113385827d9cSJoerg Wunsch# Activate this line instead of the fdc0 line above if you happen to
113485827d9cSJoerg Wunsch# have an Insight floppy tape.  Probing them proved to be dangerous
113585827d9cSJoerg Wunsch# for people with floppy disks only, so it's "hidden" behind a flag:
11365895e3c8SPeter Wemm#controller fdc0 at isa? port IO_FD1 flags 1 irq 6 drq 2
113785827d9cSJoerg Wunsch
11386a8d6623SGarrett Wollmandisk		fd0	at fdc0 drive 0
11396a8d6623SGarrett Wollmandisk		fd1	at fdc0 drive 1
114085827d9cSJoerg Wunsch
11416a8d6623SGarrett Wollman#
1142807ef708SDag-Erling Smørgrav# Other standard PC hardware: `mse', `sio', etc.
11436a8d6623SGarrett Wollman#
11446a8d6623SGarrett Wollman# mse: Logitech and ATI InPort bus mouse ports
11456a8d6623SGarrett Wollman# sio: serial ports (see sio(4))
11466a8d6623SGarrett Wollman
1147ea7b76b1SPeter Wemmdevice		mse0	at isa? port 0x23c irq 5
1148975c53c7SDoug Rabson
11495895e3c8SPeter Wemmdevice		sio0	at isa? port IO_COM1 flags 0x10 irq 4
11509546766aSBruce Evans
11519546766aSBruce Evans#
11529546766aSBruce Evans# `flags' for serial drivers that support consoles (only for sio now):
11539546766aSBruce Evans#	0x10	enable console support for this unit.  The other console flags
11549546766aSBruce Evans#		are ignored unless this is set.  Enabling console support does
11559546766aSBruce Evans#		not make the unit the preferred console - boot with -h or set
11569546766aSBruce Evans#		the 0x20 flag for that.  Currently, at most one unit can have
11579546766aSBruce Evans#		console support; the first one (in config file order) with
11589546766aSBruce Evans#		this flag set is preferred.  Setting this flag for sio0 gives
11599546766aSBruce Evans#		the old behaviour.
11609546766aSBruce Evans#	0x20	force this unit to be the console (unless there is another
11619546766aSBruce Evans#		higher priority console).  This replaces the COMCONSOLE option.
11629546766aSBruce Evans#	0x40	reserve this unit for low level console operations.  Do not
116304fb8e53SAlexander Langer#		access the device in any normal way.
11649546766aSBruce Evans#
11656a796ce0SJohn-Mark Gurney# PnP `flags' (set via userconfig using pnp x flags y)
11666a796ce0SJohn-Mark Gurney#	0x1	disable probing of this device.  Used to prevent your modem
11676a796ce0SJohn-Mark Gurney#		from being attached as a PnP modem.
11686a796ce0SJohn-Mark Gurney#
11699546766aSBruce Evans
11709546766aSBruce Evans# Options for serial drivers that support consoles (only for sio now):
11719546766aSBruce Evansoptions		BREAK_TO_DEBUGGER	#a BREAK on a comconsole goes to
11729546766aSBruce Evans					#DDB, if available.
11735ea6cb03SPaul Trainaoptions		CONSPEED=9600		#default speed for serial console (default 9600)
11746a8d6623SGarrett Wollman
11756a8d6623SGarrett Wollman# Options for sio:
1176768fd661SBruce Evansoptions		COM_ESP			#code for Hayes ESP
11779ba0e7c3SBruce Evansoptions		COM_MULTIPORT		#code for some cards with shared IRQs
11785895e3c8SPeter Wemmoptions		EXTRA_SIO=2		#number of extra sio ports to allocate
11796a8d6623SGarrett Wollman
118096b89afcSBruce Evans# Other flags for sio that aren't documented in the man page.
118196b89afcSBruce Evans#	0x20000	enable hardware RTS/CTS and larger FIFOs.  Only works for
118296b89afcSBruce Evans#		ST16650A-compatible UARTs.
118396b89afcSBruce Evans
11846a8d6623SGarrett Wollman#
118583401efaSGarrett Wollman# Network interfaces: `cx', `ed', `el', `ep', `ie', `is', `le', `lnc'
11866a8d6623SGarrett Wollman#
11876c5e9bbdSMike Pritchard# ar: Arnet SYNC/570i hdlc sync 2/4 port V.35/X.21 serial driver (requires sppp)
1188b16d163dSMike Smith# cs: IBM Etherjet and other Crystal Semi CS89x0-based adapters
118983401efaSGarrett Wollman# cx: Cronyx/Sigma multiport sync/async (with Cisco or PPP framing)
11906a8d6623SGarrett Wollman# ed: Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
11916a8d6623SGarrett Wollman# el: 3Com 3C501 (slow!)
11926a8d6623SGarrett Wollman# ep: 3Com 3C509 (buggy)
1193903a1a16SDag-Erling Smørgrav# ex: Intel EtherExpress Pro/10 and other i82595-based adapters
11941a7c583cSGarrett Wollman# fe: Fujitsu MB86960A/MB86965A Ethernet
11950f1d6a82SSteve Price# ie: AT&T StarLAN 10 and EN100; 3Com 3C507; unknown NI5210; Intel EtherExpress
11966a8d6623SGarrett Wollman# le: Digital Equipment EtherWorks 2 and EtherWorks 3 (DEPCA, DE100,
11976a8d6623SGarrett Wollman#     DE101, DE200, DE201, DE202, DE203, DE204, DE205, DE422)
11989a093170SDavid E. O'Brien# lnc: Lance/PCnet cards (Isolan, Novell NE2100, NE32-VL, AMD Am7990 & Am79C960)
119930cfb5b6SJoerg Wunsch# rdp: RealTek RTL 8002-based pocket ethernet adapters
1200d805b866SJohn Hay# sr: RISCom/N2 hdlc sync 1/2 port V.35/X.21 serial driver (requires sppp)
120198d46ad0SMike Smith# wl: Lucent Wavelan (ISA card only).
120231a08ab0SBill Paul# wi: Lucent WaveLAN/IEEE 802.11 PCMCIA adapters. Note: this supports both
12035f0d0590SPeter Wemm#     the PCMCIA and ISA cards: the ISA card is really a PCMCIA to ISA
12045f0d0590SPeter Wemm#     bridge with a PCMCIA adapter plugged into it.
1205282462f9SDavid E. O'Brien# xe: Xircom/Intel EtherExpress Pro100/16 PC Card ethernet controller.
1206648c711bSPoul-Henning Kamp# ze: IBM/National Semiconductor PCMCIA ethernet controller.
1207648c711bSPoul-Henning Kamp# zp: 3Com PCMCIA Etherlink III (It does not require shared memory for
1208648c711bSPoul-Henning Kamp#     send/receive operation, but it needs 'iomem' to read/write the
1209648c711bSPoul-Henning Kamp#     attribute memory)
1210722012ccSJulian Elischer# oltr: Olicom ISA token-ring adapters OC-3115, OC-3117, OC-3118 and OC-3133
1211722012ccSJulian Elischer#       (no options needed)
12126a8d6623SGarrett Wollman#
1213ea7b76b1SPeter Wemmdevice ar0 at isa? port 0x300 irq 10 iomem 0xd0000
1214ea7b76b1SPeter Wemmdevice cs0 at isa? port 0x300 irq ?
1215ea7b76b1SPeter Wemmdevice cx0 at isa? port 0x240 irq 15 drq 7
1216ea7b76b1SPeter Wemmdevice ed0 at isa? port 0x280 irq 5 iomem 0xd8000
1217ea7b76b1SPeter Wemmdevice el0 at isa? port 0x300 irq 9
1218ea7b76b1SPeter Wemmdevice ep0 at isa? port 0x300 irq 10
1219ea7b76b1SPeter Wemmdevice ex0 at isa? port? irq?
1220ea7b76b1SPeter Wemmdevice fe0 at isa? port 0x300 irq ?
1221ea7b76b1SPeter Wemmdevice ie0 at isa? port 0x300 irq 5 iomem 0xd0000
1222ea7b76b1SPeter Wemmdevice ie1 at isa? port 0x360 irq 7 iomem 0xd0000
1223ea7b76b1SPeter Wemmdevice le0 at isa? port 0x300 irq 5 iomem 0xd0000
1224ea7b76b1SPeter Wemmdevice lnc0 at isa? port 0x280 irq 10 drq 0
1225ea7b76b1SPeter Wemmdevice rdp0 at isa? port 0x378 irq 7 flags 2
1226ea7b76b1SPeter Wemmdevice sr0 at isa? port 0x300 irq 5 iomem 0xd0000
122731a08ab0SBill Pauldevice wi0 at isa? port? irq?
12283476cdb9SMike Smithoptions		WLCACHE		# enables the signal-strength cache
12293476cdb9SMike Smithoptions		WLDEBUG		# enables verbose debugging output
1230ea7b76b1SPeter Wemmdevice wl0 at isa? port 0x300 irq ?
1231282462f9SDavid E. O'Briendevice xe0 at isa? port? irq ?
1232346ebe51SEivind Eklund# We can (bogusly) include both the dedicated PCCARD drivers and the generic
1233346ebe51SEivind Eklund# support when COMPILING_LINT.
1234ea7b76b1SPeter Wemmdevice ze0 at isa? port 0x300 irq 5 iomem 0xd8000
1235ea7b76b1SPeter Wemmdevice zp0 at isa? port 0x300 irq 10 iomem 0xd8000
1236648c711bSPoul-Henning Kamp
1237722012ccSJulian Elischerdevice oltr0 at isa?
1238722012ccSJulian Elischer
123968713f97SKenjiro Cho#
124068713f97SKenjiro Cho# ATM related options
124168713f97SKenjiro Cho#
124268713f97SKenjiro Cho# The `en' device provides support for Efficient Networks (ENI)
124368713f97SKenjiro Cho# ENI-155 PCI midway cards, and the Adaptec 155Mbps PCI ATM cards (ANA-59x0).
124468713f97SKenjiro Cho#
12453cbceb82SKenjiro Cho# atm pseudo-device provides generic atm functions and is required for
124668713f97SKenjiro Cho# atm devices.
12473cbceb82SKenjiro Cho# NATM enables the netnatm protocol family that can be used to
124868713f97SKenjiro Cho# bypass TCP/IP.
124968713f97SKenjiro Cho#
125068713f97SKenjiro Cho# the current driver supports only PVC operations (no atm-arp, no multicast).
125168713f97SKenjiro Cho# for more details, please read the original documents at
125268713f97SKenjiro Cho# http://www.ccrc.wustl.edu/pub/chuck/bsdatm/wucs.html
125368713f97SKenjiro Cho#
125468713f97SKenjiro Chopseudo-device	atm
125568713f97SKenjiro Chodevice en0
125668713f97SKenjiro Chodevice en1
12573cbceb82SKenjiro Chooptions		NATM			#native ATM
1258f4567b9cSJulian Elischer
1259c19da41eSPeter Wemm#
1260c19da41eSPeter Wemm# Audio drivers: `snd', `sb', `pas', `gus', `pca'
1261c19da41eSPeter Wemm#
1262c19da41eSPeter Wemm# snd: Voxware sound support code
1263c19da41eSPeter Wemm# sb: SoundBlaster PCM - SoundBlaster, SB Pro, SB16, ProAudioSpectrum
1264c19da41eSPeter Wemm# sbxvi: SoundBlaster 16
1265c19da41eSPeter Wemm# sbmidi: SoundBlaster 16 MIDI interface
1266c19da41eSPeter Wemm# pas: ProAudioSpectrum PCM and MIDI
1267c19da41eSPeter Wemm# gus: Gravis Ultrasound - Ultrasound, Ultrasound 16, Ultrasound MAX
1268c19da41eSPeter Wemm# gusxvi: Gravis Ultrasound 16-bit PCM	(do not use)
1269c19da41eSPeter Wemm# mss: Microsoft Sound System
1270c19da41eSPeter Wemm# css: Crystal Sound System (CSS 423x PnP)
1271c19da41eSPeter Wemm# sscape: Ensoniq Soundscape MIDI interface
1272c19da41eSPeter Wemm# sscape_mss: Ensoniq Soundscape PCM (requires sscape)
1273c19da41eSPeter Wemm# opl: Yamaha OPL-2 and OPL-3 FM - SB, SB Pro, SB 16, ProAudioSpectrum
1274c19da41eSPeter Wemm# uart: stand-alone 6850 UART for MIDI
1275c19da41eSPeter Wemm# mpu: Roland MPU-401 stand-alone card
1276c19da41eSPeter Wemm#
1277ec4e5afbSRobert Nordier# Note: It has been reported that ISA DMA with the SoundBlaster will
1278c64aec80SNik Clayton# lock up the machine (PR docs/5358).  If this happens to you,
1279c64aec80SNik Clayton# turning off USWC write posting in your machine's BIOS may fix
1280c64aec80SNik Clayton# the problem.
1281c64aec80SNik Clayton#
1282c19da41eSPeter Wemm# Beware!  The addresses specified below are also hard-coded in
1283c19da41eSPeter Wemm# i386/isa/sound/sound_config.h.  If you change the values here, you
1284c19da41eSPeter Wemm# must also change the values in the include file.
1285c19da41eSPeter Wemm#
1286c7406082SJohn-Mark Gurney# pcm: PCM audio through various sound cards.
1287c7406082SJohn-Mark Gurney#
128868ec4eb6SLuigi Rizzo# This has support for a large number of new audio cards, based on
128968ec4eb6SLuigi Rizzo# CS423x, OPTi931, Yamaha OPL-SAx, and also for SB16, GusPnP.
129068ec4eb6SLuigi Rizzo# For more information about this driver and supported cards,
129168ec4eb6SLuigi Rizzo# see the pcm.4 man page and /sys/i386/isa/snd/CARDS.
1292c7406082SJohn-Mark Gurney#
1293c7406082SJohn-Mark Gurney# The flags of the device tells the device a bit more info about the
1294c7406082SJohn-Mark Gurney# device that normally is obtained through the PnP interface.
1295c7406082SJohn-Mark Gurney#	bit  2..0   secondary DMA channel;
1296c7406082SJohn-Mark Gurney#	bit  4      set if the board uses two dma channels;
1297c7406082SJohn-Mark Gurney#	bit 15..8   board type, overrides autodetection; leave it
1298c7406082SJohn-Mark Gurney#		    zero if don't know what to put in (and you don't,
1299c7406082SJohn-Mark Gurney#		    since this is unsupported at the moment...).
1300c7406082SJohn-Mark Gurney#
1301c19da41eSPeter Wemm# This driver will use the new PnP code if it's available.
1302c19da41eSPeter Wemm#
13036a8d6623SGarrett Wollman# pca: PCM audio through your PC speaker
13048b8cd792SJordan K. Hubbard#
1305c19da41eSPeter Wemm# If you have a GUS-MAX card and want to use the CS4231 codec on the
1306c19da41eSPeter Wemm# card the drqs for the gus max must be 8 bit (1, 2, or 3).
1307c19da41eSPeter Wemm#
1308c19da41eSPeter Wemm# If you would like to use the full duplex option on the gus, then define
1309c19da41eSPeter Wemm# flags to be the ``read dma channel''.
1310c19da41eSPeter Wemm#
1311c19da41eSPeter Wemm# options BROKEN_BUS_CLOCK	#PAS-16 isn't working and OPTI chipset
1312c19da41eSPeter Wemm# options SYMPHONY_PAS		#PAS-16 isn't working and SYMPHONY chipset
1313c19da41eSPeter Wemm# options EXCLUDE_SBPRO		#PAS-16
1314c19da41eSPeter Wemm# options SBC_IRQ=5		#PAS-16. Must match irq on sb0 line.
1315c19da41eSPeter Wemm# PAS16: The order of the pas0/sb0/opl0 is important since the
1316c19da41eSPeter Wemm#	sb emulation is enabled in the pas-16 attach.
1317c19da41eSPeter Wemm#
1318ec4e5afbSRobert Nordier# To override the GUS defaults use:
1319c19da41eSPeter Wemm# options GUS_DMA2
1320c19da41eSPeter Wemm# options GUS_DMA
1321c19da41eSPeter Wemm# options GUS_IRQ
1322c19da41eSPeter Wemm#
1323c19da41eSPeter Wemm# The i386/isa/sound/sound.doc has more information.
1324c19da41eSPeter Wemm
1325c19da41eSPeter Wemm# Controls all "VOXWARE" driver sound devices.  See Luigi's driver
1326c19da41eSPeter Wemm# below for an alternate which may work better for some cards.
1327c19da41eSPeter Wemm#
1328c19da41eSPeter Wemmcontroller	snd0
1329c19da41eSPeter Wemmdevice pas0     at isa? port 0x388 irq 10 drq 6
1330c19da41eSPeter Wemmdevice sb0      at isa? port 0x220 irq 5 drq 1
1331c19da41eSPeter Wemmdevice sbxvi0   at isa? drq 5
1332c19da41eSPeter Wemmdevice sbmidi0  at isa? port 0x330
1333c19da41eSPeter Wemmdevice awe0     at isa? port 0x620
1334c19da41eSPeter Wemmdevice gus0 at isa? port 0x220 irq 12 drq 1
1335c19da41eSPeter Wemm#device gus0 at isa? port 0x220 irq 12 drq 1 flags 0x3
1336c19da41eSPeter Wemmdevice mss0 at isa? port 0x530 irq 10 drq 1
1337c19da41eSPeter Wemmdevice css0	at isa? port 0x534 irq 5 drq 1 flags 0x08
1338c19da41eSPeter Wemmdevice sscape0  at isa? port 0x330 irq 9 drq 0
1339c19da41eSPeter Wemmdevice trix0    at isa? port 0x330 irq 6 drq 0
1340c19da41eSPeter Wemmdevice sscape_mss0  at isa? port 0x534 irq 5 drq 1
1341c19da41eSPeter Wemmdevice opl0     at isa? port 0x388
1342c19da41eSPeter Wemmdevice mpu0     at isa? port 0x330 irq 6 drq 0
1343c19da41eSPeter Wemmdevice uart0 at isa? port 0x330 irq 5
1344c19da41eSPeter Wemm
1345c19da41eSPeter Wemm# Luigi's snd code (use INSTEAD of snd0 and all VOXWARE drivers!).
1346c19da41eSPeter Wemm# You may also wish to enable the pnp controller with this, for pnp
1347c19da41eSPeter Wemm# sound cards.
1348c19da41eSPeter Wemm#
1349ea7b76b1SPeter Wemm#device pcm0 at isa? port ? irq 10 drq 1 flags 0x0
1350c19da41eSPeter Wemm
13511a7c583cSGarrett Wollman# Not controlled by `snd'
13525895e3c8SPeter Wemmdevice pca0 at isa? port IO_TIMER1
13539ad380abSGarrett Wollman
13546a8d6623SGarrett Wollman#
1355567e21c2SBruce Evans# Miscellaneous hardware:
13566a8d6623SGarrett Wollman#
13576a8d6623SGarrett Wollman# mcd: Mitsumi CD-ROM
13582d859864SAndreas Schulz# scd: Sony CD-ROM
135905e1d9d4SJordan K. Hubbard# matcd: Matsushita/Panasonic CD-ROM
13606a8d6623SGarrett Wollman# wt: Wangtek and Archive QIC-02/QIC-36 tape drives
13616a8d6623SGarrett Wollman# ctx: Cortex-I frame grabber
13626a8d6623SGarrett Wollman# apm: Laptop Advanced Power Management (experimental)
13636c5e9bbdSMike Pritchard# spigot: The Creative Labs Video Spigot video-acquisition board
13641d86961eSJordan K. Hubbard# meteor: Matrox Meteor video capture board
13651c2b5939SRoger Hardiman# bktr: Brooktree bt848/848a/849a/878/879 video capture and TV Tuner board
136665e8111fSBruce Evans# cy: Cyclades serial driver
1367a50cd483SJordan K. Hubbard# dgb: Digiboard PC/Xi and PC/Xe series driver (ALPHA QUALITY!)
1368c35bda94SBrian Somers# dgm: Digiboard PC/Xem driver
13691a7c583cSGarrett Wollman# gp:  National Instruments AT-GPIB and AT-GPIB/TNT board
1370a800f455SJulian Elischer# asc: GI1904-based hand scanners, e.g. the Trust Amiscan Grey
13711a7c583cSGarrett Wollman# gsc: Genius GS-4500 hand scanner.
13721a7c583cSGarrett Wollman# joy: joystick
1373657e73c4SPeter Dufault# labpc: National Instrument's Lab-PC and Lab-PC+
1374d0930614SAndrey A. Chernov# rc: RISCom/8 multiport card
13753b577e1fSJordan K. Hubbard# rp: Comtrol Rocketport(ISA) - single card
1376567e21c2SBruce Evans# tw: TW-523 power line interface for use with X-10 home control products
13770d04cf6aSPeter Wemm# si: Specialix SI/XIO 4-32 port terminal multiplexor
1378c9da1b81SPeter Wemm# stl: Stallion EasyIO and EasyConnection 8/32 (cd1400 based)
1379c9da1b81SPeter Wemm# stli: Stallion EasyConnection 8/64, ONboard, Brumby (intelligent)
1380657e73c4SPeter Dufault
1381e597b497SNate Williams# Notes on APM
13823d4d8fe9SPoul-Henning Kamp#  The flags takes the following meaning for apm0:
13833d4d8fe9SPoul-Henning Kamp#    0x0020  Statclock is broken.
13843d4d8fe9SPoul-Henning Kamp#    0x0011  Limit APM protocol to 1.1 or 1.0
13853d4d8fe9SPoul-Henning Kamp#    0x0010  Limit APM protocol to 1.0
138638ebe562SAdam David#  If apm is omitted, some systems require sysctl -w kern.timcounter.method=1
138738ebe562SAdam David#  for correct timekeeping.
138838ebe562SAdam David
13892cd01159SJordan K. Hubbard# Notes on the spigot:
13902cd01159SJordan K. Hubbard#  The video spigot is at 0xad6.  This port address can not be changed.
13912cd01159SJordan K. Hubbard#  The irq values may only be 10, 11, or 15
13922cd01159SJordan K. Hubbard#  I/O memory is an 8kb region.  Possible values are:
13932cd01159SJordan K. Hubbard#    0a0000, 0a2000, ..., 0fffff, f00000, f02000, ..., ffffff
1394d01b6680SJordan K. Hubbard#    The start address must be on an even boundary.
1395d01b6680SJordan K. Hubbard#  Add the following option if you want to allow non-root users to be able
1396d01b6680SJordan K. Hubbard#  to access the spigot.  This option is not secure because it allows users
1397d01b6680SJordan K. Hubbard#  direct access to the I/O page.
1398d01b6680SJordan K. Hubbard#  	options SPIGOT_UNSECURE
13998819d6ecSPoul-Henning Kamp
14003b577e1fSJordan K. Hubbard# Notes on the Comtrol Rocketport driver:
14013b577e1fSJordan K. Hubbard#
14023b577e1fSJordan K. Hubbard# The exact values used for rp0 depend on how many boards you have
14033b577e1fSJordan K. Hubbard# in the system.  The manufacturer's sample configs are listed as:
14043b577e1fSJordan K. Hubbard#
14053b577e1fSJordan K. Hubbard#   Comtrol Rocketport ISA single card
1406ea7b76b1SPeter Wemm#               device  rp0     at isa? port 0x280
14073b577e1fSJordan K. Hubbard#
14083b577e1fSJordan K. Hubbard#   If instead you have two ISA cards, one installed at 0x100 and the
14093b577e1fSJordan K. Hubbard#   second installed at 0x180, then you should add the following to
14103b577e1fSJordan K. Hubbard#   your kernel configuration file:
14113b577e1fSJordan K. Hubbard#
1412ea7b76b1SPeter Wemm#               device  rp0     at isa? port 0x100
1413ea7b76b1SPeter Wemm#               device  rp1     at isa? port 0x180
14143b577e1fSJordan K. Hubbard#
14153b577e1fSJordan K. Hubbard#   For 4 ISA cards, it might be something like this:
14163b577e1fSJordan K. Hubbard#
1417ea7b76b1SPeter Wemm#               device  rp0     at isa? port 0x180
1418ea7b76b1SPeter Wemm#               device  rp1     at isa? port 0x100
1419ea7b76b1SPeter Wemm#               device  rp2     at isa? port 0x340
1420ea7b76b1SPeter Wemm#               device  rp3     at isa? port 0x240
14213b577e1fSJordan K. Hubbard#
14223b577e1fSJordan K. Hubbard#   And for PCI cards, you only need say:
14233b577e1fSJordan K. Hubbard#
14243b577e1fSJordan K. Hubbard#               device rp0
14253b577e1fSJordan K. Hubbard#               device rp1
14263b577e1fSJordan K. Hubbard#               ...
14273b577e1fSJordan K. Hubbard#   Note: Make sure that any Rocketport PCI devices are specified BEFORE the
14283b577e1fSJordan K. Hubbard#   ISA Rocketport devices.
14293b577e1fSJordan K. Hubbard
1430a50cd483SJordan K. Hubbard# Notes on the Digiboard driver:
1431a50cd483SJordan K. Hubbard#
1432a50cd483SJordan K. Hubbard# The following flag values have special meanings:
1433c35bda94SBrian Somers#	0x01 - alternate layout of pins (dgb & dgm)
1434c35bda94SBrian Somers#	0x02 - use the windowed PC/Xe in 64K mode (dgb only)
14350d04cf6aSPeter Wemm
14360d04cf6aSPeter Wemm# Notes on the Specialix SI/XIO driver:
1437c4823710SPeter Wemm#  **This is NOT a Specialix supported Driver!**
1438c4823710SPeter Wemm#  The host card is memory, not IO mapped.
1439c4823710SPeter Wemm#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
1440c4823710SPeter Wemm#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
1441c4823710SPeter Wemm#  The cards can use an IRQ of 11, 12 or 15.
1442c4823710SPeter Wemm
1443c9da1b81SPeter Wemm# Notes on the Stallion stl and stli drivers:
1444c9da1b81SPeter Wemm#  See src/i386/isa/README.stl for complete instructions.
1445c9da1b81SPeter Wemm#  This is version 0.0.5alpha, unsupported by Stallion.
1446c9da1b81SPeter Wemm#  The stl driver has a secondary IO port hard coded at 0x280.  You need
1447c9da1b81SPeter Wemm#     to change src/i386/isa/stallion.c if you reconfigure this on the boards.
1448c9da1b81SPeter Wemm#  The "flags" and "iosiz" settings on the stli driver depend on the board:
1449c9da1b81SPeter Wemm#	EasyConnection 8/64 ISA:     flags 23         iosiz 0x1000
1450c9da1b81SPeter Wemm#	EasyConnection 8/64 EISA:    flags 24         iosiz 0x10000
1451c9da1b81SPeter Wemm#	EasyConnection 8/64 MCA:     flags 25         iosiz 0x1000
1452c9da1b81SPeter Wemm#	ONboard ISA:                 flags 4          iosiz 0x10000
1453c9da1b81SPeter Wemm#	ONboard EISA:                flags 7          iosiz 0x10000
1454c9da1b81SPeter Wemm#	ONboard MCA:                 flags 3          iosiz 0x10000
1455c9da1b81SPeter Wemm#	Brumby:                      flags 2          iosiz 0x4000
1456c9da1b81SPeter Wemm#	Stallion:                    flags 1          iosiz 0x10000
1457c9da1b81SPeter Wemm
1458ea7b76b1SPeter Wemmdevice		mcd0	at isa? port 0x300 irq 10
145905e1d9d4SJordan K. Hubbard# for the Sony CDU31/33A CDROM
1460ea7b76b1SPeter Wemmdevice		scd0	at isa? port 0x230
14616c5e9bbdSMike Pritchard# for the SoundBlaster 16 multicd - up to 4 devices
1462ea7b76b1SPeter Wemmcontroller      matcd0  at isa? port 0x230
1463ea7b76b1SPeter Wemmdevice		wt0	at isa? port 0x300 irq 5 drq 1
14646a8d6623SGarrett Wollmandevice		ctx0	at isa? port 0x230 iomem 0xd0000
146578e33712SBruce Evansdevice		spigot0 at isa? port 0xad6 irq 15 iomem 0xee000
14666182fdbdSPeter Wemmdevice		apm0	at nexus?
1467ea7b76b1SPeter Wemmdevice		gp0	at isa? port 0x2c0
14685895e3c8SPeter Wemmdevice		gsc0	at isa? port IO_GSC1 drq 3
14694a04f6f6SBruce Evansdevice		joy0	at isa? port IO_GAME
1470ea7b76b1SPeter Wemmdevice		cy0	at isa? irq 10 iomem 0xd4000 iosiz 0x2000
1471b8cf6ea7SBruce Evansoptions		CY_PCI_FASTINTR		# Use with cy_pci unless irq is shared
1472ea7b76b1SPeter Wemmdevice		dgb0	at isa? port 0x220 iomem 0xfc000 iosiz ?
14735895e3c8SPeter Wemmoptions		NDGBPORTS=16		# Defaults to 16*NDGB
1474ea7b76b1SPeter Wemmdevice		dgm0	at isa? port 0x104 iomem 0xd0000 iosiz ?
1475ea7b76b1SPeter Wemmdevice		labpc0	at isa? port 0x260 irq 5
1476ea7b76b1SPeter Wemmdevice          rc0     at isa? port 0x220 irq 12
1477ea7b76b1SPeter Wemmdevice          rp0     at isa? port 0x280
1478567e21c2SBruce Evans# the port and irq for tw0 are fictitious
1479ea7b76b1SPeter Wemmdevice          tw0     at isa? port 0x380 irq 11
1480ea7b76b1SPeter Wemmdevice		si0	at isa? iomem 0xd0000 irq 12
14815895e3c8SPeter Wemmdevice		asc0	at isa? port IO_ASC1 drq 3 irq 10
1482ea7b76b1SPeter Wemmdevice		stl0	at isa? port 0x2a0 irq 10
1483ea7b76b1SPeter Wemmdevice		stli0	at isa? port 0x2a0 iomem 0xcc000 flags 23 iosiz 0x1000
14845db3b831SPoul-Henning Kamp# You are unlikely to have the hardware for loran0 <phk@FreeBSD.org>
1485ea7b76b1SPeter Wemmdevice		loran0	at isa? port ? irq 5
14865db3b831SPoul-Henning Kamp# HOT1 Xilinx 6200 card (www.vcc.com)
14875db3b831SPoul-Henning Kampdevice		xrpu0
1488a800f455SJulian Elischer
1489eeb706c0SJustin T. Gibbs#
1490eeb706c0SJustin T. Gibbs# EISA devices:
1491eeb706c0SJustin T. Gibbs#
1492eeb706c0SJustin T. Gibbs# The EISA bus device is eisa0.  It provides auto-detection and
1493eeb706c0SJustin T. Gibbs# configuration support for all devices on the EISA bus.
1494eeb706c0SJustin T. Gibbs#
1495e56e7036SJustin T. Gibbs# The `ahb' device provides support for the Adaptec 174X adapter.
1496e56e7036SJustin T. Gibbs#
1497eeb706c0SJustin T. Gibbs# The `ahc' device provides support for the Adaptec 274X and 284X
1498eeb706c0SJustin T. Gibbs# adapters.  The 284X, although a VLB card responds to EISA probes.
1499eeb706c0SJustin T. Gibbs#
1500c37ddbb8SJoerg Wunsch# fea: DEC DEFEA EISA FDDI adapter
1501c37ddbb8SJoerg Wunsch#
1502eeb706c0SJustin T. Gibbscontroller	eisa0
1503e56e7036SJustin T. Gibbscontroller	ahb0
1504eeb706c0SJustin T. Gibbscontroller	ahc0
1505c37ddbb8SJoerg Wunschdevice		fea0
15066a8d6623SGarrett Wollman
15076fb5e0faSJustin T. Gibbs# The aic7xxx driver will attempt to use memory mapped I/O for all PCI
150811b5ea72SJustin T. Gibbs# controllers that have it configured only if this option is set. Unfortunately,
150911b5ea72SJustin T. Gibbs# this doesn't work on some motherboards, which prevents it from being the
151011b5ea72SJustin T. Gibbs# default.
151111b5ea72SJustin T. Gibbsoptions AHC_ALLOW_MEMIO
15126e702c99SPaul Traina
15131b0d3143SJoerg Wunsch# By default, only 10 EISA slots are probed, since the slot numbers
15141b0d3143SJoerg Wunsch# above clash with the configuration address space of the PCI subsystem,
15151b0d3143SJoerg Wunsch# and the EISA probe is not very smart about this.  This is sufficient
15161b0d3143SJoerg Wunsch# for most machines, but in particular the HP NetServer LC series comes
15171b0d3143SJoerg Wunsch# with an onboard AIC7770 dual-channel SCSI controller on EISA slot #11,
15181b0d3143SJoerg Wunsch# thus you need to bump this figure to 12 for them.
15195895e3c8SPeter Wemmoptions	EISA_SLOTS=12
15201b0d3143SJoerg Wunsch
15216a8d6623SGarrett Wollman#
152216e164e3SBruce Evans# PCI devices & PCI options:
15236a8d6623SGarrett Wollman#
15246a8d6623SGarrett Wollman# The main PCI bus device is `pci'.  It provides auto-detection and
15256a8d6623SGarrett Wollman# configuration support for all devices on the PCI bus, using either
15266a8d6623SGarrett Wollman# configuration mode defined in the PCI specification.
15276a8d6623SGarrett Wollman#
1528eeb706c0SJustin T. Gibbs# The `ahc' device provides support for the Adaptec 29/3940(U)(W)
1529eeb706c0SJustin T. Gibbs# and motherboard based AIC7870/AIC7880 adapters.
1530eeb706c0SJustin T. Gibbs#
15316a8d6623SGarrett Wollman# The `ncr' device provides support for the NCR 53C810 and 53C825
15326a8d6623SGarrett Wollman# self-contained SCSI host adapters.
15336a8d6623SGarrett Wollman#
15348bafc245SMatt Jacob# The `isp' device provides support for the Qlogic ISP 1020, 1040
15358bafc245SMatt Jacob# nd 1040B PCI SCSI host adapters, as well as the Qlogic ISP 2100
15368bafc245SMatt Jacob# FC/AL Host Adapter.
15378bafc245SMatt Jacob#
1538ab431312SBill Paul# The `al' device provides support for PCI fast ethernet adapters
1539ab431312SBill Paul# based on the ADMtek Inc. AL981 "Comet" chip.
1540ab431312SBill Paul#
154131188d61SBill Paul# The `ax' device provides support for PCI fast ethernet adapters
154231188d61SBill Paul# based on the ASIX Electronics AX88140A chip, including the Alfa
154331188d61SBill Paul# Inc. GFC2204.
154431188d61SBill Paul#
15456a8d6623SGarrett Wollman# The `de' device provides support for the Digital Equipment DC21040
15466a8d6623SGarrett Wollman# self-contained Ethernet adapter.
15476a8d6623SGarrett Wollman#
154856086e0dSSatoshi Asami# The `fxp' device provides support for the Intel EtherExpress Pro/100B
154956086e0dSSatoshi Asami# PCI Fast Ethernet adapters.
155056086e0dSSatoshi Asami#
1551726ff6a1SBill Paul# The `mx' device provides support for various fast ethernet adapters
1552726ff6a1SBill Paul# based on the Macronix 98713, 987615 ans 98725 series chips.
1553726ff6a1SBill Paul#
1554726ff6a1SBill Paul# The `pn' device provides support for various fast ethernet adapters
1555726ff6a1SBill Paul# based on the Lite-On 82c168 and 82c169 PNIC chips, including the
1556726ff6a1SBill Paul# LinkSys LNE100TX, the NetGear FA310TX rev. D1 and the Matrox
1557726ff6a1SBill Paul# FastNIC 10/100.
1558726ff6a1SBill Paul#
1559589e38a6SBill Paul# The 'rl' device provides support for PCI fast ethernet adapters based
1560589e38a6SBill Paul# on the RealTek 8129/8139 chipset. Note that the RealTek driver defaults
1561ec4e5afbSRobert Nordier# to using programmed I/O to do register accesses because memory mapped
1562726ff6a1SBill Paul# mode seems to cause severe lockups on SMP hardware. This driver also
1563726ff6a1SBill Paul# supports the Accton EN1207D `Cheetah' adapter, which uses a chip called
1564726ff6a1SBill Paul# the MPX 5030/5038, which is either a RealTek in disguise or a RealTek
1565726ff6a1SBill Paul# workalike.
1566589e38a6SBill Paul#
1567d02c2331SBill Paul# The 'ti' device provides support for PCI gigabit ethernet NICs based
1568d02c2331SBill Paul# on the Alteon Networks Tigon 1 and Tigon 2 chipsets. This includes the
1569d02c2331SBill Paul# Alteon AceNIC, the 3Com 3c985, the Netgear GA620 and various others.
1570d02c2331SBill Paul# Note that you will probably want to bump up NBMCLUSTERS a lot to use
1571d02c2331SBill Paul# this driver.
1572d02c2331SBill Paul#
1573e21faf3eSBill Paul# The 'tl' device provides support for the Texas Instruments TNETE100
1574e21faf3eSBill Paul# series 'ThunderLAN' cards and integrated ethernet controllers. This
1575e21faf3eSBill Paul# includes several Compaq Netelligent 10/100 cards and the built-in
1576e21faf3eSBill Paul# ethernet controllers in several Compaq Prosignia, Proliant and
1577e30938ceSBill Paul# Deskpro systems. It also supports several Olicom 10Mbps and 10/100
1578e30938ceSBill Paul# boards.
1579e21faf3eSBill Paul#
1580ec4f65d2SJordan K. Hubbard# The `tx' device provides support for the SMC 9432TX cards.
1581ec4f65d2SJordan K. Hubbard#
1582726ff6a1SBill Paul# The `vr' device provides support for various fast ethernet adapters
1583726ff6a1SBill Paul# based on the VIA Technologies VT3043 `Rhine I' and VT86C100A `Rhine II'
1584726ff6a1SBill Paul# chips, including the D-Link DFE530TX.
1585726ff6a1SBill Paul#
15865ccfdea2SAndreas Schulz# The `vx' device provides support for the 3Com 3C590 and 3C595
1587f4567b9cSJulian Elischer# early support
1588f4567b9cSJulian Elischer#
1589726ff6a1SBill Paul# The `wb' device provides support for various fast ethernet adapters
1590726ff6a1SBill Paul# based on the Winbond W89C840F chip. Note: this is not the same as
1591726ff6a1SBill Paul# the Winbond W89C940F, which is an NE2000 clone.
1592726ff6a1SBill Paul#
1593726ff6a1SBill Paul# The `xl' device provides support for the 3Com 3c900, 3c905 and
1594e30938ceSBill Paul# 3c905B (Fast) Etherlink XL cards and integrated controllers. This
1595e30938ceSBill Paul# includes the integrated 3c905B-TX chips in certain Dell Optiplex and
1596e30938ceSBill Paul# Dell Precision desktop machines and the integrated 3c905-TX chips
1597e30938ceSBill Paul# in Dell Latitude laptop docking stations.
1598e30938ceSBill Paul#
1599d41f24e7SDavid Greenman# The `fpa' device provides support for the Digital DEFPA PCI FDDI
1600d41f24e7SDavid Greenman# adapter. pseudo-device fddi is also needed.
1601d41f24e7SDavid Greenman#
1602bba9a7a0SGarrett Wollman# The `meteor' device is a PCI video capture board. It can also have the
16031d86961eSJordan K. Hubbard# following options:
1604b1529bdaSPeter Wemm#   options METEOR_ALLOC_PAGES=xxx	preallocate kernel pages for data entry
16051d86961eSJordan K. Hubbard#	figure (ROWS*COLUMN*BYTES_PER_PIXEL*FRAME+PAGE_SIZE-1)/PAGE_SIZE
16061d86961eSJordan K. Hubbard#   options METEOR_DEALLOC_PAGES	remove all allocated pages on close(2)
1607b1529bdaSPeter Wemm#   options METEOR_DEALLOC_ABOVE=xxx	remove all allocated pages above the
16081d86961eSJordan K. Hubbard#	specified amount. If this value is below the allocated amount no action
16091d86961eSJordan K. Hubbard#	taken
16104f5f3f07SBrian Somers#   options METEOR_SYSTEM_DEFAULT={METEOR_PAL|METEOR_NTSC|METEOR_SECAM}, used
1611734d08a2SJordan K. Hubbard#	for initialization of fps routine when a signal is not present.
16121d86961eSJordan K. Hubbard#
1613a9c5b8d0SSøren Schmidt# The 'bktr' device is a PCI video capture device using the Brooktree
16141c2b5939SRoger Hardiman# bt848/bt848a/bt849a/bt878/bt879 chipset. When used with a TV Tuner it forms a
1615a9c5b8d0SSøren Schmidt# TV card, eg Miro PC/TV, Hauppauge WinCast/TV WinTV, VideoLogic Captivator,
16161c2b5939SRoger Hardiman# Intel Smart Video III, AverMedia, IMS Turbo, FlyVideo.
16171c2b5939SRoger Hardiman#
1618a9c5b8d0SSøren Schmidt# options OVERRIDE_CARD=xxx
1619a9c5b8d0SSøren Schmidt# options OVERRIDE_TUNER=xxx
1620a9c5b8d0SSøren Schmidt# options OVERRIDE_MSP=1
1621a9c5b8d0SSøren Schmidt# options OVERRIDE_DBX=1
16221c2b5939SRoger Hardiman# These options can be used to override the auto detection
16231c2b5939SRoger Hardiman# The current values for xxx are found in /usr/src/sys/pci/brooktree848.c
16241c2b5939SRoger Hardiman# Using sysctl(8) run-time overrides on a per-card basis can be made
16259ff07e32SAmancio Hasty#
16264f5f3f07SBrian Somers# options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
16271c2b5939SRoger Hardiman# or
16281c2b5939SRoger Hardiman# options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
16291c2b5939SRoger Hardiman# Specifes the default video capture mode.
1630a9c5b8d0SSøren Schmidt# This is required for Dual Crystal (28&35Mhz) boards where PAL is used
1631a9c5b8d0SSøren Schmidt# to prevent hangs during initialisation.  eg VideoLogic Captivator PCI.
1632a9c5b8d0SSøren Schmidt#
16334f5f3f07SBrian Somers# options BKTR_USE_PLL
16341c2b5939SRoger Hardiman# PAL or SECAM users who have a 28Mhz crystal (and no 35Mhz crystal)
16351c2b5939SRoger Hardiman# must enable PLL mode with this option. eg some new Bt878 cards.
1636a9c5b8d0SSøren Schmidt#
16371c2b5939SRoger Hardiman# options BKTR_GPIO_ACCESS
16381c2b5939SRoger Hardiman# This enable IOCTLs which give user level access to the GPIO port.
16391c2b5939SRoger Hardiman#
16401c2b5939SRoger Hardiman# options BKTR_NO_MSP_RESET
16411c2b5939SRoger Hardiman# Prevents the MSP34xx reset. Good if you initialise the MSP in another OS first
16421c2b5939SRoger Hardiman#
16431c2b5939SRoger Hardiman# options BKTR_430_FX_MODE
16441c2b5939SRoger Hardiman# Switch Bt878/879 cards into Intel 430FX chipset compatibility mode.
16451c2b5939SRoger Hardiman#
16461c2b5939SRoger Hardiman# options BKTR_SIS_VIA_MODE
16471c2b5939SRoger Hardiman# Switch Bt878/879 cards into SIS/VIA chipset compatibility mode which is
16481c2b5939SRoger Hardiman# needed for some old SiS and VIA chipset motherboards.
16491c2b5939SRoger Hardiman# This also allows Bt878/879 chips to work on old OPTi (<1997) chipset
16501c2b5939SRoger Hardiman# motherboards and motherboards with bad or incomplete PCI 2.1 support.
16511c2b5939SRoger Hardiman# As a rough guess, old = before 1998
16521c2b5939SRoger Hardiman#
16535719a93cSJohn-Mark Gurney#
16545895e3c8SPeter Wemm# The oltr driver supports the following Olicom PCI token-ring adapters
1655722012ccSJulian Elischer# OC-3136, OC-3137, OC-3139, OC-3140, OC-3141, OC-3540, OC-3250
1656722012ccSJulian Elischer#
1657f71c851cSPeter Wemmcontroller	pci0
1658eeb706c0SJustin T. Gibbscontroller	ahc1
165911bfa65aSBruce Evanscontroller	ncr0
16608bafc245SMatt Jacobcontroller	isp0
1661017b0edcSMatt Jacob#
1662017b0edcSMatt Jacob# Options for ISP
1663017b0edcSMatt Jacob#
1664017b0edcSMatt Jacob#	SCSI_ISP_NO_FWLOAD_MASK	- mask of isp unit numbers (obviously
1665017b0edcSMatt Jacob#				  a max of 32) that you wish to disable
1666017b0edcSMatt Jacob#				  to disable the loading of firmware on.
1667017b0edcSMatt Jacob#	SCSI_ISP_NO_NVRAM_MASK	- mask of isp unit numbers (obviously
1668017b0edcSMatt Jacob#				  a max of 32) that you wish to disable
1669017b0edcSMatt Jacob#				  them picking up information from NVRAM
1670017b0edcSMatt Jacob#				  (for broken cards you can't fix the NVRAM
1671017b0edcSMatt Jacob#				  on- very rare, or for systems you can't
1672017b0edcSMatt Jacob#				  change NVRAM on (e.g. alpha) and you don't
1673017b0edcSMatt Jacob#				  like what's in there)
1674017b0edcSMatt Jacob#	SCSI_ISP_PREFER_MEM_MAP	- control preference for using memory mappings
1675017b0edcSMatt Jacob#				  instead of I/O space mappings. It defaults
1676017b0edcSMatt Jacob#				  to 1 for i386, 0 for alpha. Set to 1 to
1677017b0edcSMatt Jacob#				  unconditionally prefer mapping memory,
1678017b0edcSMatt Jacob#				  else it will use I/O space mappings. Of
1679017b0edcSMatt Jacob#				  course, this can fail if the PCI implement-
1680017b0edcSMatt Jacob#				  ation doesn't support what you want.
16811afb37efSMatt Jacob#
1682b5f3861bSMatt Jacob#	SCSI_ISP_FCDUPLEX	- mask of isp unit numbers (obviously
1683b5f3861bSMatt Jacob#				  a max of 32) that you wish to set fibre
1684b5f3861bSMatt Jacob#				  channel full duplex mode on.
1685b5f3861bSMatt Jacob#				  to disable the loading of firmware on.
16861afb37efSMatt Jacob#	SCSI_ISP_FABRIC		  enable loading of Fabric f/w flavor (2100).
16871afb37efSMatt Jacob#	SCSI_ISP_SCCLUN		  enable loading of expanded lun f/w (2100).
16881afb37efSMatt Jacob#
16891afb37efSMatt Jacob#	ISP_DISABLE_1020_SUPPORT	Disable support for 1020/1040 cards
16901afb37efSMatt Jacob#	ISP_DISABLE_1080_SUPPORT	Disable support for 1080/1240 cards
16911afb37efSMatt Jacob#	ISP_DISABLE_2100_SUPPORT	Disable support for 2100 cards
16921afb37efSMatt Jacob#	(these really just to save code space)
16931afb37efSMatt Jacob#	(use of all three will cause the driver to not compile)
16945895e3c8SPeter Wemmoptions	SCSI_ISP_NO_FWLOAD_MASK=0x12	# disable FW load for isp1 and isp4
16955895e3c8SPeter Wemmoptions SCSI_ISP_NO_NVRAM_MASK=0x1	# disable NVRAM for isp0
16965895e3c8SPeter Wemmoptions SCSI_ISP_PREFER_MEM_MAP=0	# prefer I/O mapping
1697b5f3861bSMatt Jacoboptions SCSI_ISP_FCDUPLEX=0x4		# isp2 is a Fibre Channel card
1698b5f3861bSMatt Jacob					# we want in full duplex mode.
16995895e3c8SPeter Wemm#options	ISP_DISABLE_1020_SUPPORT
17005895e3c8SPeter Wemm#options	ISP_DISABLE_1080_SUPPORT
17015895e3c8SPeter Wemm#options	ISP_DISABLE_2100_SUPPORT
1702017b0edcSMatt Jacob
1703ab431312SBill Pauldevice		al0
170431188d61SBill Pauldevice		ax0
17056a8d6623SGarrett Wollmandevice		de0
170617acc2b2SDavid Greenmandevice		fxp0
1707726ff6a1SBill Pauldevice		mx0
1708726ff6a1SBill Pauldevice		pn0
1709589e38a6SBill Pauldevice		rl0
1710d02c2331SBill Pauldevice		ti0
1711e21faf3eSBill Pauldevice		tl0
1712ec4f65d2SJordan K. Hubbarddevice		tx0
1713726ff6a1SBill Pauldevice		vr0
17145ccfdea2SAndreas Schulzdevice		vx0
1715726ff6a1SBill Pauldevice		wb0
171616e164e3SBruce Evansdevice		xl0
1717d41f24e7SDavid Greenmandevice		fpa0
17181d86961eSJordan K. Hubbarddevice		meteor0
1719db7cb131SPeter Wemm#The oltr driver in the ISA section will also find PCI cards.
1720db7cb131SPeter Wemm#device		oltr0
172128ebb692SNicolas Souchu
17220f3563b6SRoger Hardiman
172328ebb692SNicolas Souchu# Brooktree driver has been ported to the new I2C framework. Thus,
17240f3563b6SRoger Hardiman# you'll need to have the following 3 lines in the kernel config.
17250f3563b6SRoger Hardiman#     controller smbus0
17260f3563b6SRoger Hardiman#     controller iicbus0
17270f3563b6SRoger Hardiman#     controller iicbb0
17280f3563b6SRoger Hardiman# The iic and smb devices are only needed if you want to control other
17290f3563b6SRoger Hardiman# I2C slaves connected to the external connector of some cards.
173028ebb692SNicolas Souchu#
17315719a93cSJohn-Mark Gurneydevice		bktr0
1732446cee6eSJoerg Wunsch
1733dc9deb29SPoul-Henning Kamp#
173416e164e3SBruce Evans# PCI options
1735e261d589SJohn-Mark Gurney#
1736e261d589SJohn-Mark Gurney#options	PCI_QUIET	#quiets PCI code on chipset settings
1737e261d589SJohn-Mark Gurney
1738e261d589SJohn-Mark Gurney#
1739dc9deb29SPoul-Henning Kamp# PCCARD/PCMCIA
1740dc9deb29SPoul-Henning Kamp#
1741e7e437dbSNate Williams# card: slot controller
174213cbd355SNate Williams# pcic: slots
1743e7e437dbSNate Williamscontroller	card0
174494316d1dSWolfgang Helbigdevice		pcic0 at card?
174594316d1dSWolfgang Helbigdevice		pcic1 at card?
1746dc9deb29SPoul-Henning Kamp
17478aa25588SBrian Somers# You may need to reset all pccards after resuming
17488aa25588SBrian Somersoptions		PCIC_RESUME_RESET	# reset after resume
17498aa25588SBrian Somers
1750446cee6eSJoerg Wunsch#
1751446cee6eSJoerg Wunsch# Laptop/Notebook options:
1752446cee6eSJoerg Wunsch#
1753446cee6eSJoerg Wunsch# See also:
17546c5e9bbdSMike Pritchard#  apm under `Miscellaneous hardware'
1755446cee6eSJoerg Wunsch# above.
1756446cee6eSJoerg Wunsch
1757446cee6eSJoerg Wunsch# For older notebooks that signal a powerfail condition (external
1758446cee6eSJoerg Wunsch# power supply dropped, or battery state low) by issuing an NMI:
1759446cee6eSJoerg Wunsch
1760446cee6eSJoerg Wunschoptions		POWERFAIL_NMI	# make it beep instead of panicing
176165e8111fSBruce Evans
1762ab4c624bSMike Smith#
17638afa373cSNicolas Souchu# SMB bus
17648afa373cSNicolas Souchu#
17658afa373cSNicolas Souchu# System Management Bus support provided by the 'smbus' device.
17668afa373cSNicolas Souchu#
17678afa373cSNicolas Souchu# Supported devices:
17688afa373cSNicolas Souchu# smb	standard io
17698afa373cSNicolas Souchu#
17708afa373cSNicolas Souchu# Supported interfaces:
177128ebb692SNicolas Souchu# iicsmb I2C to SMB bridge with any iicbus interface
177228ebb692SNicolas Souchu# bktr	brooktree848 I2C hardware interface
177304fb1490SNicolas Souchu# intpm	Intel PIIX4 Power Management Unit
1774c5ea635cSNicolas Souchu# alpm	Acer Aladdin-IV/V/Pro2 Power Management Unit
17758afa373cSNicolas Souchu#
17768afa373cSNicolas Souchucontroller smbus0
177704fb1490SNicolas Souchucontroller intpm0
1778c5ea635cSNicolas Souchucontroller alpm0
17798afa373cSNicolas Souchu
17808afa373cSNicolas Souchudevice smb0	at smbus?
17818afa373cSNicolas Souchu
17828afa373cSNicolas Souchu#
17838afa373cSNicolas Souchu# I2C Bus
17848afa373cSNicolas Souchu#
17858afa373cSNicolas Souchu# Philips i2c bus support is provided by the `iicbus' device.
17868afa373cSNicolas Souchu#
17878afa373cSNicolas Souchu# Supported devices:
17888afa373cSNicolas Souchu# ic	i2c network interface
17898afa373cSNicolas Souchu# iic	i2c standard io
1790f7d09fbaSNicolas Souchu# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
17918afa373cSNicolas Souchu#
17928afa373cSNicolas Souchu# Supported interfaces:
17938afa373cSNicolas Souchu# pcf	Philips PCF8584 ISA-bus controller
179428ebb692SNicolas Souchu# bktr	brooktree848 I2C software interface
179528ebb692SNicolas Souchu#
179628ebb692SNicolas Souchu# Other:
179728ebb692SNicolas Souchu# iicbb	generic I2C bit-banging code (needed by lpbb, bktr)
17988afa373cSNicolas Souchu#
17998afa373cSNicolas Souchucontroller iicbus0
180028ebb692SNicolas Souchucontroller iicbb0
18018afa373cSNicolas Souchu
18028afa373cSNicolas Souchudevice ic0	at iicbus?
18038afa373cSNicolas Souchudevice iic0	at iicbus?
18048afa373cSNicolas Souchudevice iicsmb0	at iicbus?
18058afa373cSNicolas Souchu
1806ea7b76b1SPeter Wemmcontroller pcf0	at isa? port 0x320 irq 5
18078afa373cSNicolas Souchu
180819c74962SPoul-Henning Kamp# ISDN4BSD section
180980037d6eSHellmuth Michaelis#
181080037d6eSHellmuth Michaelis# see /usr/share/examples/isdn/ROADMAP for an introduction to isdn4bsd.
181180037d6eSHellmuth Michaelis#
181219c74962SPoul-Henning Kamp# i4b passive ISDN cards support (isic - I4b Siemens Isdn Chipset driver)
181319c74962SPoul-Henning Kamp# note that the ``options'' and ``device'' lines must BOTH be defined !
18148afa373cSNicolas Souchu#
181519c74962SPoul-Henning Kamp# Non-PnP Cards:
181619c74962SPoul-Henning Kamp# --------------
181719c74962SPoul-Henning Kamp#
181819c74962SPoul-Henning Kamp# Teles S0/8 or Niccy 1008
18195895e3c8SPeter Wemmoptions TEL_S0_8
1820ea7b76b1SPeter Wemm#device	isic0 at isa? iomem 0xd0000 irq 5 flags 1
182119c74962SPoul-Henning Kamp#
182219c74962SPoul-Henning Kamp# Teles S0/16 or Creatix ISDN-S0 or Niccy 1016
18235895e3c8SPeter Wemmoptions TEL_S0_16
1824ea7b76b1SPeter Wemm#device	isic0 at isa? port 0xd80 iomem 0xd0000 irq 5 flags 2
182519c74962SPoul-Henning Kamp#
182619c74962SPoul-Henning Kamp# Teles S0/16.3
18275895e3c8SPeter Wemmoptions TEL_S0_16_3
1828ea7b76b1SPeter Wemm#device	isic0 at isa? port 0xd80 irq 5 flags 3
182919c74962SPoul-Henning Kamp#
183019c74962SPoul-Henning Kamp# AVM A1 or AVM Fritz!Card
18315895e3c8SPeter Wemmoptions AVM_A1
1832ea7b76b1SPeter Wemm#device	isic0 at isa? port 0x340 irq 5 flags 4
183319c74962SPoul-Henning Kamp#
183419c74962SPoul-Henning Kamp# USRobotics Sportster ISDN TA intern
18355895e3c8SPeter Wemmoptions USR_STI
1836ea7b76b1SPeter Wemm#device isic0 at isa? port 0x268 irq 5 flags 7
183719c74962SPoul-Henning Kamp#
183819c74962SPoul-Henning Kamp# ITK ix1 Micro
18395895e3c8SPeter Wemmoptions ITKIX1
1840ea7b76b1SPeter Wemm#device isic0 at isa? port 0x398 irq 10 flags 18
184119c74962SPoul-Henning Kamp#
184280037d6eSHellmuth Michaelis# ELSA PCC-16
184380037d6eSHellmuth Michaelisoptions "ELSA_PCC16"
184480037d6eSHellmuth Michaelis#device isic0 at isa? port 0x360 irq 10 flags 19
184580037d6eSHellmuth Michaelis#
184619c74962SPoul-Henning Kamp# PnP-Cards:
184719c74962SPoul-Henning Kamp# ----------
184819c74962SPoul-Henning Kamp#
184919c74962SPoul-Henning Kamp# Teles S0/16.3 PnP
18505895e3c8SPeter Wemmoptions TEL_S0_16_3_P
1851ea7b76b1SPeter Wemm#device	isic0 at isa? port ? irq ?
185219c74962SPoul-Henning Kamp#
185319c74962SPoul-Henning Kamp# Creatix ISDN-S0 P&P
18545895e3c8SPeter Wemmoptions CRTX_S0_P
1855ea7b76b1SPeter Wemm#device	isic0 at isa? port ? irq ?
185619c74962SPoul-Henning Kamp#
185719c74962SPoul-Henning Kamp# Dr. Neuhaus Niccy Go@
18585895e3c8SPeter Wemmoptions DRN_NGO
1859ea7b76b1SPeter Wemm#device	isic0 at isa? port ? irq ?
186019c74962SPoul-Henning Kamp#
186119c74962SPoul-Henning Kamp# Sedlbauer Win Speed
18625895e3c8SPeter Wemmoptions SEDLBAUER
1863ea7b76b1SPeter Wemm#device	isic0 at isa? port ? irq ?
186419c74962SPoul-Henning Kamp#
186519c74962SPoul-Henning Kamp# Dynalink IS64PH
18665895e3c8SPeter Wemmoptions DYNALINK
1867ea7b76b1SPeter Wemm#device	isic0 at isa? port ? irq ?
186819c74962SPoul-Henning Kamp#
186919c74962SPoul-Henning Kamp# ELSA QuickStep 1000pro ISA
18705895e3c8SPeter Wemmoptions ELSA_QS1ISA
1871ea7b76b1SPeter Wemm#device	isic0 at isa? port ? irq ?
187219c74962SPoul-Henning Kamp#
187319c74962SPoul-Henning Kamp# PCI-Cards:
187419c74962SPoul-Henning Kamp# ----------
187519c74962SPoul-Henning Kamp#
187619c74962SPoul-Henning Kamp# ELSA QuickStep 1000pro PCI
18775895e3c8SPeter Wemmoptions ELSA_QS1PCI
187819c74962SPoul-Henning Kamp#device  isic0
187919c74962SPoul-Henning Kamp#
188080037d6eSHellmuth Michaelis# AVM Fritz!Card PCI
188180037d6eSHellmuth Michaelisoptions "AVM_A1_PCI"
188280037d6eSHellmuth Michaelis#device  isic0
188380037d6eSHellmuth Michaelis#
188419c74962SPoul-Henning Kamp# PCMCIA-Cards:
188519c74962SPoul-Henning Kamp# -------------
188619c74962SPoul-Henning Kamp#
188719c74962SPoul-Henning Kamp# AVM PCMCIA Fritz!Card
18885895e3c8SPeter Wemmoptions AVM_A1_PCMCIA
1889ea7b76b1SPeter Wemmdevice	isic0 at isa? port 0x340 irq 5 flags 10
189019c74962SPoul-Henning Kamp#
189119c74962SPoul-Henning Kamp# Active Cards:
189219c74962SPoul-Henning Kamp# -------------
189319c74962SPoul-Henning Kamp#
189419c74962SPoul-Henning Kamp# Stollmann Tina-dd control device
1895ea7b76b1SPeter Wemmdevice tina0 at isa? port 0x260 irq 10
189619c74962SPoul-Henning Kamp#
189719c74962SPoul-Henning Kamp# ISDN Protocol Stack
189819c74962SPoul-Henning Kamp# -------------------
189919c74962SPoul-Henning Kamp#
190019c74962SPoul-Henning Kamp# Q.921 / layer 2 - i4b passive cards D channel handling
190119c74962SPoul-Henning Kamppseudo-device	"i4bq921"
190219c74962SPoul-Henning Kamp#
190319c74962SPoul-Henning Kamp# Q.931 / layer 3 - i4b passive cards D channel handling
190419c74962SPoul-Henning Kamppseudo-device	"i4bq931"
190519c74962SPoul-Henning Kamp#
190619c74962SPoul-Henning Kamp# layer 4 - i4b common passive and active card handling
190719c74962SPoul-Henning Kamppseudo-device	"i4b"
190819c74962SPoul-Henning Kamp#
190919c74962SPoul-Henning Kamp# ISDN devices
191019c74962SPoul-Henning Kamp# ------------
191119c74962SPoul-Henning Kamp#
191219c74962SPoul-Henning Kamp# userland driver to do ISDN tracing (for passive cards only)
191319c74962SPoul-Henning Kamppseudo-device   "i4btrc"	4
191419c74962SPoul-Henning Kamp#
191519c74962SPoul-Henning Kamp# userland driver to control the whole thing
191619c74962SPoul-Henning Kamppseudo-device   "i4bctl"
191719c74962SPoul-Henning Kamp#
191819c74962SPoul-Henning Kamp# userland driver for access to raw B channel
191919c74962SPoul-Henning Kamppseudo-device   "i4brbch"       4
192019c74962SPoul-Henning Kamp#
192119c74962SPoul-Henning Kamp# userland driver for telephony
192219c74962SPoul-Henning Kamppseudo-device   "i4btel"        2
192319c74962SPoul-Henning Kamp#
192419c74962SPoul-Henning Kamp# network driver for IP over raw HDLC ISDN
192519c74962SPoul-Henning Kamppseudo-device   "i4bipr"	4
192619c74962SPoul-Henning Kamp# enable VJ header compression detection for ipr i/f
192719c74962SPoul-Henning Kampoptions		IPR_VJ
192819c74962SPoul-Henning Kamp#
192919c74962SPoul-Henning Kamp# network driver for sync PPP over ISDN
193019c74962SPoul-Henning Kamppseudo-device	"i4bisppp"	4
193119c74962SPoul-Henning Kamp
193219c74962SPoul-Henning Kamp
1933ab4c624bSMike Smith# Parallel-Port Bus
1934ab4c624bSMike Smith#
1935ab4c624bSMike Smith# Parallel port bus support is provided by the `ppbus' device.
1936ab4c624bSMike Smith# Multiple devices may be attached to the parallel port, devices
1937ab4c624bSMike Smith# are automatically probed and attached when found.
1938ab4c624bSMike Smith#
1939ab4c624bSMike Smith# Supported devices:
1940ab4c624bSMike Smith# vpo	Iomega Zip Drive
1941f7d09fbaSNicolas Souchu#	Requires SCSI disk support ('scbus' and 'da'), best
1942f88c1346SMike Smith#	performance is achieved with ports in EPP 1.9 mode.
1943fdf94d1aSNicolas Souchu# lpt	Parallel Printer
194446f3ff79SMike Smith# plip	Parallel network interface
1945fdf94d1aSNicolas Souchu# ppi	General-purpose I/O ("Geek Port") + IEEE1284 I/O
1946f7d09fbaSNicolas Souchu# pps	Pulse per second Timing Interface
194728ebb692SNicolas Souchu# lpbb	Philips official parallel port I2C bit-banging interface
1948ab4c624bSMike Smith#
1949ab4c624bSMike Smith# Supported interfaces:
1950ab4c624bSMike Smith# ppc	ISA-bus parallel port interfaces.
1951ab4c624bSMike Smith#
1952ef8f7626SNicolas Souchu
19535895e3c8SPeter Wemmoptions		DEBUG_1284	# IEEE1284 signaling protocol debug
19545895e3c8SPeter Wemmoptions		PERIPH_1284	# Makes your computer act as a IEEE1284
1955ef8f7626SNicolas Souchu				# compliant peripheral
19565895e3c8SPeter Wemmoptions		DONTPROBE_1284	# Avoid boot detection of PnP parallel devices
19575895e3c8SPeter Wemmoptions		VP0_DEBUG	# ZIP/ZIP+ debug
19585895e3c8SPeter Wemmoptions		LPT_DEBUG	# Printer driver debug
19595895e3c8SPeter Wemmoptions		PPC_DEBUG	# Parallel chipset level debug
19605895e3c8SPeter Wemmoptions		PLIP_DEBUG	# Parallel network IP interface debug
1961ef8f7626SNicolas Souchu
1962ab4c624bSMike Smithcontroller	ppbus0
196358bcaed0SNicolas Souchucontroller	vpo0	at ppbus?
1964fdf94d1aSNicolas Souchudevice		lpt0	at ppbus?
196546f3ff79SMike Smithdevice		plip0	at ppbus?
1966ab4c624bSMike Smithdevice		ppi0	at ppbus?
1967507e2e44SPoul-Henning Kampdevice		pps0	at ppbus?
196828ebb692SNicolas Souchudevice		lpbb0	at ppbus?
1969ab4c624bSMike Smith
1970ea7b76b1SPeter Wemmdevice		ppc0	at isa? port? irq 7
1971ab4c624bSMike Smith
1972432aad0eSTor Egge# Kernel BOOTP support
1973432aad0eSTor Egge
1974432aad0eSTor Eggeoptions		BOOTP		# Use BOOTP to obtain IP address/hostname
1975432aad0eSTor Eggeoptions		BOOTP_NFSROOT	# NFS mount root filesystem using BOOTP info
19765895e3c8SPeter Wemmoptions		BOOTP_NFSV3	# Use NFS v3 to NFS mount root
1977432aad0eSTor Eggeoptions		BOOTP_COMPAT	# Workaround for broken bootp daemons.
19785895e3c8SPeter Wemmoptions		BOOTP_WIRED_TO=fxp0 # Use interface fxp0 for BOOTP
1979432aad0eSTor Egge
1980d94f38acSEivind Eklund#
1981d94f38acSEivind Eklund# Add tie-ins for a hardware watchdog.  This only enable the hooks;
1982d94f38acSEivind Eklund# the user must still supply the actual driver.
1983d94f38acSEivind Eklund#
1984d94f38acSEivind Eklundoptions		HW_WDOG
1985d94f38acSEivind Eklund
1986005092bbSEivind Eklund#
1987005092bbSEivind Eklund# Set the number of PV entries per process.  Increasing this can
1988005092bbSEivind Eklund# stop panics related to heavy use of shared memory. However, that can
1989005092bbSEivind Eklund# (combined with large amounts of physical memory) cause panics at
1990005092bbSEivind Eklund# boot time due the kernel running out of VM space.
1991005092bbSEivind Eklund#
1992005092bbSEivind Eklund# If you're tweaking this, you might also want to increase the sysctls
1993005092bbSEivind Eklund# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target".
1994005092bbSEivind Eklund#
199504fa1e6cSEivind Eklund# The value below is the one more than the default.
1996005092bbSEivind Eklund#
19975895e3c8SPeter Wemmoptions         PMAP_SHPGPERPROC=201
1998005092bbSEivind Eklund
1999c796cfa1SAndrzej Bialecki#
2000c796cfa1SAndrzej Bialecki# Disable swapping. This option removes all code which actually performs
2001c796cfa1SAndrzej Bialecki# swapping, so it's not possible to turn it back on at run-time.
2002c796cfa1SAndrzej Bialecki#
2003c796cfa1SAndrzej Bialecki# This is sometimes usable for systems which don't have any swap space
2004c796cfa1SAndrzej Bialecki# (see also sysctls "vm.defer_swapspace_pageouts" and
2005c796cfa1SAndrzej Bialecki# "vm.disable_swapspace_pageouts")
2006c796cfa1SAndrzej Bialecki#
2007c796cfa1SAndrzej Bialecki#options	NO_SWAPPING
2008c796cfa1SAndrzej Bialecki
20099dab0776SDavid Greenman# Set the number of sf_bufs to allocate. sf_bufs are virtual buffers
20109dab0776SDavid Greenman# for sendfile(2) that are used to map file VM pages, and normally
20119dab0776SDavid Greenman# default to a quantity that is roughly 16*MAXUSERS+512. You would
20129dab0776SDavid Greenman# typically want about 4 of these for each simultaneous file send.
20139dab0776SDavid Greenman#
20145895e3c8SPeter Wemmoptions		NSFBUFS=1024
20159dab0776SDavid Greenman
201615a1057cSEivind Eklund#
2017053a2b61SEivind Eklund# Enable extra debugging code for locks.  This stores the filename and
2018ec4e5afbSRobert Nordier# line of whatever acquired the lock in the lock itself, and change a
2019053a2b61SEivind Eklund# number of function calls to pass around the relevant data.  This is
2020053a2b61SEivind Eklund# not at all useful unless you are debugging lock code.  Also note
2021053a2b61SEivind Eklund# that it is likely to break e.g. fstat(1) unless you recompile your
2022053a2b61SEivind Eklund# userland with -DDEBUG_LOCKS as well.
202315a1057cSEivind Eklund#
202415a1057cSEivind Eklundoptions		DEBUG_LOCKS
202515a1057cSEivind Eklund
202665e8111fSBruce Evans# More undocumented options for linting.
202794c94804SBruce Evans
2028d656e316SBruce Evansoptions		CLK_CALIBRATION_LOOP
20295895e3c8SPeter Wemmoptions		CLK_USE_I8254_CALIBRATION
2030d46e059fSPoul-Henning Kampoptions		CLK_USE_TSC_CALIBRATION
20315895e3c8SPeter Wemmoptions		TIMER_FREQ="((14318182+6)/12)"
20329546766aSBruce Evansoptions		CLUSTERDEBUG
2033f3e002a8SPoul-Henning Kampoptions		COMPAT_LINUX
203496b89afcSBruce Evansoptions		CPU_UPGRADE_HW_CACHE
203511bfa65aSBruce Evansoptions		DEBUG
203615a1057cSEivind Eklundoptions		DEBUG_VFS_LOCKS
2037c6de6a69SEivind Eklund#options	DISABLE_PSE
20385895e3c8SPeter Wemmoptions		I586_PMC_GUPROF=0x70000
20395895e3c8SPeter Wemmoptions		IBCS2
2040751bf650SJun-ichiro itojun Haginooptions		KEY
2041751bf650SJun-ichiro itojun Haginooptions		KEY_DEBUG
204225292acbSBruce Evansoptions		LOCKF_DEBUG
2043c6de6a69SEivind Eklundoptions		LOUTB
20444bc24b97SBruce Evansoptions		KBD_MAXRETRY=4
20454bc24b97SBruce Evansoptions		KBD_MAXWAIT=6
20464bc24b97SBruce Evansoptions		KBD_RESETDELAY=201
20474bc24b97SBruce Evansoptions		KBDIO_DEBUG=2
20484bc24b97SBruce Evansoptions		MSGMNB=2049
20494bc24b97SBruce Evansoptions		MSGMNI=41
20504bc24b97SBruce Evansoptions		MSGSEG=2049
205156a956e5SBruce Evansoptions		MSGSSZ=16
20524bc24b97SBruce Evansoptions		MSGTQL=41
20534bc24b97SBruce Evansoptions		NBUF=512
2054c6de6a69SEivind Eklundoptions		NETATALKDEBUG
20554bc24b97SBruce Evansoptions		NMBCLUSTERS=1024
20569546766aSBruce Evansoptions		NPX_DEBUG
2057c6de6a69SEivind Eklundoptions		PANIC_REBOOT_WAIT_TIME=16
20584bc24b97SBruce Evansoptions		PSM_DEBUG=1
2059078d4ac9SBruce Evansoptions		SCSI_NCR_DEBUG
2060078d4ac9SBruce Evansoptions		SCSI_NCR_DFLT_TAGS=4
2061078d4ac9SBruce Evansoptions		SCSI_NCR_MAX_SYNC=10000
2062078d4ac9SBruce Evansoptions		SCSI_NCR_MAX_WIDE=1
2063078d4ac9SBruce Evansoptions		SCSI_NCR_MYADDR=7
20644bc24b97SBruce Evansoptions		SEMMAP=31
20654bc24b97SBruce Evansoptions		SEMMNI=11
20664bc24b97SBruce Evansoptions		SEMMNS=61
20674bc24b97SBruce Evansoptions		SEMMNU=31
20684bc24b97SBruce Evansoptions		SEMMSL=61
20694bc24b97SBruce Evansoptions		SEMOPM=101
20704bc24b97SBruce Evansoptions		SEMUME=11
2071b1529bdaSPeter Wemmoptions		SHOW_BUSYBUFS	# List buffers that prevent root unmount
20724bc24b97SBruce Evansoptions		SHMALL=1025
20735895e3c8SPeter Wemmoptions		SHMMAX="(SHMMAXPGS*PAGE_SIZE+1)"
20744bc24b97SBruce Evansoptions		SHMMAXPGS=1025
20754bc24b97SBruce Evansoptions		SHMMIN=2
20764bc24b97SBruce Evansoptions		SHMMNI=33
20774bc24b97SBruce Evansoptions		SHMSEG=9
2078d656e316SBruce Evansoptions		SI_DEBUG
207925292acbSBruce Evansoptions		SIMPLELOCK_DEBUG
2080cefdbb04SBruce Evansoptions		SPX_HACK
20815526d2d9SEivind Eklundoptions		VFS_BIO_DEBUG
208204fb1490SNicolas Souchuoptions		ENABLE_ALART
208316094866SJulian Elischer
2084f909c15bSEivind Eklund# The 'dpt' driver provides support for DPT controllers (http://www.dpt.com/).
2085f909c15bSEivind Eklund# These have hardware RAID-{0,1,5} support, and do multi-initiator I/O.
2086b755b885SEivind Eklund# The DPT controllers are commonly re-licensed under other brand-names -
2087b755b885SEivind Eklund# some controllers by Olivetti, Dec, HP, AT&T, SNI, AST, Alphatronic, NEC and
2088b755b885SEivind Eklund# Compaq are actually DPT controllers.
2089b755b885SEivind Eklund#
209016094866SJulian Elischer# See sys/dev/dpt for debugging and other subtle options.
209116094866SJulian Elischer#   DPT_VERIFY_HINTR        Performs some strict hardware interrupts testing.
209216094866SJulian Elischer#                           Only use if you suspect PCI bus corruption problems
2093ec4e5afbSRobert Nordier#   DPT_RESTRICTED_FREELIST Normally, the freelist used by the DPT for queue
2094ec4e5afbSRobert Nordier#                           will grow to accommodate increased use. This growth
209516094866SJulian Elischer#                           will NOT shrink.  To restrict the number of queue
209616094866SJulian Elischer#                           slots to exactly what the DPT can hold at one time,
209716094866SJulian Elischer#                           enable this option.
209816094866SJulian Elischer#   DPT_MEASURE_PERFORMANCE Enables a set of (semi)invasive metrics. Various
2099b755b885SEivind Eklund#                           instruments are enabled.  The tools in
2100b755b885SEivind Eklund#                           /usr/sbin/dpt_* assume these to be enabled.
2101b755b885SEivind Eklund#   DPT_FREELIST_IS_STACK   For optimal L{1,2} CPU cache utilization, enable
210216094866SJulian Elischer#                           this option.  Otherwise, the transaction queue is
210316094866SJulian Elischer#                           a LIFO.  I cannot measure the performance gain.
210416094866SJulian Elischer#   DPT_HANDLE_TIMEOUTS     Normally device timeouts are handled by the DPT.
210516094866SJulian Elischer#                           If you ant the driver to handle timeouts, enable
210616094866SJulian Elischer#                           this option.  If your system is very busy, this
210716094866SJulian Elischer#                           option will create more trouble than solve.
210816094866SJulian Elischer#   DPT_TIMEOUT_FACTOR      Used to compute the excessive amount of time to
210916094866SJulian Elischer#                           wait when timing out with the above option.
211016094866SJulian Elischer#  DPT_DEBUG_xxxx           These are controllable from sys/dev/dpt/dpt.h
211116094866SJulian Elischer#  DPT_LOST_IRQ             When enabled, will try, once per second, to catch
211216094866SJulian Elischer#                           any interrupt that got lost.  Seems to help in some
211316094866SJulian Elischer#                           DPT-firmware/Motherboard combinations.  Minimal
211416094866SJulian Elischer#                           cost, great benefit.
2115b755b885SEivind Eklund#  DPT_RESET_HBA            Make "reset" actually reset the controller
2116b755b885SEivind Eklund#                           instead of fudging it.  Only enable this if you
2117b755b885SEivind Eklund#			    are 100% certain you need it.
2118b755b885SEivind Eklund#  DPT_SHUTDOWN_SLEEP       Reset controller if a request take more than
2119b755b885SEivind Eklund#                           this number of seconds.  Do NOT enable this
2120b755b885SEivind Eklund#			    unless you are really, really, really certain
2121b755b885SEivind Eklund#			    you need it.  You are advised to call Simon (the
2122b755b885SEivind Eklund#			    driver author) before setting it, and NEVER,
2123b755b885SEivind Eklund#			    EVER set it to less than 300s (5 minutes).
212416094866SJulian Elischer
212516094866SJulian Elischercontroller      dpt0
212616094866SJulian Elischer
212716094866SJulian Elischer# DPT options
212816094866SJulian Elischeroptions DPT_VERIFY_HINTR
212916094866SJulian Elischeroptions DPT_RESTRICTED_FREELIST
21307c0daaa8SEivind Eklund#!CAM# options DPT_MEASURE_PERFORMANCE
213116094866SJulian Elischeroptions DPT_FREELIST_IS_STACK
21327c0daaa8SEivind Eklund#!CAM# options DPT_HANDLE_TIMEOUTS
213316094866SJulian Elischeroptions DPT_TIMEOUT_FACTOR=4
213416094866SJulian Elischeroptions	DPT_INTR_DELAY=200      # Some motherboards need that
213516094866SJulian Elischeroptions DPT_LOST_IRQ
2136b755b885SEivind Eklundoptions DPT_RESET_HBA
2137b755b885SEivind Eklund
2138b755b885SEivind Eklund# Don't EVER set this without having talked to Simon Shapiro on the phone
2139b755b885SEivind Eklund# first.
2140b755b885SEivind Eklundoptions DPT_SHUTDOWN_SLEEP=500
21411d33cf3dSNick Hibma
21421d33cf3dSNick Hibma# USB support
21431d33cf3dSNick Hibma# UHCI controller
21448f2a96f2SNick Hibmacontroller	uhci0
21451d33cf3dSNick Hibma# OHCI controller
21461d33cf3dSNick Hibmacontroller	ohci0
21471d33cf3dSNick Hibma# General USB code (mandatory for USB)
21481d33cf3dSNick Hibmacontroller	usb0
21491d33cf3dSNick Hibma#
2150f26c33d2SNick Hibma# Generic USB device driver
2151f26c33d2SNick Hibmadevice		ugen0
2152f26c33d2SNick Hibma# Human Interface Device (anything with buttons and dials)
2153f26c33d2SNick Hibmadevice		uhid0
21541d33cf3dSNick Hibma# USB keyboard
21551d33cf3dSNick Hibmadevice		ukbd0
21561d33cf3dSNick Hibma# USB printer
21571d33cf3dSNick Hibmadevice		ulpt0
2158f26c33d2SNick Hibma# USB Iomega Zip 100 Drive
2159f26c33d2SNick Hibmacontroller	umass0
2160f26c33d2SNick Hibma# USB mouse
2161f26c33d2SNick Hibmadevice		ums0
2162f26c33d2SNick Hibma#
2163f26c33d2SNick Hibma
2164f26c33d2SNick Hibma# debugging options for the USB subsystem
21651d33cf3dSNick Hibma#
21667dc1a5bdSNick Hibmaoptions		UHCI_DEBUG
21677dc1a5bdSNick Hibmaoptions		OHCI_DEBUG
21681d33cf3dSNick Hibmaoptions		USB_DEBUG
2169f26c33d2SNick Hibma
21707dc1a5bdSNick Hibmaoptions		UGEN_DEBUG
2171f26c33d2SNick Hibmaoptions		UHID_DEBUG
2172f26c33d2SNick Hibmaoptions		UHUB_DEBUG
2173f26c33d2SNick Hibmaoptions		UKBD_DEBUG
21747dc1a5bdSNick Hibmaoptions		ULPT_DEBUG
2175f26c33d2SNick Hibmaoptions		UMASS_DEBUG
2176f26c33d2SNick Hibmaoptions		UMS_DEBUG
2177f26c33d2SNick Hibma
21786e8394b8SKazutaka YOKOTA# options for ukbd:
21796e8394b8SKazutaka YOKOTAoptions		UKBD_DFLT_KEYMAP	# specify the built-in keymap
21806e8394b8SKazutaka YOKOTAmakeoptions	UKBD_DFLT_KEYMAP="it.iso"
21816e8394b8SKazutaka YOKOTA
2182785d2100SJohn Birrell#
2183785d2100SJohn Birrell# Embedded system options:
2184785d2100SJohn Birrell#
2185785d2100SJohn Birrell# An embedded system might want to run something other than init.
21868a13a924SJohn Birrelloptions		INIT_PATH="/sbin/init:/stand/sysinstall"
2187785d2100SJohn Birrell
2188