Sync with i386/NOTES rev. 1.1131.

1 files changed, 252 insertions, 114 deletions

diff --git a/sys/amd64/conf/NOTES b/sys/amd64/conf/NOTES
index 1d5c5d5..936d94f 100644
--- a/sys/amd64/conf/NOTES
+++ b/sys/amd64/conf/NOTES
@@ -7,28 +7,65 @@
 # $FreeBSD$
 #
 
+# We don't have modules on amd64.
+makeoptions	NO_MODULES=not_yet
+
 #
 # This directive is mandatory; it defines the architecture to be
 # configured for; in this case, the 386 family based IBM-PC and
 # compatibles.
 #
 machine		amd64
-cpu			HAMMER
 
-# 
+#
 # We want LINT to cover profiling as well
-profile         2
+#XXX#profile         2
+
+
+#####################################################################
+# SMP OPTIONS:
+#
+# The apic device enables the use of the I/O APIC for interrupt delivery.
+# The apic device can be used in both UP and SMP kernels, but is required
+# for SMP kernels.  Thus, the apic device is not strictly an SMP option,
+# but it is a prerequisite for SMP.
+#
+# Notes:
+#
+# By default, mixed mode is used to route IRQ0 from the AT timer via
+# the 8259A master PIC through the ExtINT pin on the first I/O APIC.
+# This can be disabled via the NO_MIXED_MODE option.  In that case,
+# IRQ0 will be routed via an intpin on the first I/O APIC.  Not all
+# motherboards hook IRQ0 up to the first I/O APIC even though their
+# MP table or MADT may claim to do so.  That is why mixed mode is
+# enabled by default.
+#
+
+# Optional:
+device		atpic			# Legacy pic
+device		mptable
+options 	NO_MIXED_MODE		# Disable use of mixed mode
 
 
-# Debug options
-options 	NPX_DEBUG	# enable npx debugging (FPU/math emu)
-					#new math emulator
+#####################################################################
+# CPU OPTIONS
+
+#
+# You must specify at least one CPU (the one you intend to run on);
+# deleting the specification for CPUs you don't need to use may make
+# parts of the system run faster.
+#
+cpu		HAMMER			# aka K8, aka Opteron & Athlon64
+
+#
+# Options for CPU features.
+#
 
 #
 # PERFMON causes the driver for Pentium/Pentium Pro performance counters
 # to be compiled.  See perfmon(4) for more information.
 #
-options 	PERFMON
+#XXX#options 	PERFMON
 
 
 #####################################################################
@@ -39,7 +76,7 @@ options 	PERFMON
 # of network device drivers, which has significant benefits in terms
 # of robustness to overloads and responsivity, as well as permitting
 # accurate scheduling of the CPU time between kernel network processing
-# and other activities. The drawback is a moderate (up to 1/HZ seconds)
+# and other activities.  The drawback is a moderate (up to 1/HZ seconds)
 # potential increase in response times.
 # It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING
 # to achieve smoother behaviour.
@@ -48,8 +85,8 @@ options 	PERFMON
 # the CPU fraction reserved to userland with the sysctl variable
 # kern.polling.user_frac (default 50, range 0..100).
 #
-# Only the "dc" "fxp" and "sis" devices support this mode of operation at
-# the time of this writing.
+# Not all device drivers support this mode of operation at the time of
+# this writing.  See polling(4) for more details.
 
 options 	DEVICE_POLLING
 
@@ -59,20 +96,22 @@ options 	DEVICE_POLLING
 
 # The following options are used for debugging clock behavior only, and
 # should not be used for production systems.
-#
-# CLK_CALIBRATION_LOOP will run the clock calibration loop at startup
-# until the user presses a key.
 
+# CLK_CALIBRATION_LOOP causes clock calibration to be run in a loop at
+# startup until the user presses a key.  (The i8254 clock is always
+# calibrated relative to the RTC (mc146818a) and this option causes the
+# calibration to be repeated.)
 options 	CLK_CALIBRATION_LOOP
 
