NOTES revision 232614
1210284Sjmallett# 2215990Sjmallett# NOTES -- Lines that can be cut/pasted into kernel and hints configs. 3215990Sjmallett# 4210284Sjmallett# This file contains machine dependent kernel configuration notes. For 5210284Sjmallett# machine independent notes, look in /sys/conf/NOTES. 6215990Sjmallett# 7215990Sjmallett# $FreeBSD: head/sys/amd64/conf/NOTES 232614 2012-03-06 18:44:52Z bz $ 8215990Sjmallett# 9210284Sjmallett 10215990Sjmallett# 11215990Sjmallett# We want LINT to cover profiling as well. 12210284Sjmallettprofile 2 13215990Sjmallett 14215990Sjmallett# 15215990Sjmallett# Enable the kernel DTrace hooks which are required to load the DTrace 16215990Sjmallett# kernel modules. 17215990Sjmallett# 18215990Sjmallettoptions KDTRACE_HOOKS 19215990Sjmallett 20215990Sjmallett 21215990Sjmallett##################################################################### 22215990Sjmallett# SMP OPTIONS: 23215990Sjmallett# 24215990Sjmallett# Notes: 25215990Sjmallett# 26215990Sjmallett# IPI_PREEMPTION instructs the kernel to preempt threads running on other 27215990Sjmallett# CPUS if needed. Relies on the PREEMPTION option 28215990Sjmallett 29215990Sjmallett# Optional: 30215990Sjmallettoptions IPI_PREEMPTION 31215990Sjmallettdevice atpic # Optional legacy pic support 32215990Sjmallettdevice mptable # Optional MPSPEC mptable support 33215990Sjmallett 34215990Sjmallett# 35215990Sjmallett# Watchdog routines. 36215990Sjmallett# 37215990Sjmallettoptions MP_WATCHDOG 38210284Sjmallett 39210284Sjmallett# Debugging options. 40210284Sjmallett# 41210284Sjmallettoptions COUNT_XINVLTLB_HITS # Counters for TLB events 42210284Sjmallettoptions COUNT_IPIS # Per-CPU IPI interrupt counters 43210284Sjmallett 44215990Sjmallett 45210284Sjmallett 46210284Sjmallett##################################################################### 47210284Sjmallett# CPU OPTIONS 48210284Sjmallett 49210284Sjmallett# 50210284Sjmallett# You must specify at least one CPU (the one you intend to run on); 51210284Sjmallett# deleting the specification for CPUs you don't need to use may make 52210284Sjmallett# parts of the system run faster. 53215990Sjmallett# 54210284Sjmallettcpu HAMMER # aka K8, aka Opteron & Athlon64 55210284Sjmallett 56215990Sjmallett# 57210284Sjmallett# Options for CPU features. 58215990Sjmallett# 59210284Sjmallett 60210284Sjmallett# 61210284Sjmallett# PERFMON causes the driver for Pentium/Pentium Pro performance counters 62210284Sjmallett# to be compiled. See perfmon(4) for more information. 63210284Sjmallett# 64210284Sjmallett#XXX#options PERFMON 65210284Sjmallett 66210284Sjmallett 67210284Sjmallett##################################################################### 68210284Sjmallett# NETWORKING OPTIONS 69210284Sjmallett 70210284Sjmallett# 71210284Sjmallett# DEVICE_POLLING adds support for mixed interrupt-polling handling 72210284Sjmallett# of network device drivers, which has significant benefits in terms 73215990Sjmallett# of robustness to overloads and responsivity, as well as permitting 74215990Sjmallett# accurate scheduling of the CPU time between kernel network processing 75210284Sjmallett# and other activities. The drawback is a moderate (up to 1/HZ seconds) 76210284Sjmallett# potential increase in response times. 77210284Sjmallett# It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING 78210284Sjmallett# to achieve smoother behaviour. 79210284Sjmallett# Additionally, you can enable/disable polling at runtime with help of 80210284Sjmallett# the ifconfig(8) utility, and select the CPU fraction reserved to 81210284Sjmallett# userland with the sysctl variable kern.polling.user_frac 82210284Sjmallett# (default 50, range 0..100). 83210284Sjmallett# 84210284Sjmallett# Not all device drivers support this mode of operation at the time of 85210284Sjmallett# this writing. See polling(4) for more details. 86210284Sjmallett 87210284Sjmallettoptions DEVICE_POLLING 88210284Sjmallett 89210284Sjmallett# BPF_JITTER adds support for BPF just-in-time compiler. 90210284Sjmallett 91210284Sjmallettoptions BPF_JITTER 92210284Sjmallett 93210284Sjmallett 94210284Sjmallett##################################################################### 95210284Sjmallett# CLOCK OPTIONS 96210284Sjmallett 97210284Sjmallett# Provide read/write access to the memory in the clock chip. 98210284Sjmallettdevice nvram # Access to rtc cmos via /dev/nvram 99210284Sjmallett 100210284Sjmallett 101210284Sjmallett##################################################################### 102210284Sjmallett# MISCELLANEOUS DEVICES AND OPTIONS 103210284Sjmallett 104210284Sjmallettdevice speaker #Play IBM BASIC-style noises out your speaker 105210284Sjmalletthint.speaker.0.at="isa" 106210284Sjmalletthint.speaker.0.port="0x61" 107210284Sjmallettdevice gzip #Exec gzipped a.out's. REQUIRES COMPAT_AOUT! 108210284Sjmallett 109210284Sjmallett 110210284Sjmallett##################################################################### 111210284Sjmallett# HARDWARE BUS CONFIGURATION 112210284Sjmallett 113210284Sjmallett# 114210284Sjmallett# ISA bus 115210284Sjmallett# 116210284Sjmallettdevice isa 117210284Sjmallett 118210284Sjmallett# 119210284Sjmallett# Options for `isa': 120210284Sjmallett# 121210284Sjmallett# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A 122210284Sjmallett# interrupt controller. This saves about 0.7-1.25 usec for each interrupt. 123210284Sjmallett# This option breaks suspend/resume on some portables. 124210284Sjmallett# 125210284Sjmallett# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A 126210284Sjmallett# interrupt controller. This saves about 0.7-1.25 usec for each interrupt. 127210284Sjmallett# Automatic EOI is documented not to work for for the slave with the 128210284Sjmallett# original i8259A, but it works for some clones and some integrated 129210284Sjmallett# versions. 130210284Sjmallett# 131210284Sjmallett# MAXMEM specifies the amount of RAM on the machine; if this is not 132210284Sjmallett# specified, FreeBSD will first read the amount of memory from the CMOS 133210284Sjmallett# RAM, so the amount of memory will initially be limited to 64MB or 16MB 134210284Sjmallett# depending on the BIOS. If the BIOS reports 64MB, a memory probe will 135210284Sjmallett# then attempt to detect the installed amount of RAM. If this probe 136210284Sjmallett# fails to detect >64MB RAM you will have to use the MAXMEM option. 137210284Sjmallett# The amount is in kilobytes, so for a machine with 128MB of RAM, it would 138210284Sjmallett# be 131072 (128 * 1024). 139210284Sjmallett# 140210284Sjmallett# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to 141210284Sjmallett# reset the CPU for reboot. This is needed on some systems with broken 142210284Sjmallett# keyboard controllers. 143210284Sjmallett 144210284Sjmallettoptions AUTO_EOI_1 145210284Sjmallett#options AUTO_EOI_2 146210284Sjmallett 147210284Sjmallettoptions MAXMEM=(128*1024) 148210284Sjmallett#options BROKEN_KEYBOARD_RESET 149210284Sjmallett 150210284Sjmallett# 151210284Sjmallett# PCI bus & PCI options: 152210284Sjmallett# 153210284Sjmallettdevice pci 154210284Sjmallett 155210284Sjmallett# 156210284Sjmallett# AGP GART support 157210284Sjmallettdevice agp 158210284Sjmallett 159210284Sjmallett# 160210284Sjmallett# AGP debugging. 161210284Sjmallett# 162210284Sjmallettoptions AGP_DEBUG 163210284Sjmallett 164210284Sjmallett 165210284Sjmallett##################################################################### 166210284Sjmallett# HARDWARE DEVICE CONFIGURATION 167210284Sjmallett 168210284Sjmallett# To include support for VGA VESA video modes 169210284Sjmallettoptions VESA 170210284Sjmallett 171210284Sjmallett# Turn on extra debugging checks and output for VESA support. 172215990Sjmallettoptions VESA_DEBUG 173215990Sjmallett 174215990Sjmallettdevice dpms # DPMS suspend & resume via VESA BIOS 175215990Sjmallett 176215990Sjmallett# x86 real mode BIOS emulator, required by atkbdc/dpms/vesa 177215990Sjmallettoptions X86BIOS 178215990Sjmallett 179215990Sjmallett# 180215990Sjmallett# Optional devices: 181215990Sjmallett# 182210284Sjmallett 183210284Sjmallett# PS/2 mouse 184210284Sjmallettdevice psm 185210284Sjmalletthint.psm.0.at="atkbdc" 186210284Sjmalletthint.psm.0.irq="12" 187210284Sjmallett 188210284Sjmallett# Options for psm: 189210284Sjmallettoptions PSM_HOOKRESUME #hook the system resume event, useful 190210284Sjmallett #for some laptops 191210284Sjmallettoptions PSM_RESETAFTERSUSPEND #reset the device at the resume event 192210284Sjmallett 193210284Sjmallett# The keyboard controller; it controls the keyboard and the PS/2 mouse. 194210284Sjmallettdevice atkbdc 195hint.atkbdc.0.at="isa" 196hint.atkbdc.0.port="0x060" 197 198# The AT keyboard 199device atkbd 200hint.atkbd.0.at="atkbdc" 201hint.atkbd.0.irq="1" 202 203# Options for atkbd: 204options ATKBD_DFLT_KEYMAP # specify the built-in keymap 205makeoptions ATKBD_DFLT_KEYMAP=jp.106 206 207# `flags' for atkbd: 208# 0x01 Force detection of keyboard, else we always assume a keyboard 209# 0x02 Don't reset keyboard, useful for some newer ThinkPads 210# 0x03 Force detection and avoid reset, might help with certain 211# dockingstations 212# 0x04 Old-style (XT) keyboard support, useful for older ThinkPads 213 214# Video card driver for VGA adapters. 215device vga 216hint.vga.0.at="isa" 217 218# Options for vga: 219# Try the following option if the mouse pointer is not drawn correctly 220# or font does not seem to be loaded properly. May cause flicker on 221# some systems. 222options VGA_ALT_SEQACCESS 223 224# If you can dispense with some vga driver features, you may want to 225# use the following options to save some memory. 226#options VGA_NO_FONT_LOADING # don't save/load font 227#options VGA_NO_MODE_CHANGE # don't change video modes 228 229# Older video cards may require this option for proper operation. 230options VGA_SLOW_IOACCESS # do byte-wide i/o's to TS and GDC regs 231 232# The following option probably won't work with the LCD displays. 233options VGA_WIDTH90 # support 90 column modes 234 235# Debugging. 236options VGA_DEBUG 237 238# Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA. 239device s3pci 240 241# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support. This will create 242# the /dev/3dfx0 device to work with glide implementations. This should get 243# linked to /dev/3dfx and /dev/voodoo. Note that this is not the same as 244# the tdfx DRI module from XFree86 and is completely unrelated. 245# 246# To enable Linuxulator support, one must also include COMPAT_LINUX in the 247# config as well. The other option is to load both as modules. 248 249device tdfx # Enable 3Dfx Voodoo support 250#XXX#device tdfx_linux # Enable Linuxulator support 251 252# 253# ACPI support using the Intel ACPI Component Architecture reference 254# implementation. 255# 256# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer 257# kernel environment variables to select initial debugging levels for the 258# Intel ACPICA code. (Note that the Intel code must also have USE_DEBUGGER 259# defined when it is built). 260 261device acpi 262options ACPI_DEBUG 263 264# The cpufreq(4) driver provides support for non-ACPI CPU frequency control 265device cpufreq 266 267# Direct Rendering modules for 3D acceleration. 268device drm # DRM core module required by DRM drivers 269device i915drm # Intel i830 through i915 270device mach64drm # ATI Rage Pro, Rage Mobility P/M, Rage XL 271device mgadrm # AGP Matrox G200, G400, G450, G550 272device r128drm # ATI Rage 128 273device radeondrm # ATI Radeon 274device savagedrm # S3 Savage3D, Savage4 275device sisdrm # SiS 300/305, 540, 630 276device tdfxdrm # 3dfx Voodoo 3/4/5 and Banshee 277device viadrm # VIA 278options DRM_DEBUG # Include debug printfs (slow) 279 280# 281# Network interfaces: 282# 283 284# ed: Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503 285# HP PC Lan+, various PC Card devices 286# (requires miibus) 287# ipw: Intel PRO/Wireless 2100 IEEE 802.11 adapter 288# Requires the ipw firmware module 289# iwi: Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters 290# Requires the iwi firmware module 291# iwn: Intel Wireless WiFi Link 4965/1000/5000/6000 802.11 network adapters 292# Requires the iwn firmware module 293# mwl: Marvell 88W8363 IEEE 802.11 adapter 294# Requires the mwl firmware module 295# nfe: nVidia nForce MCP on-board Ethernet Networking (BSD open source) 296# nve: nVidia nForce MCP on-board Ethernet Networking 297# sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters 298# wpi: Intel 3945ABG Wireless LAN controller 299# Requires the wpi firmware module 300 301device ed 302options ED_3C503 303options ED_HPP 304options ED_SIC 305device ipw 306device iwi 307device iwn 308device mwl 309device nfe 310device nve 311device sfxge 312device wpi 313 314# IEEE 802.11 adapter firmware modules 315 316# Intel PRO/Wireless 2100 firmware: 317# ipwfw: BSS/IBSS/monitor mode firmware 318# ipwbssfw: BSS mode firmware 319# ipwibssfw: IBSS mode firmware 320# ipwmonitorfw: Monitor mode firmware 321# Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware: 322# iwifw: BSS/IBSS/monitor mode firmware 323# iwibssfw: BSS mode firmware 324# iwiibssfw: IBSS mode firmware 325# iwimonitorfw: Monitor mode firmware 326# Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware: 327# iwnfw: Single module to support the 4965/1000/5000/5150/6000 328# iwn4965fw: Specific module for the 4965 only 329# iwn1000fw: Specific module for the 1000 only 330# iwn5000fw: Specific module for the 5000 only 331# iwn5150fw: Specific module for the 5150 only 332# iwn6000fw: Specific module for the 6000 only 333# iwn6050fw: Specific module for the 6050 only 334# mwlfw: Marvell 88W8363 firmware 335# wpifw: Intel 3945ABG Wireless LAN Controller firmware 336 337device iwifw 338device iwibssfw 339device iwiibssfw 340device iwimonitorfw 341device ipwfw 342device ipwbssfw 343device ipwibssfw 344device ipwmonitorfw 345device iwnfw 346device iwn4965fw 347device iwn1000fw 348device iwn5000fw 349device iwn5150fw 350device iwn6000fw 351device iwn6050fw 352device mwlfw 353device wpifw 354 355# 356#XXX this stores pointers in a 32bit field that is defined by the hardware 357#device pst 358 359# 360# Areca 11xx and 12xx series of SATA II RAID controllers. 361# CAM is required. 362# 363device arcmsr # Areca SATA II RAID 364 365# 366# 3ware 9000 series PATA/SATA RAID controller driver and options. 367# The driver is implemented as a SIM, and so, needs the CAM infrastructure. 368# 369options TWA_DEBUG # 0-10; 10 prints the most messages. 370options TWA_FLASH_FIRMWARE # firmware image bundled when defined. 371device twa # 3ware 9000 series PATA/SATA RAID 372 373# 374# SCSI host adapters: 375# 376# ncv: NCR 53C500 based SCSI host adapters. 377# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters. 378# stg: TMC 18C30, 18C50 based SCSI host adapters. 379 380device ncv 381device nsp 382device stg 383 384# 385# Adaptec FSA RAID controllers, including integrated DELL controllers, 386# the Dell PERC 2/QC and the HP NetRAID-4M 387device aac 388device aacp # SCSI Passthrough interface (optional, CAM required) 389 390# 391# Highpoint RocketRAID 27xx. 392device hpt27xx 393 394# 395# Highpoint RocketRAID 182x. 396device hptmv 397 398# 399# Highpoint RocketRAID. Supports RR172x, RR222x, RR2240, RR232x, RR2340, 400# RR2210, RR174x, RR2522, RR231x, RR230x. 401device hptrr 402 403# 404# Highpoint RocketRaid 3xxx series SATA RAID 405device hptiop 406 407# 408# IBM (now Adaptec) ServeRAID controllers 409device ips 410 411# 412# Intel C600 (Patsburg) integrated SAS controller 413device isci 414options ISCI_LOGGING # enable debugging in isci HAL 415 416# 417# SafeNet crypto driver: can be moved to the MI NOTES as soon as 418# it's tested on a big-endian machine 419# 420device safe # SafeNet 1141 421options SAFE_DEBUG # enable debugging support: hw.safe.debug 422options SAFE_RNDTEST # enable rndtest support 423 424##################################################################### 425 426# 427# Miscellaneous hardware: 428# 429# ipmi: Intelligent Platform Management Interface 430# pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724) 431# smbios: DMI/SMBIOS entry point 432# vpd: Vital Product Data kernel interface 433# asmc: Apple System Management Controller 434# si: Specialix International SI/XIO or SX intelligent serial card 435# tpm: Trusted Platform Module 436 437# Notes on the Specialix SI/XIO driver: 438# The host card is memory, not IO mapped. 439# The Rev 1 host cards use a 64K chunk, on a 32K boundary. 440# The Rev 2 host cards use a 32K chunk, on a 32K boundary. 441# The cards can use an IRQ of 11, 12 or 15. 442 443device ipmi 444device pbio 445hint.pbio.0.at="isa" 446hint.pbio.0.port="0x360" 447device smbios 448device vpd 449device asmc 450#device si 451device tpm 452 453# 454# Laptop/Notebook options: 455# 456 457 458# 459# I2C Bus 460# 461 462# 463# Hardware watchdog timers: 464# 465# ichwd: Intel ICH watchdog timer 466# amdsbwd: AMD SB7xx watchdog timer 467# viawd: VIA south bridge watchdog timer 468# wbwd: Winbond watchdog timer 469# 470device ichwd 471device amdsbwd 472device viawd 473device wbwd 474 475# 476# Temperature sensors: 477# 478# coretemp: on-die sensor on Intel Core and newer CPUs 479# amdtemp: on-die sensor on AMD K8/K10/K11 CPUs 480# 481device coretemp 482device amdtemp 483 484# 485# CPU control pseudo-device. Provides access to MSRs, CPUID info and 486# microcode update feature. 487# 488device cpuctl 489 490# 491# System Management Bus (SMB) 492# 493options ENABLE_ALART # Control alarm on Intel intpm driver 494 495# 496# Set the number of PV entries per process. Increasing this can 497# stop panics related to heavy use of shared memory. However, that can 498# (combined with large amounts of physical memory) cause panics at 499# boot time due the kernel running out of VM space. 500# 501# If you're tweaking this, you might also want to increase the sysctls 502# "vm.v_free_min", "vm.v_free_reserved", and "vm.v_free_target". 503# 504# The value below is the one more than the default. 505# 506options PMAP_SHPGPERPROC=201 507 508# 509# Number of initial kernel page table pages used for early bootstrap. 510# This number should include enough pages to map the kernel and any 511# modules or other data loaded with the kernel by the loader. Each 512# page table page maps 2MB. 513# 514options NKPT=31 515 516 517##################################################################### 518# ABI Emulation 519 520#XXX keep these here for now and reactivate when support for emulating 521#XXX these 32 bit binaries is added. 522 523# Enable 32-bit runtime support for FreeBSD/i386 binaries. 524options COMPAT_FREEBSD32 525 526# Enable iBCS2 runtime support for SCO and ISC binaries 527#XXX#options IBCS2 528 529# Emulate spx device for client side of SVR3 local X interface 530#XXX#options SPX_HACK 531 532# Enable Linux ABI emulation 533#XXX#options COMPAT_LINUX 534 535# Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_FREEBSD32) 536options COMPAT_LINUX32 537 538# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32 539# and PSEUDOFS) 540options LINPROCFS 541 542#Enable the linux-like sys filesystem support (requires COMPAT_LINUX32 543# and PSEUDOFS) 544options LINSYSFS 545 546# 547# SysVR4 ABI emulation 548# 549# The svr4 ABI emulator can be statically compiled into the kernel or loaded as 550# a KLD module. 551# The STREAMS network emulation code can also be compiled statically or as a 552# module. If loaded as a module, it must be loaded before the svr4 module 553# (the /usr/sbin/svr4 script does this for you). If compiling statically, 554# the `streams' device must be configured into any kernel which also 555# specifies COMPAT_SVR4. It is possible to have a statically-configured 556# STREAMS device and a dynamically loadable svr4 emulator; the /usr/sbin/svr4 557# script understands that it doesn't need to load the `streams' module under 558# those circumstances. 559# Caveat: At this time, `options KTRACE' is required for the svr4 emulator 560# (whether static or dynamic). 561# 562#XXX#options COMPAT_SVR4 # build emulator statically 563#XXX#options DEBUG_SVR4 # enable verbose debugging 564#XXX#device streams # STREAMS network driver (required for svr4). 565 566 567##################################################################### 568# VM OPTIONS 569 570# KSTACK_PAGES is the number of memory pages to assign to the kernel 571# stack of each thread. 572 573options KSTACK_PAGES=5 574 575##################################################################### 576 577# More undocumented options for linting. 578# Note that documenting these are not considered an affront. 579 580options FB_INSTALL_CDEV # install a CDEV entry in /dev 581 582options KBDIO_DEBUG=2 583options KBD_MAXRETRY=4 584options KBD_MAXWAIT=6 585options KBD_RESETDELAY=201 586 587options PSM_DEBUG=1 588 589options TIMER_FREQ=((14318182+6)/12) 590 591options VM_KMEM_SIZE 592options VM_KMEM_SIZE_MAX 593options VM_KMEM_SIZE_SCALE 594 595# Enable NDIS binary driver support 596options NDISAPI 597device ndis 598 599# Linux-specific pseudo devices support 600device lindev 601