NOTES revision 331769
1# 2# NOTES -- Lines that can be cut/pasted into kernel and hints configs. 3# 4# This file contains machine dependent kernel configuration notes. For 5# machine independent notes, look in /sys/conf/NOTES. 6# 7# $FreeBSD: stable/11/sys/amd64/conf/NOTES 331769 2018-03-30 18:06:29Z hselasky $ 8# 9 10# 11# We want LINT to cover profiling as well. 12profile 2 13 14# 15# Enable the kernel DTrace hooks which are required to load the DTrace 16# kernel modules. 17# 18options KDTRACE_HOOKS 19 20# DTrace core 21# NOTE: introduces CDDL-licensed components into the kernel 22#device dtrace 23 24# DTrace modules 25#device dtrace_profile 26#device dtrace_sdt 27#device dtrace_fbt 28#device dtrace_systrace 29#device dtrace_prototype 30#device dtnfscl 31#device dtmalloc 32 33# Alternatively include all the DTrace modules 34#device dtraceall 35 36 37##################################################################### 38# SMP OPTIONS: 39# 40# Notes: 41# 42# IPI_PREEMPTION instructs the kernel to preempt threads running on other 43# CPUS if needed. Relies on the PREEMPTION option 44 45# Optional: 46options IPI_PREEMPTION 47device atpic # Optional legacy pic support 48device mptable # Optional MPSPEC mptable support 49 50# 51# Watchdog routines. 52# 53options MP_WATCHDOG 54 55# Debugging options. 56# 57options COUNT_XINVLTLB_HITS # Counters for TLB events 58options COUNT_IPIS # Per-CPU IPI interrupt counters 59 60 61 62##################################################################### 63# CPU OPTIONS 64 65# 66# You must specify at least one CPU (the one you intend to run on); 67# deleting the specification for CPUs you don't need to use may make 68# parts of the system run faster. 69# 70cpu HAMMER # aka K8, aka Opteron & Athlon64 71 72# 73# Options for CPU features. 74# 75 76# 77# PERFMON causes the driver for Pentium/Pentium Pro performance counters 78# to be compiled. See perfmon(4) for more information. 79# 80#XXX#options PERFMON 81 82 83##################################################################### 84# NETWORKING OPTIONS 85 86# 87# DEVICE_POLLING adds support for mixed interrupt-polling handling 88# of network device drivers, which has significant benefits in terms 89# of robustness to overloads and responsivity, as well as permitting 90# accurate scheduling of the CPU time between kernel network processing 91# and other activities. The drawback is a moderate (up to 1/HZ seconds) 92# potential increase in response times. 93# It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING 94# to achieve smoother behaviour. 95# Additionally, you can enable/disable polling at runtime with help of 96# the ifconfig(8) utility, and select the CPU fraction reserved to 97# userland with the sysctl variable kern.polling.user_frac 98# (default 50, range 0..100). 99# 100# Not all device drivers support this mode of operation at the time of 101# this writing. See polling(4) for more details. 102 103options DEVICE_POLLING 104 105# BPF_JITTER adds support for BPF just-in-time compiler. 106 107options BPF_JITTER 108 109# OpenFabrics Enterprise Distribution (Infiniband). 110options OFED 111options OFED_DEBUG_INIT 112 113# Sockets Direct Protocol 114options SDP 115options SDP_DEBUG 116 117# IP over Infiniband 118options IPOIB 119options IPOIB_DEBUG 120options IPOIB_CM 121 122 123##################################################################### 124# CLOCK OPTIONS 125 126# Provide read/write access to the memory in the clock chip. 127device nvram # Access to rtc cmos via /dev/nvram 128 129 130##################################################################### 131# MISCELLANEOUS DEVICES AND OPTIONS 132 133device speaker #Play IBM BASIC-style noises out your speaker 134hint.speaker.0.at="isa" 135hint.speaker.0.port="0x61" 136device gzip #Exec gzipped a.out's. REQUIRES COMPAT_AOUT! 137 138 139##################################################################### 140# HARDWARE BUS CONFIGURATION 141 142# 143# ISA bus 144# 145device isa 146 147# 148# Options for `isa': 149# 150# AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A 151# interrupt controller. This saves about 0.7-1.25 usec for each interrupt. 152# This option breaks suspend/resume on some portables. 153# 154# AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A 155# interrupt controller. This saves about 0.7-1.25 usec for each interrupt. 156# Automatic EOI is documented not to work for for the slave with the 157# original i8259A, but it works for some clones and some integrated 158# versions. 159# 160# MAXMEM specifies the amount of RAM on the machine; if this is not 161# specified, FreeBSD will first read the amount of memory from the CMOS 162# RAM, so the amount of memory will initially be limited to 64MB or 16MB 163# depending on the BIOS. If the BIOS reports 64MB, a memory probe will 164# then attempt to detect the installed amount of RAM. If this probe 165# fails to detect >64MB RAM you will have to use the MAXMEM option. 166# The amount is in kilobytes, so for a machine with 128MB of RAM, it would 167# be 131072 (128 * 1024). 168# 169# BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to 170# reset the CPU for reboot. This is needed on some systems with broken 171# keyboard controllers. 172 173options AUTO_EOI_1 174#options AUTO_EOI_2 175 176options MAXMEM=(128*1024) 177#options BROKEN_KEYBOARD_RESET 178 179# 180# AGP GART support 181device agp 182 183# 184# AGP debugging. 185# 186options AGP_DEBUG 187 188 189##################################################################### 190# HARDWARE DEVICE CONFIGURATION 191 192# To include support for VGA VESA video modes 193options VESA 194 195# Turn on extra debugging checks and output for VESA support. 196options VESA_DEBUG 197 198device dpms # DPMS suspend & resume via VESA BIOS 199 200# x86 real mode BIOS emulator, required by atkbdc/dpms/vesa 201options X86BIOS 202 203# 204# Optional devices: 205# 206 207# PS/2 mouse 208device psm 209hint.psm.0.at="atkbdc" 210hint.psm.0.irq="12" 211 212# Options for psm: 213options PSM_HOOKRESUME #hook the system resume event, useful 214 #for some laptops 215options PSM_RESETAFTERSUSPEND #reset the device at the resume event 216 217# The keyboard controller; it controls the keyboard and the PS/2 mouse. 218device atkbdc 219hint.atkbdc.0.at="isa" 220hint.atkbdc.0.port="0x060" 221 222# The AT keyboard 223device atkbd 224hint.atkbd.0.at="atkbdc" 225hint.atkbd.0.irq="1" 226 227# Options for atkbd: 228options ATKBD_DFLT_KEYMAP # specify the built-in keymap 229makeoptions ATKBD_DFLT_KEYMAP=fr.dvorak 230 231# `flags' for atkbd: 232# 0x01 Force detection of keyboard, else we always assume a keyboard 233# 0x02 Don't reset keyboard, useful for some newer ThinkPads 234# 0x03 Force detection and avoid reset, might help with certain 235# dockingstations 236# 0x04 Old-style (XT) keyboard support, useful for older ThinkPads 237 238# Video card driver for VGA adapters. 239device vga 240hint.vga.0.at="isa" 241 242# Options for vga: 243# Try the following option if the mouse pointer is not drawn correctly 244# or font does not seem to be loaded properly. May cause flicker on 245# some systems. 246options VGA_ALT_SEQACCESS 247 248# If you can dispense with some vga driver features, you may want to 249# use the following options to save some memory. 250#options VGA_NO_FONT_LOADING # don't save/load font 251#options VGA_NO_MODE_CHANGE # don't change video modes 252 253# Older video cards may require this option for proper operation. 254options VGA_SLOW_IOACCESS # do byte-wide i/o's to TS and GDC regs 255 256# The following option probably won't work with the LCD displays. 257options VGA_WIDTH90 # support 90 column modes 258 259# Debugging. 260options VGA_DEBUG 261 262# vt(4) drivers. 263device vt_vga # VGA 264device vt_efifb # EFI framebuffer 265 266# Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA. 267device s3pci 268 269# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support. This will create 270# the /dev/3dfx0 device to work with glide implementations. This should get 271# linked to /dev/3dfx and /dev/voodoo. Note that this is not the same as 272# the tdfx DRI module from XFree86 and is completely unrelated. 273# 274# To enable Linuxulator support, one must also include COMPAT_LINUX in the 275# config as well. The other option is to load both as modules. 276 277device tdfx # Enable 3Dfx Voodoo support 278#XXX#device tdfx_linux # Enable Linuxulator support 279 280# 281# ACPI support using the Intel ACPI Component Architecture reference 282# implementation. 283# 284# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer 285# kernel environment variables to select initial debugging levels for the 286# Intel ACPICA code. (Note that the Intel code must also have USE_DEBUGGER 287# defined when it is built). 288 289device acpi 290options ACPI_DEBUG 291 292# The cpufreq(4) driver provides support for non-ACPI CPU frequency control 293device cpufreq 294 295# Direct Rendering modules for 3D acceleration. 296device drm # DRM core module required by DRM drivers 297device i915drm # Intel i830 through i915 298device mach64drm # ATI Rage Pro, Rage Mobility P/M, Rage XL 299device mgadrm # AGP Matrox G200, G400, G450, G550 300device r128drm # ATI Rage 128 301device radeondrm # ATI Radeon 302device savagedrm # S3 Savage3D, Savage4 303device sisdrm # SiS 300/305, 540, 630 304device tdfxdrm # 3dfx Voodoo 3/4/5 and Banshee 305device viadrm # VIA 306options DRM_DEBUG # Include debug printfs (slow) 307 308# 309# Network interfaces: 310# 311 312# bxe: Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet 313# adapters. 314# ed: Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503 315# HP PC Lan+, various PC Card devices 316# (requires miibus) 317# ipw: Intel PRO/Wireless 2100 IEEE 802.11 adapter 318# Requires the ipw firmware module 319# iwi: Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters 320# Requires the iwi firmware module 321# iwn: Intel Wireless WiFi Link 1000/105/135/2000/4965/5000/6000/6050 abgn 322# 802.11 network adapters 323# Requires the iwn firmware module 324# ixl: Intel XL710 40Gbe PCIE Ethernet 325# ixlv: Intel XL710 40Gbe VF PCIE Ethernet 326# mthca: Mellanox HCA InfiniBand 327# mlx4ib: Mellanox ConnectX HCA InfiniBand 328# mlx4en: Mellanox ConnectX HCA Ethernet 329# nfe: nVidia nForce MCP on-board Ethernet Networking (BSD open source) 330# sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters 331# vmx: VMware VMXNET3 Ethernet (BSD open source) 332# wpi: Intel 3945ABG Wireless LAN controller 333# Requires the wpi firmware module 334 335device bxe # Broadcom NetXtreme II BCM5771X/BCM578XX 10GbE 336device ed # NE[12]000, SMC Ultra, 3c503, DS8390 cards 337options ED_3C503 338options ED_HPP 339options ED_SIC 340device ipw # Intel 2100 wireless NICs. 341device iwi # Intel 2200BG/2225BG/2915ABG wireless NICs. 342device iwn # Intel 4965/1000/5000/6000 wireless NICs. 343device ixl # Intel XL710 40Gbe PCIE Ethernet 344options IXL_IW # Enable iWARP Client Interface in ixl(4) 345device ixlv # Intel XL710 40Gbe VF PCIE Ethernet 346device mthca # Mellanox HCA InfiniBand 347device mlx4 # Shared code module between IB and Ethernet 348device mlx4ib # Mellanox ConnectX HCA InfiniBand 349device mlx4en # Mellanox ConnectX HCA Ethernet 350device nfe # nVidia nForce MCP on-board Ethernet 351device sfxge # Solarflare SFC9000 10Gb Ethernet 352device vmx # VMware VMXNET3 Ethernet 353device wpi # Intel 3945ABG wireless NICs. 354 355# IEEE 802.11 adapter firmware modules 356 357# Intel PRO/Wireless 2100 firmware: 358# ipwfw: BSS/IBSS/monitor mode firmware 359# ipwbssfw: BSS mode firmware 360# ipwibssfw: IBSS mode firmware 361# ipwmonitorfw: Monitor mode firmware 362# Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware: 363# iwifw: BSS/IBSS/monitor mode firmware 364# iwibssfw: BSS mode firmware 365# iwiibssfw: IBSS mode firmware 366# iwimonitorfw: Monitor mode firmware 367# Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware: 368# iwnfw: Single module to support all devices 369# iwn1000fw: Specific module for the 1000 only 370# iwn105fw: Specific module for the 105 only 371# iwn135fw: Specific module for the 135 only 372# iwn2000fw: Specific module for the 2000 only 373# iwn2030fw: Specific module for the 2030 only 374# iwn4965fw: Specific module for the 4965 only 375# iwn5000fw: Specific module for the 5000 only 376# iwn5150fw: Specific module for the 5150 only 377# iwn6000fw: Specific module for the 6000 only 378# iwn6000g2afw: Specific module for the 6000g2a only 379# iwn6000g2bfw: Specific module for the 6000g2b only 380# iwn6050fw: Specific module for the 6050 only 381# wpifw: Intel 3945ABG Wireless LAN Controller firmware 382 383device iwifw 384device iwibssfw 385device iwiibssfw 386device iwimonitorfw 387device ipwfw 388device ipwbssfw 389device ipwibssfw 390device ipwmonitorfw 391device iwnfw 392device iwn1000fw 393device iwn105fw 394device iwn135fw 395device iwn2000fw 396device iwn2030fw 397device iwn4965fw 398device iwn5000fw 399device iwn5150fw 400device iwn6000fw 401device iwn6000g2afw 402device iwn6000g2bfw 403device iwn6050fw 404device wpifw 405 406# 407# Non-Transparent Bridge (NTB) drivers 408# 409device if_ntb # Virtual NTB network interface 410device ntb_transport # NTB packet transport driver 411device ntb # NTB hardware interface 412device ntb_hw_intel # Intel NTB hardware driver 413device ntb_hw_plx # PLX NTB hardware driver 414 415# 416#XXX this stores pointers in a 32bit field that is defined by the hardware 417#device pst 418 419# 420# Areca 11xx and 12xx series of SATA II RAID controllers. 421# CAM is required. 422# 423device arcmsr # Areca SATA II RAID 424 425# 426# 3ware 9000 series PATA/SATA RAID controller driver and options. 427# The driver is implemented as a SIM, and so, needs the CAM infrastructure. 428# 429options TWA_DEBUG # 0-10; 10 prints the most messages. 430options TWA_FLASH_FIRMWARE # firmware image bundled when defined. 431device twa # 3ware 9000 series PATA/SATA RAID 432 433# 434# SCSI host adapters: 435# 436# ncv: NCR 53C500 based SCSI host adapters. 437# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters. 438# stg: TMC 18C30, 18C50 based SCSI host adapters. 439 440device ncv 441device nsp 442device stg 443 444# 445# Adaptec FSA RAID controllers, including integrated DELL controllers, 446# the Dell PERC 2/QC and the HP NetRAID-4M 447device aac 448device aacp # SCSI Passthrough interface (optional, CAM required) 449 450# 451# Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming families 452device aacraid # Container interface, CAM required 453 454# 455# Highpoint RocketRAID 27xx. 456device hpt27xx 457 458# 459# Highpoint RocketRAID 182x. 460device hptmv 461 462# 463# Highpoint DC7280 and R750. 464device hptnr 465 466# 467# Highpoint RocketRAID. Supports RR172x, RR222x, RR2240, RR232x, RR2340, 468# RR2210, RR174x, RR2522, RR231x, RR230x. 469device hptrr 470 471# 472# Highpoint RocketRaid 3xxx series SATA RAID 473device hptiop 474 475# 476# IBM (now Adaptec) ServeRAID controllers 477device ips 478 479# 480# Intel integrated Memory Controller (iMC) SMBus controller 481# Sandybridge-Xeon, Ivybridge-Xeon, Haswell-Xeon, Broadwell-Xeon 482device imcsmb 483 484# 485# Intel C600 (Patsburg) integrated SAS controller 486device isci 487options ISCI_LOGGING # enable debugging in isci HAL 488 489# 490# NVM Express (NVMe) support 491device nvme # base NVMe driver 492device nvd # expose NVMe namespaces as disks, depends on nvme 493 494# 495# PMC-Sierra SAS/SATA controller 496device pmspcv 497 498# 499# SafeNet crypto driver: can be moved to the MI NOTES as soon as 500# it's tested on a big-endian machine 501# 502device safe # SafeNet 1141 503options SAFE_DEBUG # enable debugging support: hw.safe.debug 504options SAFE_RNDTEST # enable rndtest support 505 506# 507# VirtIO support 508# 509# The virtio entry provides a generic bus for use by the device drivers. 510# It must be combined with an interface that communicates with the host. 511# Multiple such interfaces are defined by the VirtIO specification. FreeBSD 512# only has support for PCI. Therefore, virtio_pci must be statically 513# compiled in or loaded as a module for the device drivers to function. 514# 515device virtio # Generic VirtIO bus (required) 516device virtio_pci # VirtIO PCI Interface 517device vtnet # VirtIO Ethernet device 518device virtio_blk # VirtIO Block device 519device virtio_scsi # VirtIO SCSI device 520device virtio_balloon # VirtIO Memory Balloon device 521device virtio_random # VirtIO Entropy device 522device virtio_console # VirtIO Console device 523 524# Microsoft Hyper-V enhancement support 525device hyperv # HyperV drivers 526 527# Xen HVM Guest Optimizations 528options XENHVM # Xen HVM kernel infrastructure 529device xenpci # Xen HVM Hypervisor services driver 530 531##################################################################### 532 533# 534# Miscellaneous hardware: 535# 536# ipmi: Intelligent Platform Management Interface 537# pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724) 538# smbios: DMI/SMBIOS entry point 539# vpd: Vital Product Data kernel interface 540# asmc: Apple System Management Controller 541# si: Specialix International SI/XIO or SX intelligent serial card 542# tpm: Trusted Platform Module 543 544# Notes on the Specialix SI/XIO driver: 545# The host card is memory, not IO mapped. 546# The Rev 1 host cards use a 64K chunk, on a 32K boundary. 547# The Rev 2 host cards use a 32K chunk, on a 32K boundary. 548# The cards can use an IRQ of 11, 12 or 15. 549 550device ipmi 551device pbio 552hint.pbio.0.at="isa" 553hint.pbio.0.port="0x360" 554device smbios 555device vpd 556device asmc 557device si 558device tpm 559device padlock_rng # VIA Padlock RNG 560device rdrand_rng # Intel Bull Mountain RNG 561device aesni # AES-NI OpenCrypto module 562device ioat # Intel I/OAT DMA engine 563 564# 565# Laptop/Notebook options: 566# 567 568 569# 570# I2C Bus 571# 572 573# 574# Hardware watchdog timers: 575# 576# ichwd: Intel ICH watchdog timer 577# amdsbwd: AMD SB7xx watchdog timer 578# viawd: VIA south bridge watchdog timer 579# wbwd: Winbond watchdog timer 580# 581device ichwd 582device amdsbwd 583device viawd 584device wbwd 585 586# 587# Temperature sensors: 588# 589# coretemp: on-die sensor on Intel Core and newer CPUs 590# amdtemp: on-die sensor on AMD K8/K10/K11 CPUs 591# 592device coretemp 593device amdtemp 594 595# 596# CPU control pseudo-device. Provides access to MSRs, CPUID info and 597# microcode update feature. 598# 599device cpuctl 600 601# 602# System Management Bus (SMB) 603# 604options ENABLE_ALART # Control alarm on Intel intpm driver 605 606# 607# AMD System Management Network (SMN) 608# 609device amdsmn 610 611# 612# Number of initial kernel page table pages used for early bootstrap. 613# This number should include enough pages to map the kernel and any 614# modules or other data loaded with the kernel by the loader. Each 615# page table page maps 2MB. 616# 617options NKPT=31 618 619# EFI Runtime Services support (not functional yet). 620options EFIRT 621 622 623##################################################################### 624# ABI Emulation 625 626#XXX keep these here for now and reactivate when support for emulating 627#XXX these 32 bit binaries is added. 628 629# Enable 32-bit runtime support for FreeBSD/i386 binaries. 630options COMPAT_FREEBSD32 631 632# Enable iBCS2 runtime support for SCO and ISC binaries 633#XXX#options IBCS2 634 635# Emulate spx device for client side of SVR3 local X interface 636#XXX#options SPX_HACK 637 638# Enable 32-bit runtime support for CloudABI binaries. 639options COMPAT_CLOUDABI32 640 641# Enable 64-bit runtime support for CloudABI binaries. 642options COMPAT_CLOUDABI64 643 644# Enable Linux ABI emulation 645#XXX#options COMPAT_LINUX 646 647# Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_FREEBSD32) 648options COMPAT_LINUX32 649 650# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32 651# and PSEUDOFS) 652options LINPROCFS 653 654#Enable the linux-like sys filesystem support (requires COMPAT_LINUX32 655# and PSEUDOFS) 656options LINSYSFS 657 658# 659# SysVR4 ABI emulation 660# 661# The svr4 ABI emulator can be statically compiled into the kernel or loaded as 662# a KLD module. 663# The STREAMS network emulation code can also be compiled statically or as a 664# module. If loaded as a module, it must be loaded before the svr4 module 665# (the /usr/sbin/svr4 script does this for you). If compiling statically, 666# the `streams' device must be configured into any kernel which also 667# specifies COMPAT_SVR4. It is possible to have a statically-configured 668# STREAMS device and a dynamically loadable svr4 emulator; the /usr/sbin/svr4 669# script understands that it doesn't need to load the `streams' module under 670# those circumstances. 671# Caveat: At this time, `options KTRACE' is required for the svr4 emulator 672# (whether static or dynamic). 673# 674#XXX#options COMPAT_SVR4 # build emulator statically 675#XXX#options DEBUG_SVR4 # enable verbose debugging 676#XXX#device streams # STREAMS network driver (required for svr4). 677 678 679##################################################################### 680# VM OPTIONS 681 682# KSTACK_PAGES is the number of memory pages to assign to the kernel 683# stack of each thread. 684 685options KSTACK_PAGES=5 686 687# Enable detailed accounting by the PV entry allocator. 688 689options PV_STATS 690 691##################################################################### 692 693# More undocumented options for linting. 694# Note that documenting these are not considered an affront. 695 696options FB_INSTALL_CDEV # install a CDEV entry in /dev 697 698options KBDIO_DEBUG=2 699options KBD_MAXRETRY=4 700options KBD_MAXWAIT=6 701options KBD_RESETDELAY=201 702 703options PSM_DEBUG=1 704 705options TIMER_FREQ=((14318182+6)/12) 706 707options VM_KMEM_SIZE 708options VM_KMEM_SIZE_MAX 709options VM_KMEM_SIZE_SCALE 710 711# Enable NDIS binary driver support 712options NDISAPI 713device ndis 714