This commit was generated by cvs2svn to compensate for changes in r171366,

[FreeBSD/FreeBSD.git] / sys / amd64 / conf / NOTES

#
# NOTES -- Lines that can be cut/pasted into kernel and hints configs.
#
# This file contains machine dependent kernel configuration notes.  For
# machine independent notes, look in /sys/conf/NOTES.
#
# $FreeBSD$
#

#
# We want LINT to cover profiling as well.
profile         2

\f
#####################################################################
# SMP OPTIONS:
#
# Notes:
#
# IPI_PREEMPTION instructs the kernel to preempt threads running on other
#         CPUS if needed.  Relies on the PREEMPTION option

# Optional:
options         IPI_PREEMPTION
device          atpic                   # Optional legacy pic support
device          mptable                 # Optional MPSPEC mptable support

#
# Watchdog routines.
#
options         MP_WATCHDOG

# 
# Debugging options.
#
options         STOP_NMI                # Stop CPUS using NMI instead of IPI


\f
#####################################################################
# 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.
#
#XXX#options    PERFMON

\f
#####################################################################
# NETWORKING OPTIONS

#
# DEVICE_POLLING adds support for mixed interrupt-polling handling
# 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)
# potential increase in response times.
# It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING
# to achieve smoother behaviour.
# Additionally, you can enable/disable polling at runtime with help of
# the ifconfig(8) utility, and select the CPU fraction reserved to
# userland with the sysctl variable kern.polling.user_frac
# (default 50, range 0..100).
#
# Not all device drivers support this mode of operation at the time of
# this writing.  See polling(4) for more details.

options         DEVICE_POLLING

\f
#####################################################################
# CLOCK OPTIONS

# The following options are used for debugging clock behavior only, and
# should not be used for production systems.

# 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

\f
#####################################################################
# MISCELLANEOUS DEVICES AND OPTIONS

# 
# sio: serial ports (see sio(4)), including support for various
#      PC Card devices, such as Modem and NICs
#
device          sio
hint.sio.0.at="isa"
hint.sio.0.port="0x3F8"
hint.sio.0.flags="0x10"
hint.sio.0.irq="4"

# `flags' specific to sio(4).
#       0x10    enable console support for this unit.  Other console flags
#               (if applicable) are ignored unless this is set.  Enabling
#               console support does not make the unit the preferred console.
#               Boot with -h or set boot_serial=YES in the loader.  For sio(4)
#               specifically, the 0x20 flag can also be set (see above).
#               Currently, at most one unit can have console support; the
#               first one (in config file order) with this flag set is
#               preferred.  Setting this flag for sio0 gives the old behaviour.
#       0x20    force this unit to be the console (unless there is another
#               higher priority console).  This replaces the COMCONSOLE option.
#       0x40    reserve this unit for low level console operations.  Do not
#               access the device in any normal way.
#       0x80    use this port for serial line gdb support in ddb.  Also known
#               as debug port.
# PnP `flags'
#       0x1     disable probing of this device.  Used to prevent your modem
#               from being attached as a PnP modem.
# Other flags for sio that aren't documented in the man page.
#       0x20000 enable hardware RTS/CTS and larger FIFOs.  Only works for
#               ST16650A-compatible UARTs.

# Options for sio:
options         COM_ESP                 # Code for Hayes ESP.
options         COM_MULTIPORT           # Code for some cards with shared IRQs.
options         CONSPEED=115200         # Speed for serial console
                                        # (default 9600).

device          speaker         #Play IBM BASIC-style noises out your speaker
hint.speaker.0.at="isa"
hint.speaker.0.port="0x61"
device          gzip            #Exec gzipped a.out's.  REQUIRES COMPAT_AOUT!

\f
#####################################################################
# HARDWARE BUS CONFIGURATION

#
# ISA bus
#
device          isa

#
# Options for `isa':
#
# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
# This option breaks suspend/resume on some portables.
#
# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
# interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
# Automatic EOI is documented not to work for for the slave with the
# original i8259A, but it works for some clones and some integrated
# versions.
#
# MAXMEM specifies the amount of RAM on the machine; if this is not
# specified, FreeBSD will first read the amount of memory from the CMOS
# RAM, so the amount of memory will initially be limited to 64MB or 16MB
# depending on the BIOS.  If the BIOS reports 64MB, a memory probe will
# then attempt to detect the installed amount of RAM.  If this probe
# fails to detect >64MB RAM you will have to use the MAXMEM option.
# The amount is in kilobytes, so for a machine with 128MB of RAM, it would
# be 131072 (128 * 1024).
#
# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
# 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

#
# PCI bus & PCI options:
#
device          pci

#
# AGP GART support
device          agp

\f
#####################################################################
# HARDWARE DEVICE CONFIGURATION

#
# Optional devices:
#

# PS/2 mouse
device          psm
hint.psm.0.at="atkbdc"
hint.psm.0.irq="12"