+# CLK_USE_I8254_CALIBRATION causes the calibrated frequency of the i8254
+# clock to actually be used.
+options 	CLK_USE_I8254_CALIBRATION
+
 
 #####################################################################
 # MISCELLANEOUS DEVICES AND OPTIONS
 
-hint.speaker.0.at="isa"
-hint.speaker.0.port="0x61"
-device		gzip		#Exec gzipped a.out's. REQUIRES COMPAT_AOUT!
-device		apm_saver	# Requires APM
+device		gzip		#Exec gzipped a.out's.  REQUIRES COMPAT_AOUT!
 
 
 #####################################################################
@@ -109,6 +148,9 @@ device		isa
 # reset the CPU for reboot.  This is needed on some systems with broken
 # keyboard controllers.
 
+options 	AUTO_EOI_1
+#options 	AUTO_EOI_2
+
 options 	MAXMEM=(128*1024)
 #options 	BROKEN_KEYBOARD_RESET
 
@@ -125,14 +167,28 @@ device		agp
 #####################################################################
 # HARDWARE DEVICE CONFIGURATION
 
-#
-# Mandatory devices:
-#
+# To include support for VGA VESA video modes
+options 	VESA
+
+# Turn on extra debugging checks and output for VESA support.
+options 	VESA_DEBUG
 
 #
 # Optional devices:
 #
 
+# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support.  This will create
+# the /dev/3dfx0 device to work with glide implementations.  This should get
+# linked to /dev/3dfx and /dev/voodoo.  Note that this is not the same as
+# the tdfx DRI module from XFree86 and is completely unrelated.
+#
+# To enable Linuxulator support, one must also include COMPAT_LINUX in the
+# config as well, or you will not have the dependencies.  The other option
+# is to load both as modules.
+
+device		tdfx			# Enable 3Dfx Voodoo support
+#XXX#options 	TDFX_LINUX		# Enable Linuxulator support
+
 #
 # ACPI support using the Intel ACPI Component Architecture reference
 # implementation.
@@ -142,17 +198,29 @@ device		agp
 # Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
 # defined when it is built).
 #
+# ACPI_MAX_THREADS sets the number of task threads started.
+#
+# ACPI_NO_SEMAPHORES makes the AcpiOs*Semaphore routines a no-op.
+#
+# ACPICA_PEDANTIC enables strict checking of AML.  Our default is to
+# relax these checks to allow code generated by the Microsoft compiler
+# to still execute.
+#
 # Note that building ACPI into the kernel is deprecated; the module is
 # normally loaded automatically by the loader.
-#
+
 device		acpi
 options 	ACPI_DEBUG
+options 	ACPI_MAX_THREADS=1
+#!options 	ACPI_NO_SEMAPHORES
+#!options 	ACPICA_PEDANTIC
 
 # DRM options:
 # mgadrm:    AGP Matrox G200, G400, G450, G550
-# tdfxdrm:   3dfx Voodoo 3/4/5 and Banshee
 # r128drm:   ATI Rage 128
 # radeondrm: ATI Radeon up to 9000/9100
+# sisdrm:    SiS 300/305,540,630
+# tdfxdrm:   3dfx Voodoo 3/4/5 and Banshee
 # DRM_DEBUG: include debug printfs, very slow
 #
 # mga requires AGP in the kernel, and it is recommended
@@ -161,60 +229,39 @@ options 	ACPI_DEBUG
 device		mgadrm
 device		"r128drm"
 device		radeondrm
+device		sisdrm
 device		tdfxdrm
 
 options 	DRM_DEBUG
 
-# M-systems DiskOnchip products see src/sys/contrib/dev/fla/README
-###device		fla
-###hint.fla.0.at="isa"
-
 #
 # Network interfaces:
 #
 
 # ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
-#       HP PC Lan+, various PC Card devices (refer to etc/defauls/pccard.conf)
-#       (requires miibus)
-# ie:   AT&T StarLAN 10 and EN100; 3Com 3C507; unknown NI5210;
-#       Intel EtherExpress
+#       HP PC Lan+, various PC Card devices (refer to etc/defaults/pccard.conf)
 # lnc:  Lance/PCnet cards (Isolan, Novell NE2100, NE32-VL, AMD Am7990 and
 #       Am79C960)
