2 # NOTES -- Lines that can be cut/pasted into kernel and hints configs.
4 # This file contains machine dependent kernel configuration notes. For
5 # machine independent notes, look in /sys/conf/NOTES.
11 # Enable the kernel DTrace hooks which are required to load the DTrace
17 # NOTE: introduces CDDL-licensed components into the kernel
21 #device dtrace_profile
24 #device dtrace_systrace
25 #device dtrace_prototype
29 # Alternatively include all the DTrace modules
33 #####################################################################
38 # IPI_PREEMPTION instructs the kernel to preempt threads running on other
39 # CPUS if needed. Relies on the PREEMPTION option
42 options IPI_PREEMPTION
43 device atpic # Optional legacy pic support
44 device mptable # Optional MPSPEC mptable support
53 options COUNT_XINVLTLB_HITS # Counters for TLB events
54 options COUNT_IPIS # Per-CPU IPI interrupt counters
58 #####################################################################
62 # You must specify at least one CPU (the one you intend to run on);
63 # deleting the specification for CPUs you don't need to use may make
64 # parts of the system run faster.
66 cpu HAMMER # aka K8, aka Opteron & Athlon64
69 # Options for CPU features.
73 #####################################################################
77 # DEVICE_POLLING adds support for mixed interrupt-polling handling
78 # of network device drivers, which has significant benefits in terms
79 # of robustness to overloads and responsivity, as well as permitting
80 # accurate scheduling of the CPU time between kernel network processing
81 # and other activities. The drawback is a moderate (up to 1/HZ seconds)
82 # potential increase in response times.
83 # It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING
84 # to achieve smoother behaviour.
85 # Additionally, you can enable/disable polling at runtime with help of
86 # the ifconfig(8) utility, and select the CPU fraction reserved to
87 # userland with the sysctl variable kern.polling.user_frac
88 # (default 50, range 0..100).
90 # Not all device drivers support this mode of operation at the time of
91 # this writing. See polling(4) for more details.
93 options DEVICE_POLLING
95 # BPF_JITTER adds support for BPF just-in-time compiler.
99 # OpenFabrics Enterprise Distribution (Infiniband).
101 options OFED_DEBUG_INIT
103 # Sockets Direct Protocol
113 #####################################################################
116 # Provide read/write access to the memory in the clock chip.
117 device nvram # Access to rtc cmos via /dev/nvram
120 #####################################################################
121 # MISCELLANEOUS DEVICES AND OPTIONS
123 device speaker #Play IBM BASIC-style noises out your speaker
124 envvar hint.speaker.0.at="isa"
125 envvar hint.speaker.0.port="0x61"
128 #####################################################################
129 # HARDWARE BUS CONFIGURATION
139 # AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
140 # interrupt controller. This saves about 0.7-1.25 usec for each interrupt.
141 # This option breaks suspend/resume on some portables.
143 # AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
144 # interrupt controller. This saves about 0.7-1.25 usec for each interrupt.
145 # Automatic EOI is documented not to work for for the slave with the
146 # original i8259A, but it works for some clones and some integrated
149 # MAXMEM specifies the amount of RAM on the machine; if this is not
150 # specified, FreeBSD will first read the amount of memory from the CMOS
151 # RAM, so the amount of memory will initially be limited to 64MB or 16MB
152 # depending on the BIOS. If the BIOS reports 64MB, a memory probe will
153 # then attempt to detect the installed amount of RAM. If this probe
154 # fails to detect >64MB RAM you will have to use the MAXMEM option.
155 # The amount is in kilobytes, so for a machine with 128MB of RAM, it would
156 # be 131072 (128 * 1024).
158 # BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
159 # reset the CPU for reboot. This is needed on some systems with broken
160 # keyboard controllers.
165 options MAXMEM=(128*1024)
166 #options BROKEN_KEYBOARD_RESET
178 #####################################################################
179 # HARDWARE DEVICE CONFIGURATION
181 # To include support for VGA VESA video modes
184 # Turn on extra debugging checks and output for VESA support.
187 device dpms # DPMS suspend & resume via VESA BIOS
189 # x86 real mode BIOS emulator, required by atkbdc/dpms/vesa
198 envvar hint.psm.0.at="atkbdc"
199 envvar hint.psm.0.irq="12"
202 options PSM_HOOKRESUME #hook the system resume event, useful
204 options PSM_RESETAFTERSUSPEND #reset the device at the resume event
206 # The keyboard controller; it controls the keyboard and the PS/2 mouse.
208 envvar hint.atkbdc.0.at="isa"
209 envvar hint.atkbdc.0.port="0x060"
213 envvar hint.atkbd.0.at="atkbdc"
214 envvar hint.atkbd.0.irq="1"
217 options ATKBD_DFLT_KEYMAP # specify the built-in keymap
218 makeoptions ATKBD_DFLT_KEYMAP=fr.dvorak
221 # 0x01 Force detection of keyboard, else we always assume a keyboard
222 # 0x02 Don't reset keyboard, useful for some newer ThinkPads
223 # 0x03 Force detection and avoid reset, might help with certain
225 # 0x04 Old-style (XT) keyboard support, useful for older ThinkPads
227 # Video card driver for VGA adapters.
229 envvar hint.vga.0.at="isa"
232 # Try the following option if the mouse pointer is not drawn correctly
233 # or font does not seem to be loaded properly. May cause flicker on
235 options VGA_ALT_SEQACCESS
237 # If you can dispense with some vga driver features, you may want to
238 # use the following options to save some memory.
239 #options VGA_NO_FONT_LOADING # don't save/load font
240 #options VGA_NO_MODE_CHANGE # don't change video modes
242 # Older video cards may require this option for proper operation.
243 options VGA_SLOW_IOACCESS # do byte-wide i/o's to TS and GDC regs
245 # The following option probably won't work with the LCD displays.
246 options VGA_WIDTH90 # support 90 column modes
253 device vt_efifb # EFI framebuffer
254 device vt_vbefb # VBE framebuffer
256 # Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA.
259 # 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support. This will create
260 # the /dev/3dfx0 device to work with glide implementations. This should get
261 # linked to /dev/3dfx and /dev/voodoo. Note that this is not the same as
262 # the tdfx DRI module from XFree86 and is completely unrelated.
265 device tdfx # Enable 3Dfx Voodoo support
268 # ACPI support using the Intel ACPI Component Architecture reference
271 # ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
272 # kernel environment variables to select initial debugging levels for the
273 # Intel ACPICA code. (Note that the Intel code must also have USE_DEBUGGER
274 # defined when it is built).
279 # The cpufreq(4) driver provides support for non-ACPI CPU frequency control
283 # Network interfaces:
286 # bxe: Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
288 # ice: Intel 800 Series Physical Function
289 # Requires the ice_ddp module for full functionality
290 # igc: Intel I225 2.5Gb Ethernet adapter
291 # ipw: Intel PRO/Wireless 2100 IEEE 802.11 adapter
292 # Requires the ipw firmware module
293 # iwi: Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
294 # Requires the iwi firmware module
295 # iwn: Intel Wireless WiFi Link 1000/105/135/2000/4965/5000/6000/6050 abgn
296 # 802.11 network adapters
297 # Requires the iwn firmware module
298 # mthca: Mellanox HCA InfiniBand
299 # mlx4ib: Mellanox ConnectX HCA InfiniBand
300 # mlx4en: Mellanox ConnectX HCA Ethernet
301 # nfe: nVidia nForce MCP on-board Ethernet Networking (BSD open source)
302 # sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters
303 # vmx: VMware VMXNET3 Ethernet (BSD open source)
304 # wpi: Intel 3945ABG Wireless LAN controller
305 # Requires the wpi firmware module
306 # axp: AMD EPYC integrated NIC
307 # Requires the miibus module
309 device bxe # Broadcom NetXtreme II BCM5771X/BCM578XX 10GbE
313 device igc # Intel I225 2.5G Ethernet
314 device ipw # Intel 2100 wireless NICs.
315 device iwi # Intel 2200BG/2225BG/2915ABG wireless NICs.
316 device iwn # Intel 4965/1000/5000/6000 wireless NICs.
317 device ixl # Intel 700 Series Physical Function
318 device iavf # Intel Adaptive Virtual Function
319 device ice # Intel 800 Series Physical Function
320 device ice_ddp # Intel 800 Series DDP Package
321 device mthca # Mellanox HCA InfiniBand
322 device mlx4 # Shared code module between IB and Ethernet
323 device mlx4ib # Mellanox ConnectX HCA InfiniBand
324 device mlx4en # Mellanox ConnectX HCA Ethernet
325 device nfe # nVidia nForce MCP on-board Ethernet
326 device sfxge # Solarflare SFC9000 10Gb Ethernet
327 device vmx # VMware VMXNET3 Ethernet
328 device wpi # Intel 3945ABG wireless NICs.
329 device axp # AMD EPYC integrated NIC
331 # IEEE 802.11 adapter firmware modules
333 # Intel PRO/Wireless 2100 firmware:
334 # ipwfw: BSS/IBSS/monitor mode firmware
335 # ipwbssfw: BSS mode firmware
336 # ipwibssfw: IBSS mode firmware
337 # ipwmonitorfw: Monitor mode firmware
338 # Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware:
339 # iwifw: BSS/IBSS/monitor mode firmware
340 # iwibssfw: BSS mode firmware
341 # iwiibssfw: IBSS mode firmware
342 # iwimonitorfw: Monitor mode firmware
343 # Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware:
344 # iwnfw: Single module to support all devices
345 # iwn1000fw: Specific module for the 1000 only
346 # iwn105fw: Specific module for the 105 only
347 # iwn135fw: Specific module for the 135 only
348 # iwn2000fw: Specific module for the 2000 only
349 # iwn2030fw: Specific module for the 2030 only
350 # iwn4965fw: Specific module for the 4965 only
351 # iwn5000fw: Specific module for the 5000 only
352 # iwn5150fw: Specific module for the 5150 only
353 # iwn6000fw: Specific module for the 6000 only
354 # iwn6000g2afw: Specific module for the 6000g2a only
355 # iwn6000g2bfw: Specific module for the 6000g2b only
356 # iwn6050fw: Specific module for the 6050 only
357 # wpifw: Intel 3945ABG Wireless LAN Controller firmware
383 # Non-Transparent Bridge (NTB) drivers
385 device if_ntb # Virtual NTB network interface
386 device ntb_transport # NTB packet transport driver
387 device ntb # NTB hardware interface
388 device ntb_hw_amd # AMD NTB hardware driver
389 device ntb_hw_intel # Intel NTB hardware driver
390 device ntb_hw_plx # PLX NTB hardware driver
393 #XXX this stores pointers in a 32bit field that is defined by the hardware
397 # Areca 11xx and 12xx series of SATA II RAID controllers.
400 device arcmsr # Areca SATA II RAID
403 # Microsemi smartpqi controllers.
404 # These controllers have a SCSI-like interface, and require the
405 # CAM infrastructure.
410 # 3ware 9000 series PATA/SATA RAID controller driver and options.
411 # The driver is implemented as a SIM, and so, needs the CAM infrastructure.
413 options TWA_DEBUG # 0-10; 10 prints the most messages.
414 device twa # 3ware 9000 series PATA/SATA RAID
417 # Adaptec FSA RAID controllers, including integrated DELL controllers,
418 # the Dell PERC 2/QC and the HP NetRAID-4M
420 device aacp # SCSI Passthrough interface (optional, CAM required)
423 # Highpoint RocketRAID 27xx.
427 # Highpoint RocketRAID 182x.
431 # Highpoint DC7280 and R750.
435 # Highpoint RocketRAID. Supports RR172x, RR222x, RR2240, RR232x, RR2340,
436 # RR2210, RR174x, RR2522, RR231x, RR230x.
440 # Highpoint RocketRaid 3xxx series SATA RAID
444 # IBM (now Adaptec) ServeRAID controllers
448 # Intel integrated Memory Controller (iMC) SMBus controller
449 # Sandybridge-Xeon, Ivybridge-Xeon, Haswell-Xeon, Broadwell-Xeon
453 # Intel C600 (Patsburg) integrated SAS controller
455 options ISCI_LOGGING # enable debugging in isci HAL
458 # NVM Express (NVMe) support
459 device nvme # base NVMe driver
460 device nvd # expose NVMe namespaces as disks, depends on nvme
463 # Intel Volume Management Device (VMD) support
464 device vmd # base VMD device
465 device vmd_bus # bus for VMD children
468 # PMC-Sierra SAS/SATA controller
476 # SafeNet crypto driver: can be moved to the MI NOTES as soon as
477 # it's tested on a big-endian machine
479 device safe # SafeNet 1141
480 options SAFE_DEBUG # enable debugging support: hw.safe.debug
481 options SAFE_RNDTEST # enable rndtest support
486 # The virtio entry provides a generic bus for use by the device drivers.
487 # It must be combined with an interface that communicates with the host.
488 # Multiple such interfaces are defined by the VirtIO specification. FreeBSD
489 # only has support for PCI. Therefore, virtio_pci must be statically
490 # compiled in or loaded as a module for the device drivers to function.
492 device virtio # Generic VirtIO bus (required)
493 device virtio_pci # VirtIO PCI Interface
494 device vtnet # VirtIO Ethernet device
495 device virtio_blk # VirtIO Block device
496 device virtio_scsi # VirtIO SCSI device
497 device virtio_balloon # VirtIO Memory Balloon device
498 device virtio_random # VirtIO Entropy device
499 device virtio_console # VirtIO Console device
501 # Linux KVM paravirtualization support
502 device kvm_clock # KVM paravirtual clock driver
504 # Microsoft Hyper-V enhancement support
505 device hyperv # HyperV drivers
507 # Xen HVM Guest Optimizations
508 options XENHVM # Xen HVM kernel infrastructure
509 device xenpci # Xen HVM Hypervisor services driver
510 device xentimer # Xen x86 PV timer device
512 #####################################################################
515 # Miscellaneous hardware:
517 # ipmi: Intelligent Platform Management Interface
518 # pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
519 # smbios: DMI/SMBIOS entry point (requires EFIRT option)
520 # vpd: Vital Product Data kernel interface
521 # asmc: Apple System Management Controller
522 # si: Specialix International SI/XIO or SX intelligent serial card
523 # tpm: Trusted Platform Module
525 # Notes on the Specialix SI/XIO driver:
526 # The host card is memory, not IO mapped.
527 # The Rev 1 host cards use a 64K chunk, on a 32K boundary.
528 # The Rev 2 host cards use a 32K chunk, on a 32K boundary.
529 # The cards can use an IRQ of 11, 12 or 15.
533 envvar hint.pbio.0.at="isa"
534 envvar hint.pbio.0.port="0x360"
539 device padlock_rng # VIA Padlock RNG
540 device rdrand_rng # Intel Bull Mountain RNG
541 device aesni # AES-NI OpenCrypto module
542 device ossl # OpenSSL OpenCrypto module
543 device ioat # Intel I/OAT DMA engine
546 # Laptop/Notebook options:
556 # Hardware watchdog timers:
558 # ichwd: Intel ICH watchdog timer
559 # amdsbwd: AMD SB7xx watchdog timer
560 # viawd: VIA south bridge watchdog timer
561 # wbwd: Winbond watchdog timer
562 # itwd: ITE Super I/O watchdog timer
571 # Temperature sensors:
573 # coretemp: on-die sensor on Intel Core and newer CPUs
574 # amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
580 # CPU control pseudo-device. Provides access to MSRs, CPUID info and
581 # microcode update feature.
591 # System Management Bus (SMB)
593 options ENABLE_ALART # Control alarm on Intel intpm driver
596 # AMD System Management Network (SMN)
601 # Number of initial kernel page table pages used for early bootstrap.
602 # This number should include enough pages to map the kernel and any
603 # modules or other data loaded with the kernel by the loader. Each
604 # page table page maps 2MB.
608 # EFI Runtime Services support
612 # HID-over-I2C support
614 device iichid # HID-over-I2C support
615 options IICHID_DEBUG # Enable HID-over-I2C debug messages
616 options IICHID_SAMPLING # Workaround missing GPIO INTR support
618 #####################################################################
621 #XXX keep these here for now and reactivate when support for emulating
622 #XXX these 32 bit binaries is added.
624 # Enable 32-bit runtime support for FreeBSD/i386 binaries.
625 options COMPAT_FREEBSD32
627 # Enable (32-bit) a.out binary support
630 # Enable 32-bit runtime support for CloudABI binaries.
631 options COMPAT_CLOUDABI32
633 # Enable 64-bit runtime support for CloudABI binaries.
634 options COMPAT_CLOUDABI64
636 #####################################################################
639 # NB: This depends on crypto, cryptodev and ZSTDIO
642 #####################################################################
645 # KSTACK_PAGES is the number of memory pages to assign to the kernel
646 # stack of each thread.
648 options KSTACK_PAGES=5
650 # Enable detailed accounting by the PV entry allocator.
654 #####################################################################
656 # More undocumented options for linting.
657 # Note that documenting these are not considered an affront.
659 options FB_INSTALL_CDEV # install a CDEV entry in /dev
661 options KBDIO_DEBUG=2
662 options KBD_MAXRETRY=4
663 options KBD_MAXWAIT=6
664 options KBD_RESETDELAY=201
668 options TIMER_FREQ=((14318182+6)/12)
671 options VM_KMEM_SIZE_MAX
672 options VM_KMEM_SIZE_SCALE
674 # GCOV (code coverage) support