# Options for psm:
options         PSM_HOOKRESUME          #hook the system resume event, useful
                                        #for some laptops
options         PSM_RESETAFTERSUSPEND   #reset the device at the resume event

# The keyboard controller; it controls the keyboard and the PS/2 mouse.
device          atkbdc
hint.atkbdc.0.at="isa"
hint.atkbdc.0.port="0x060"

# The AT keyboard
device          atkbd
hint.atkbd.0.at="atkbdc"
hint.atkbd.0.irq="1"

# Options for atkbd:
options         ATKBD_DFLT_KEYMAP       # specify the built-in keymap
makeoptions     ATKBD_DFLT_KEYMAP=jp.106

# `flags' for atkbd:
#       0x01    Force detection of keyboard, else we always assume a keyboard
#       0x02    Don't reset keyboard, useful for some newer ThinkPads
#       0x03    Force detection and avoid reset, might help with certain
#               dockingstations
#       0x04    Old-style (XT) keyboard support, useful for older ThinkPads

# Video card driver for VGA adapters.
device          vga
hint.vga.0.at="isa"

# Options for vga:
# Try the following option if the mouse pointer is not drawn correctly
# or font does not seem to be loaded properly.  May cause flicker on
# some systems.
options         VGA_ALT_SEQACCESS

# If you can dispense with some vga driver features, you may want to
# use the following options to save some memory.
#options        VGA_NO_FONT_LOADING     # don't save/load font
#options        VGA_NO_MODE_CHANGE      # don't change video modes

# Older video cards may require this option for proper operation.
options         VGA_SLOW_IOACCESS       # do byte-wide i/o's to TS and GDC regs

# The following option probably won't work with the LCD displays.
options         VGA_WIDTH90             # support 90 column modes

# Debugging.
options         VGA_DEBUG

# 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.  The other option is to load both as modules.

device          tdfx                    # Enable 3Dfx Voodoo support
#XXX#device     tdfx_linux              # Enable Linuxulator support

#
# ACPI support using the Intel ACPI Component Architecture reference
# implementation.
#
# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
# kernel environment variables to select initial debugging levels for the
# Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
# defined when it is built).
#
# ACPI_NO_SEMAPHORES makes the AcpiOs*Semaphore routines a no-op.

device          acpi
options         ACPI_DEBUG
#!options       ACPI_NO_SEMAPHORES

# The cpufreq(4) driver provides support for non-ACPI CPU frequency control
device          cpufreq

# Direct Rendering modules for 3D acceleration.
device          drm             # DRM core module required by DRM drivers
device          i915drm         # Intel i830 through i915
device          mach64drm       # ATI Rage Pro, Rage Mobility P/M, Rage XL
device          mgadrm          # AGP Matrox G200, G400, G450, G550
device          r128drm         # ATI Rage 128
device          radeondrm       # ATI Radeon
device          savagedrm       # S3 Savage3D, Savage4
device          sisdrm          # SiS 300/305, 540, 630
device          tdfxdrm         # 3dfx Voodoo 3/4/5 and Banshee
options         DRM_DEBUG       # Include debug printfs (slow)

#
# Network interfaces:
#

# ath:  Atheros a/b/g WiFi adapters (requires ath_hal and wlan)
# ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
#       HP PC Lan+, various PC Card devices
#       (requires miibus)
# ipw:  Intel PRO/Wireless 2100 IEEE 802.11 adapter
# iwi:  Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
# nfe:  nVidia nForce MCP on-board Ethernet Networking (BSD open source)
# nve:  nVidia nForce MCP on-board Ethernet Networking
# ral:  Ralink Technology IEEE 802.11 wireless adapter
# ural: Ralink Technology RT2500USB IEEE 802.11 wireless adapter

device          ed
options         ED_3C503
options         ED_HPP
options         ED_SIC
device          iwi
device          ipw
device          nfe             # nVidia nForce MCP on-board Ethernet Networking
device          nve             # nVidia nForce MCP on-board Ethernet Networking
device          ral
device          ural

device          ath
device          ath_hal         # Atheros HAL (includes binary component)
#device         ath_rate_amrr   # AMRR rate control for ath driver
#device         ath_rate_onoe   # Onoe rate control for ath driver
device          ath_rate_sample # SampleRate rate control for the ath driver
#device         wlan            # 802.11 layer

#
#XXX this stores pointers in a 32bit field that is defined by the hardware
#device pst

#
# Areca 11xx and 12xx series of SATA II RAID controllers.
# CAM is required.
#
device          arcmsr          # Areca SATA II RAID

#
# 3ware 9000 series PATA/SATA RAID controller driver and options.
# The driver is implemented as a SIM, and so, needs the CAM infrastructure.
#
options         TWA_DEBUG               # 0-10; 10 prints the most messages.
options         TWA_FLASH_FIRMWARE      # firmware image bundled when defined.
device          twa                     # 3ware 9000 series PATA/SATA RAID

#
# 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.

device          ncv
device          nsp
device          stg