-# sr:   RISCom/N2 hdlc sync 1/2 port V.35/X.21 serial driver (requires sppp)
-# wl:	Lucent Wavelan (ISA card only).
-
-# Order for ISA/EISA devices is important here
-
-device		ed
-#options 	ED_NO_MIIBUS		# Disable ed miibus support
-hint.ed.0.at="isa"
-hint.ed.0.port="0x280"
-hint.ed.0.irq="5"
-hint.ed.0.maddr="0xd8000"
-device		lnc
-hint.lnc.0.at="isa"
-hint.lnc.0.port="0x280"
-hint.lnc.0.irq="10"
-hint.lnc.0.drq="0"
-device		sr
-hint.sr.0.at="isa"
-hint.sr.0.port="0x300"
-hint.sr.0.irq="5"
-hint.sr.0.maddr="0xd0000"
-device		wl
-hint.wl.0.at="isa"
-hint.wl.0.port="0x300"
-options 	WLCACHE		# enables the signal-strength cache
-options 	WLDEBUG		# enables verbose debugging output
+
+#XXX#	Needs to be busdma'ed.
+#XXX#device		ed
+#XXX#device		lnc
+
+# ath:	Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
+
+#XXX#device	ath
+#XXX#device	ath_hal		# Atheros HAL (includes binary component)
+device		wlan		# 802.11 layer
 
 #
 # ATA raid adapters
 #
-device		pst
+#XXX this stores pointers in a 32bit field that is defined by the hardware
+#device	pst
 
-# 
+#
 # SCSI host adapters:
-# 
+#
 # ncv: NCR 53C500 based SCSI host adapters.
 # nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
 # stg: TMC 18C30, 18C50 based SCSI host adapters.
@@ -222,9 +269,6 @@ device		pst
 device          ncv
 device          nsp
 device          stg
-hint.stg.0.at="isa"
-hint.stg.0.port="0x140"
-hint.stg.0.port="11"
 
 #
 # Adaptec FSA RAID controllers, including integrated DELL controllers,
@@ -249,12 +293,9 @@ options		SAFE_RNDTEST	# enable rndtest support
 #
 # Miscellaneous hardware:
 #
-# dgb: Digiboard PC/Xi and PC/Xe series driver (ALPHA QUALITY!)
+# cy: Cyclades serial driver
 # digi: Digiboard driver
-# gsc: Genius GS-4500 hand scanner.
-# spic: Sony Programmable I/O controller (VAIO notebooks)
 # stl: Stallion EasyIO and EasyConnection 8/32 (cd1400 based)
-# stli: Stallion EasyConnection 8/64, ONboard, Brumby (intelligent)
 
 # Notes on the Specialix SI/XIO driver:
 #  The host card is memory, not IO mapped.
@@ -262,15 +303,6 @@ options		SAFE_RNDTEST	# enable rndtest support
 #  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
 #  The cards can use an IRQ of 11, 12 or 15.
 
-# Notes on the Digiboard PC/Xi and PC/Xe series driver
-#               
-# The NDGBPORTS option specifies the number of ports controlled by the
-# dgb(4) driver.  The default value is 16 ports per device.
-#
-# The following flag values have special meanings in dgb:
-#	0x01 - alternate layout of pins
-#	0x02 - use the windowed PC/Xe in 64K mode
-
 device		digi
 hint.digi.0.at="isa"
 hint.digi.0.port="0x104"
@@ -283,30 +315,128 @@ device		digi_EPCX_PCI
 device		digi_Xe
 device		digi_Xem
 device		digi_Xr
+#XXX#	PCI versions exist, but driver needs to be moved and split up.
+#XXX#device		stl
 # HOT1 Xilinx 6200 card (http://www.vcc.com/)
 device		xrpu
 
 #
 # Laptop/Notebook options:
 #
-# See also:
-#  apm under `Miscellaneous hardware'
-# above.
 
