NOTES revision 318357
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 318357 2017-05-16 17:49:15Z erj $ 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# mlx4ib: Mellanox ConnectX HCA InfiniBand 327# mlxen: Mellanox ConnectX HCA Ethernet 328# mthca: Mellanox HCA InfiniBand 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 mlx4ib # Mellanox ConnectX HCA InfiniBand 347device mlxen # Mellanox ConnectX HCA Ethernet 348device mthca # Mellanox HCA InfiniBand 349device nfe # nVidia nForce MCP on-board Ethernet 350device sfxge # Solarflare SFC9000 10Gb Ethernet 351device vmx # VMware VMXNET3 Ethernet 352device wpi # Intel 3945ABG wireless NICs. 353 354# IEEE 802.11 adapter firmware modules 355 356# Intel PRO/Wireless 2100 firmware: 357# ipwfw: BSS/IBSS/monitor mode firmware 358# ipwbssfw: BSS mode firmware 359# ipwibssfw: IBSS mode firmware 360# ipwmonitorfw: Monitor mode firmware 361# Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware: 362# iwifw: BSS/IBSS/monitor mode firmware 363# iwibssfw: BSS mode firmware 364# iwiibssfw: IBSS mode firmware 365# iwimonitorfw: Monitor mode firmware 366# Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware: 367# iwnfw: Single module to support all devices 368# iwn1000fw: Specific module for the 1000 only 369# iwn105fw: Specific module for the 105 only 370# iwn135fw: Specific module for the 135 only 371# iwn2000fw: Specific module for the 2000 only 372# iwn2030fw: Specific module for the 2030 only 373# iwn4965fw: Specific module for the 4965 only 374# iwn5000fw: Specific module for the 5000 only 375# iwn5150fw: Specific module for the 5150 only 376# iwn6000fw: Specific module for the 6000 only 377# iwn6000g2afw: Specific module for the 6000g2a only 378# iwn6000g2bfw: Specific module for the 6000g2b only 379# iwn6050fw: Specific module for the 6050 only 380# wpifw: Intel 3945ABG Wireless LAN Controller firmware 381 382device iwifw 383device iwibssfw 384device iwiibssfw 385device iwimonitorfw 386device ipwfw 387device ipwbssfw 388device ipwibssfw 389device ipwmonitorfw 390device iwnfw 391device iwn1000fw 392device iwn105fw 393device iwn135fw 394device iwn2000fw 395device iwn2030fw 396device iwn4965fw 397device iwn5000fw 398device iwn5150fw 399device iwn6000fw 400device iwn6000g2afw 401device iwn6000g2bfw 402device iwn6050fw 403device wpifw 404 405# Intel Non-Transparent Bridge (NTB) hardware 406device ntb_hw # Hardware Abstraction Layer for the NTB 407device if_ntb # Simulated ethernet device using the NTB 408 409# 410#XXX this stores pointers in a 32bit field that is defined by the hardware 411#device pst 412 413# 414# Areca 11xx and 12xx series of SATA II RAID controllers. 415# CAM is required. 416# 417device arcmsr # Areca SATA II RAID 418 419# 420# 3ware 9000 series PATA/SATA RAID controller driver and options. 421# The driver is implemented as a SIM, and so, needs the CAM infrastructure. 422# 423options TWA_DEBUG # 0-10; 10 prints the most messages. 424options TWA_FLASH_FIRMWARE # firmware image bundled when defined. 425device twa # 3ware 9000 series PATA/SATA RAID 426 427# 428# SCSI host adapters: 429# 430# ncv: NCR 53C500 based SCSI host adapters. 431# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters. 432# stg: TMC 18C30, 18C50 based SCSI host adapters. 433 434device ncv 435device nsp 436device stg 437 438# 439# Adaptec FSA RAID controllers, including integrated DELL controllers, 440# the Dell PERC 2/QC and the HP NetRAID-4M 441device aac 442device aacp # SCSI Passthrough interface (optional, CAM required) 443 444# 445# Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming families 446device aacraid # Container interface, CAM required 447 448# 449# Highpoint RocketRAID 27xx. 450device hpt27xx 451 452# 453# Highpoint RocketRAID 182x. 454device hptmv 455 456# 457# Highpoint DC7280 and R750. 458device hptnr 459 460# 461# Highpoint RocketRAID. Supports RR172x, RR222x, RR2240, RR232x, RR2340, 462# RR2210, RR174x, RR2522, RR231x, RR230x. 463device hptrr 464 465# 466# Highpoint RocketRaid 3xxx series SATA RAID 467device hptiop 468 469# 470# IBM (now Adaptec) ServeRAID controllers 471device ips 472 473# 474# Intel C600 (Patsburg) integrated SAS controller 475device isci 476options ISCI_LOGGING # enable debugging in isci HAL 477 478# 479# NVM Express (NVMe) support 480device nvme # base NVMe driver 481device nvd # expose NVMe namespaces as disks, depends on nvme 482 483# 484# PMC-Sierra SAS/SATA controller 485device pmspcv 486 487# 488# SafeNet crypto driver: can be moved to the MI NOTES as soon as 489# it's tested on a big-endian machine 490# 491device safe # SafeNet 1141 492options SAFE_DEBUG # enable debugging support: hw.safe.debug 493options SAFE_RNDTEST # enable rndtest support 494 495# 496# VirtIO support 497# 498# The virtio entry provides a generic bus for use by the device drivers. 499# It must be combined with an interface that communicates with the host. 500# Multiple such interfaces are defined by the VirtIO specification. FreeBSD 501# only has support for PCI. Therefore, virtio_pci must be statically 502# compiled in or loaded as a module for the device drivers to function. 503# 504device virtio # Generic VirtIO bus (required) 505device virtio_pci # VirtIO PCI Interface 506device vtnet # VirtIO Ethernet device 507device virtio_blk # VirtIO Block device 508device virtio_scsi # VirtIO SCSI device 509device virtio_balloon # VirtIO Memory Balloon device 510device virtio_random # VirtIO Entropy device 511device virtio_console # VirtIO Console device 512 513# Microsoft Hyper-V enhancement support 514device hyperv # HyperV drivers 515 516# Xen HVM Guest Optimizations 517options XENHVM # Xen HVM kernel infrastructure 518device xenpci # Xen HVM Hypervisor services driver 519 520##################################################################### 521 522# 523# Miscellaneous hardware: 524# 525# ipmi: Intelligent Platform Management Interface 526# pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724) 527# smbios: DMI/SMBIOS entry point 528# vpd: Vital Product Data kernel interface 529# asmc: Apple System Management Controller 530# si: Specialix International SI/XIO or SX intelligent serial card 531# tpm: Trusted Platform Module 532 533# Notes on the Specialix SI/XIO driver: 534# The host card is memory, not IO mapped. 535# The Rev 1 host cards use a 64K chunk, on a 32K boundary. 536# The Rev 2 host cards use a 32K chunk, on a 32K boundary. 537# The cards can use an IRQ of 11, 12 or 15. 538 539device ipmi 540device pbio 541hint.pbio.0.at="isa" 542hint.pbio.0.port="0x360" 543device smbios 544device vpd 545device asmc 546device si 547device tpm 548device padlock_rng # VIA Padlock RNG 549device rdrand_rng # Intel Bull Mountain RNG 550device aesni # AES-NI OpenCrypto module 551device ioat # Intel I/OAT DMA engine 552 553# 554# Laptop/Notebook options: 555# 556 557 558# 559# I2C Bus 560# 561 562# 563# Hardware watchdog timers: 564# 565# ichwd: Intel ICH watchdog timer 566# amdsbwd: AMD SB7xx watchdog timer 567# viawd: VIA south bridge watchdog timer 568# wbwd: Winbond watchdog timer 569# 570device ichwd 571device amdsbwd 572device viawd 573device wbwd 574 575# 576# Temperature sensors: 577# 578# coretemp: on-die sensor on Intel Core and newer CPUs 579# amdtemp: on-die sensor on AMD K8/K10/K11 CPUs 580# 581device coretemp 582device amdtemp 583 584# 585# CPU control pseudo-device. Provides access to MSRs, CPUID info and 586# microcode update feature. 587# 588device cpuctl 589 590# 591# System Management Bus (SMB) 592# 593options ENABLE_ALART # Control alarm on Intel intpm driver 594 595# 596# Number of initial kernel page table pages used for early bootstrap. 597# This number should include enough pages to map the kernel and any 598# modules or other data loaded with the kernel by the loader. Each 599# page table page maps 2MB. 600# 601options NKPT=31 602 603# EFI Runtime Services support (not functional yet). 604options EFIRT 605 606 607##################################################################### 608# ABI Emulation 609 610#XXX keep these here for now and reactivate when support for emulating 611#XXX these 32 bit binaries is added. 612 613# Enable 32-bit runtime support for FreeBSD/i386 binaries. 614options COMPAT_FREEBSD32 615 616# Enable iBCS2 runtime support for SCO and ISC binaries 617#XXX#options IBCS2 618 619# Emulate spx device for client side of SVR3 local X interface 620#XXX#options SPX_HACK 621 622# Enable 32-bit runtime support for CloudABI binaries. 623options COMPAT_CLOUDABI32 624 625# Enable 64-bit runtime support for CloudABI binaries. 626options COMPAT_CLOUDABI64 627 628# Enable Linux ABI emulation 629#XXX#options COMPAT_LINUX 630 631# Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_FREEBSD32) 632options COMPAT_LINUX32 633 634# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32 635# and PSEUDOFS) 636options LINPROCFS 637 638#Enable the linux-like sys filesystem support (requires COMPAT_LINUX32 639# and PSEUDOFS) 640options LINSYSFS 641 642# 643# SysVR4 ABI emulation 644# 645# The svr4 ABI emulator can be statically compiled into the kernel or loaded as 646# a KLD module. 647# The STREAMS network emulation code can also be compiled statically or as a 648# module. If loaded as a module, it must be loaded before the svr4 module 649# (the /usr/sbin/svr4 script does this for you). If compiling statically, 650# the `streams' device must be configured into any kernel which also 651# specifies COMPAT_SVR4. It is possible to have a statically-configured 652# STREAMS device and a dynamically loadable svr4 emulator; the /usr/sbin/svr4 653# script understands that it doesn't need to load the `streams' module under 654# those circumstances. 655# Caveat: At this time, `options KTRACE' is required for the svr4 emulator 656# (whether static or dynamic). 657# 658#XXX#options COMPAT_SVR4 # build emulator statically 659#XXX#options DEBUG_SVR4 # enable verbose debugging 660#XXX#device streams # STREAMS network driver (required for svr4). 661 662 663##################################################################### 664# VM OPTIONS 665 666# KSTACK_PAGES is the number of memory pages to assign to the kernel 667# stack of each thread. 668 669options KSTACK_PAGES=5 670 671# Enable detailed accounting by the PV entry allocator. 672 673options PV_STATS 674 675##################################################################### 676 677# More undocumented options for linting. 678# Note that documenting these are not considered an affront. 679 680options FB_INSTALL_CDEV # install a CDEV entry in /dev 681 682options KBDIO_DEBUG=2 683options KBD_MAXRETRY=4 684options KBD_MAXWAIT=6 685options KBD_RESETDELAY=201 686 687options PSM_DEBUG=1 688 689options TIMER_FREQ=((14318182+6)/12) 690 691options VM_KMEM_SIZE 692options VM_KMEM_SIZE_MAX 693options VM_KMEM_SIZE_SCALE 694 695# Enable NDIS binary driver support 696options NDISAPI 697device ndis 698