#
# Adaptec FSA RAID controllers, including integrated DELL controllers,
# the Dell PERC 2/QC and the HP NetRAID-4M
device          aac
device          aacp    # SCSI Passthrough interface (optional, CAM required)

#
# Highpoint RocketRAID 182x.  This is really just software RAID on a
# Marvell SATA chip.
device          hptmv

#
# Highpoint RocketRAID 232x.  This is software RAID but with hardware
# acceleration assistance for RAID_5.
device          rr232x

#
# Highpoint RocketRaid 3xxx series SATA RAID
device          hptiop

#
# IBM (now Adaptec) ServeRAID controllers
device          ips

#
# SafeNet crypto driver: can be moved to the MI NOTES as soon as
# it's tested on a big-endian machine
#
device          safe            # SafeNet 1141
options         SAFE_DEBUG      # enable debugging support: hw.safe.debug
options         SAFE_RNDTEST    # enable rndtest support

#####################################################################

#
# Miscellaneous hardware:
#
# ipmi: Intelligent Platform Management Interface
# smbios: DMI/SMBIOS entry point
# vpd: Vital Product Data kernel interface
# cy: Cyclades serial driver
# digi: Digiboard driver

# Notes on the Specialix SI/XIO driver:
#  The host card is memory, not IO mapped.
#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
#  The cards can use an IRQ of 11, 12 or 15.

device          cy
options         CY_PCI_FASTINTR         # Use with cy_pci unless irq is shared
device          digi
# BIOS & FEP/OS components of device digi.
device          digi_CX
device          digi_CX_PCI
device          digi_EPCX
device          digi_EPCX_PCI
device          digi_Xe
device          digi_Xem
device          digi_Xr
device          ipmi
# Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
device          pbio
hint.pbio.0.at="isa"
hint.pbio.0.port="0x360"
device          smbios
device          vpd
# HOT1 Xilinx 6200 card (http://www.vcc.com/)
device          xrpu

#
# Laptop/Notebook options:
#


#
# I2C Bus
#

#
# Hardware watchdog timers:
#
# ichwd: Intel ICH watchdog timer
#
device          ichwd

#---------------------------------------------------------------------------
# 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:
# --------------
#
# 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
#XXX#options    NI4BTRC=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
#XXX#options    NI4BRBCH=4
#
# userland driver for telephony
#XXX#device     i4btel
#XXX#options    NI4BTEL=2
#
# network driver for IP over raw HDLC ISDN
#XXX#device     i4bipr
#XXX#options    NI4BIPR=4
# enable VJ header compression detection for ipr i/f
#XXX#options    IPR_VJ
# enable logging of the first n IP packets to isdnd (n=32 here)
#XXX#options    IPR_LOG=32
#
# network driver for sync PPP over ISDN; requires an equivalent
# number of sppp device to be configured
#XXX#device     i4bisppp
#XXX#options    NI4BISPPP=4
#
# B-channel interface to the netgraph subsystem
#XXX#device     i4bing
#XXX#options    NI4BING=2
#
# CAPI driver needed for active ISDN cards (see iavc driver above)
#XXX#device     i4bcapi
#
#---------------------------------------------------------------------------

#
# System Management Bus (SMB)
#
options         ENABLE_ALART            # Control alarm on Intel intpm driver

#
# Set the number of PV entries per process.  Increasing this 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.
#
# If you're tweaking this, you might also want to increase the sysctls
# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target".
#
# The value below is the one more than the default.
#
options         PMAP_SHPGPERPROC=201

\f
#####################################################################
# ABI Emulation

#XXX keep these here for now and reactivate when support for emulating
#XXX these 32 bit binaries is added.

# Enable 32-bit runtime support for FreeBSD/i386 binaries.
options         COMPAT_IA32

# 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
#XXX#options    COMPAT_LINUX

# Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_IA32)
options         COMPAT_LINUX32

# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
# and PSEUDOFS)
options         LINPROCFS

#Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
# and PSEUDOFS)
options         LINSYSFS

#
# 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
#XXX#options    DEBUG_SVR4      # enable verbose debugging
#XXX#device     streams         # STREAMS network driver (required for svr4).

\f
#####################################################################
# VM OPTIONS

# KSTACK_PAGES is the number of memory pages to assign to the kernel
# stack of each thread.

options         KSTACK_PAGES=3

#####################################################################

# More undocumented options for linting.
# Note that documenting these are not considered an affront.

options         FB_INSTALL_CDEV         # install a CDEV entry in /dev

options         KBDIO_DEBUG=2
options         KBD_MAXRETRY=4
options         KBD_MAXWAIT=6
options         KBD_RESETDELAY=201

options         PSM_DEBUG=1

options         TIMER_FREQ=((14318182+6)/12)

options         VM_KMEM_SIZE
options         VM_KMEM_SIZE_MAX
options         VM_KMEM_SIZE_SCALE

# Enable NDIS binary driver support
options         NDISAPI
device          ndis