+
+#
+# I2C Bus
+#
+
+#---------------------------------------------------------------------------
+# ISDN4BSD
+#
+# See /usr/share/examples/isdn/ROADMAP for an introduction to isdn4bsd.
+#
+# i4b passive ISDN cards support contains the following hardware drivers:
+#
+#	isic  - Siemens/Infineon ISDN ISAC/HSCX/IPAC chipset driver
+#	iwic  - Winbond W6692 PCI bus ISDN S/T interface controller
+#	ifpi  - AVM Fritz!Card PCI driver
+#	ifpi2  - AVM Fritz!Card PCI version 2 driver
+#	itjc  - Siemens ISAC / TJNet Tiger300/320 chipset
+#
+# i4b active ISDN cards support contains the following hardware drivers:
+#
+#	iavc  - AVM B1 PCI, AVM B1 ISA, AVM T1
+#
+# Note that the ``options'' (if given) and ``device'' lines must BOTH
+# be uncommented to enable support for a given card !
+#
+# In addition to a hardware driver (and probably an option) the mandatory
+# ISDN protocol stack devices and the mandatory support device must be
+# enabled as well as one or more devices from the optional devices section.
+#
+#---------------------------------------------------------------------------
+#	isic driver (Siemens/Infineon chipsets)
+#
+#XXX#device	isic
+#
 # PCI bus Cards:
 # --------------
 #
-# Cyclades Cyclom-Y PCI serial driver
-device		cy
-options 	CY_PCI_FASTINTR		# Use with cy_pci unless irq is shared
-#hint.cy.0.at="isa"
-#hint.cy.0.irq="10"
-#hint.cy.0.maddr="0xd4000"
-#hint.cy.0.msize="0x2000"
+# ELSA MicroLink ISDN/PCI (same as ELSA QuickStep 1000pro PCI)
+options 	ELSA_QS1PCI
+#
+#---------------------------------------------------------------------------
+#	ifpi2 driver for AVM Fritz!Card PCI version 2
+#
+# AVM Fritz!Card PCI version 2
+#XXX#device  "ifpi2"
+#
+#---------------------------------------------------------------------------
+#	iwic driver for Winbond W6692 chipset
+#
+# ASUSCOM P-IN100-ST-D (and other Winbond W6692 based cards)
+#XXX#device  iwic
+#
+#---------------------------------------------------------------------------
+#	itjc driver for Siemens ISAC / TJNet Tiger300/320 chipset
+#
+# Traverse Technologies NETjet-S
+# Teles PCI-TJ
+#XXX#device  itjc
+#
+#---------------------------------------------------------------------------
+#	iavc driver (AVM active cards, needs i4bcapi driver!)
+#
+#XXX#device	iavc
+#
+#---------------------------------------------------------------------------
+#	ISDN Protocol Stack - mandatory for all hardware drivers
+#
+# Q.921 / layer 2 - i4b passive cards D channel handling
+#XXX#device		"i4bq921"
+#
+# Q.931 / layer 3 - i4b passive cards D channel handling
+#XXX#device		"i4bq931"
+#
+# layer 4 - i4b common passive and active card handling
+#XXX#device		"i4b"
+#
+#---------------------------------------------------------------------------
+#	ISDN devices - mandatory for all hardware drivers
+#
+# userland driver to do ISDN tracing (for passive cards only)
+#XXX#device		"i4btrc"	4
+#
+# userland driver to control the whole thing
+#XXX#device		"i4bctl"
+#
+#---------------------------------------------------------------------------
+#	ISDN devices - optional
+#
+# userland driver for access to raw B channel
+#XXX#device		"i4brbch"	4
+#
+# userland driver for telephony
+#XXX#device		"i4btel"	2
+#
+# network driver for IP over raw HDLC ISDN
+#XXX#device		"i4bipr"	4
+# enable VJ header compression detection for ipr i/f
+options 	IPR_VJ
+# enable logging of the first n IP packets to isdnd (n=32 here)
+options 	IPR_LOG=32
+#
+# network driver for sync PPP over ISDN; requires an equivalent
+# number of sppp device to be configured
+#XXX#device		"i4bisppp"	4
+#
+# B-channel interface to the netgraph subsystem
+#XXX#device		"i4bing"	2
+#
+#---------------------------------------------------------------------------
 
 #
 # Set the number of PV entries per process.  Increasing this can
-# stop panics related to heavy use of shared memory. However, that can
+# stop panics related to heavy use of shared memory.  However, that can
 # (combined with large amounts of physical memory) cause panics at
 # boot time due the kernel running out of VM space.
 #
@@ -315,48 +445,52 @@ options 	CY_PCI_FASTINTR		# Use with cy_pci unless irq is shared
 #
 # The value below is the one more than the default.
 #
-#options 	PMAP_SHPGPERPROC=201
-
-#
-# Change the size of the kernel virtual address space.  Due to
-# constraints in loader(8) on i386, this must be a multiple of 4.
-# 256 = 1 GB of kernel address space.  Increasing this also causes
-# a reduction of the address space in user processes.  512 splits
-# the 4GB cpu address space in half (2GB user, 2GB kernel).
-#
-options 	KVA_PAGES=260
+options 	PMAP_SHPGPERPROC=201
 
 
 #####################################################################
 # ABI Emulation
 
+#XXX keep these here for now and reactivate when support for emulating
+#XXX these 32 bit binaries is added.
+
+# Enable iBCS2 runtime support for SCO and ISC binaries
+#XXX#options 	IBCS2
+
+# Emulate spx device for client side of SVR3 local X interface
+#XXX#options 	SPX_HACK
+
 # Enable Linux ABI emulation
-#options 	COMPAT_LINUX
+#XXX#options 	COMPAT_LINUX
 
 # Enable the linux-like proc filesystem support (requires COMPAT_LINUX
 # and PSEUDOFS)
-#options 	LINPROCFS
+#XXX#options 	LINPROCFS
+
+#
+# SysVR4 ABI emulation
+#
+# The svr4 ABI emulator can be statically compiled into the kernel or loaded as
+# a KLD module.
+# The STREAMS network emulation code can also be compiled statically or as a
+# module.  If loaded as a module, it must be loaded before the svr4 module
+# (the /usr/sbin/svr4 script does this for you).  If compiling statically,
+# the `streams' device must be configured into any kernel which also
+# specifies COMPAT_SVR4.  It is possible to have a statically-configured
+# STREAMS device and a dynamically loadable svr4 emulator;  the /usr/sbin/svr4
+# script understands that it doesn't need to load the `streams' module under
+# those circumstances.
+# Caveat:  At this time, `options KTRACE' is required for the svr4 emulator
+# (whether static or dynamic).
+#
+#XXX#options 	COMPAT_SVR4	# build emulator statically
+options 	DEBUG_SVR4	# enable verbose debugging
+#XXX#device	streams		# STREAMS network driver (required for svr4).
 
 
 #####################################################################
 # VM OPTIONS
 
-# Disable the 4 MByte page PSE CPU feature.  The PSE feature allows the
-# kernel to use a 4 MByte pages to map the kernel instead of 4k pages.
-# This saves on the amount of memory needed for page tables needed to
-# map the kernel.  You should only disable this feature as a temporary
-# workaround if you are having problems with it enabled.
-#
-#options 	DISABLE_PSE
-
-# Disable the global pages PGE CPU feature.  The PGE feature allows pages
-# to be marked with the PG_G bit.  TLB entries for these pages are not
-# flushed from the cache when %cr3 is reloaded.  This can make context
-# switches less expensive.  You should only disable this feature as a
-# temporary workaround if you are having problems with it enabled.
-#
-#options 	DISABLE_PG_G
-
 # KSTACK_PAGES is the number of memory pages to assign to the kernel
 # stack of each thread.
 
@@ -369,6 +503,10 @@ options 	KSTACK_PAGES=3
 
 options 	FB_INSTALL_CDEV		# install a CDEV entry in /dev
 
+# PECOFF module (Win32 Execution Format)
+options 	PECOFF_SUPPORT
+options 	PECOFF_DEBUG
+
 options 	ENABLE_ALART
 options 	KBDIO_DEBUG=2
 options 	KBD_MAXRETRY=4