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 # We want LINT to cover profiling as well.
15 # Enable the kernel DTrace hooks which are required to load the DTrace
21 # NOTE: introduces CDDL-licensed components into the kernel
25 #device dtrace_profile
28 #device dtrace_systrace
29 #device dtrace_prototype
33 # Alternatively include all the DTrace modules
37 #####################################################################
42 # IPI_PREEMPTION instructs the kernel to preempt threads running on other
43 # CPUS if needed. Relies on the PREEMPTION option
46 options IPI_PREEMPTION
47 device atpic # Optional legacy pic support
48 device mptable # Optional MPSPEC mptable support
57 options COUNT_XINVLTLB_HITS # Counters for TLB events
58 options COUNT_IPIS # Per-CPU IPI interrupt counters
62 #####################################################################
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.
70 cpu HAMMER # aka K8, aka Opteron & Athlon64
73 # Options for CPU features.
77 #####################################################################
81 # DEVICE_POLLING adds support for mixed interrupt-polling handling
82 # of network device drivers, which has significant benefits in terms
83 # of robustness to overloads and responsivity, as well as permitting
84 # accurate scheduling of the CPU time between kernel network processing
85 # and other activities. The drawback is a moderate (up to 1/HZ seconds)
86 # potential increase in response times.
87 # It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING
88 # to achieve smoother behaviour.
89 # Additionally, you can enable/disable polling at runtime with help of
90 # the ifconfig(8) utility, and select the CPU fraction reserved to
91 # userland with the sysctl variable kern.polling.user_frac
92 # (default 50, range 0..100).
94 # Not all device drivers support this mode of operation at the time of
95 # this writing. See polling(4) for more details.
97 options DEVICE_POLLING
99 # BPF_JITTER adds support for BPF just-in-time compiler.
103 # OpenFabrics Enterprise Distribution (Infiniband).
105 options OFED_DEBUG_INIT
107 # Sockets Direct Protocol
117 #####################################################################
120 # Provide read/write access to the memory in the clock chip.
121 device nvram # Access to rtc cmos via /dev/nvram
124 #####################################################################
125 # MISCELLANEOUS DEVICES AND OPTIONS
127 device speaker #Play IBM BASIC-style noises out your speaker
128 envvar hint.speaker.0.at="isa"
129 envvar hint.speaker.0.port="0x61"
132 #####################################################################
133 # HARDWARE BUS CONFIGURATION
143 # AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
144 # interrupt controller. This saves about 0.7-1.25 usec for each interrupt.
145 # This option breaks suspend/resume on some portables.
147 # AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
148 # interrupt controller. This saves about 0.7-1.25 usec for each interrupt.
149 # Automatic EOI is documented not to work for for the slave with the
150 # original i8259A, but it works for some clones and some integrated
153 # MAXMEM specifies the amount of RAM on the machine; if this is not
154 # specified, FreeBSD will first read the amount of memory from the CMOS
155 # RAM, so the amount of memory will initially be limited to 64MB or 16MB
156 # depending on the BIOS. If the BIOS reports 64MB, a memory probe will
157 # then attempt to detect the installed amount of RAM. If this probe
158 # fails to detect >64MB RAM you will have to use the MAXMEM option.
159 # The amount is in kilobytes, so for a machine with 128MB of RAM, it would
160 # be 131072 (128 * 1024).
162 # BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
163 # reset the CPU for reboot. This is needed on some systems with broken
164 # keyboard controllers.
169 options MAXMEM=(128*1024)
170 #options BROKEN_KEYBOARD_RESET
182 #####################################################################
183 # HARDWARE DEVICE CONFIGURATION
185 # To include support for VGA VESA video modes
188 # Turn on extra debugging checks and output for VESA support.
191 device dpms # DPMS suspend & resume via VESA BIOS
193 # x86 real mode BIOS emulator, required by atkbdc/dpms/vesa
202 envvar hint.psm.0.at="atkbdc"
203 envvar hint.psm.0.irq="12"
206 options PSM_HOOKRESUME #hook the system resume event, useful
208 options PSM_RESETAFTERSUSPEND #reset the device at the resume event
210 # The keyboard controller; it controls the keyboard and the PS/2 mouse.
212 envvar hint.atkbdc.0.at="isa"
213 envvar hint.atkbdc.0.port="0x060"
217 envvar hint.atkbd.0.at="atkbdc"
218 envvar hint.atkbd.0.irq="1"
221 options ATKBD_DFLT_KEYMAP # specify the built-in keymap
222 makeoptions ATKBD_DFLT_KEYMAP=fr.dvorak
225 # 0x01 Force detection of keyboard, else we always assume a keyboard
226 # 0x02 Don't reset keyboard, useful for some newer ThinkPads
227 # 0x03 Force detection and avoid reset, might help with certain
229 # 0x04 Old-style (XT) keyboard support, useful for older ThinkPads
231 # Video card driver for VGA adapters.
233 envvar hint.vga.0.at="isa"
236 # Try the following option if the mouse pointer is not drawn correctly
237 # or font does not seem to be loaded properly. May cause flicker on
239 options VGA_ALT_SEQACCESS
241 # If you can dispense with some vga driver features, you may want to
242 # use the following options to save some memory.
243 #options VGA_NO_FONT_LOADING # don't save/load font
244 #options VGA_NO_MODE_CHANGE # don't change video modes
246 # Older video cards may require this option for proper operation.
247 options VGA_SLOW_IOACCESS # do byte-wide i/o's to TS and GDC regs
249 # The following option probably won't work with the LCD displays.
250 options VGA_WIDTH90 # support 90 column modes
257 device vt_efifb # EFI framebuffer
258 device vt_vbefb # VBE framebuffer
260 # Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA.
263 # 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support. This will create
264 # the /dev/3dfx0 device to work with glide implementations. This should get
265 # linked to /dev/3dfx and /dev/voodoo. Note that this is not the same as
266 # the tdfx DRI module from XFree86 and is completely unrelated.
268 # To enable Linuxulator support, one must also include COMPAT_LINUX in the
269 # config as well. The other option is to load both as modules.
271 device tdfx # Enable 3Dfx Voodoo support
272 #XXX#device tdfx_linux # Enable Linuxulator support
275 # ACPI support using the Intel ACPI Component Architecture reference
278 # ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
279 # kernel environment variables to select initial debugging levels for the
280 # Intel ACPICA code. (Note that the Intel code must also have USE_DEBUGGER
281 # defined when it is built).
286 # The cpufreq(4) driver provides support for non-ACPI CPU frequency control
290 # Network interfaces:
293 # bxe: Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
295 # ice: Intel 800 Series Physical Function
296 # Requires the ice_ddp module for full functionality
297 # ipw: Intel PRO/Wireless 2100 IEEE 802.11 adapter
298 # Requires the ipw firmware module
299 # iwi: Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
300 # Requires the iwi firmware module
301 # iwn: Intel Wireless WiFi Link 1000/105/135/2000/4965/5000/6000/6050 abgn
302 # 802.11 network adapters
303 # Requires the iwn firmware module
304 # mthca: Mellanox HCA InfiniBand
305 # mlx4ib: Mellanox ConnectX HCA InfiniBand
306 # mlx4en: Mellanox ConnectX HCA Ethernet
307 # nfe: nVidia nForce MCP on-board Ethernet Networking (BSD open source)
308 # sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters
309 # vmx: VMware VMXNET3 Ethernet (BSD open source)
310 # wpi: Intel 3945ABG Wireless LAN controller
311 # Requires the wpi firmware module
313 device bxe # Broadcom NetXtreme II BCM5771X/BCM578XX 10GbE
317 device ipw # Intel 2100 wireless NICs.
318 device iwi # Intel 2200BG/2225BG/2915ABG wireless NICs.
319 device iwn # Intel 4965/1000/5000/6000 wireless NICs.
320 device ixl # Intel 700 Series Physical Function
321 device iavf # Intel Adaptive Virtual Function
322 device ice # Intel 800 Series Physical Function
323 device ice_ddp # Intel 800 Series DDP Package
324 device mthca # Mellanox HCA InfiniBand
325 device mlx4 # Shared code module between IB and Ethernet
326 device mlx4ib # Mellanox ConnectX HCA InfiniBand
327 device mlx4en # Mellanox ConnectX HCA Ethernet
328 device nfe # nVidia nForce MCP on-board Ethernet
329 device sfxge # Solarflare SFC9000 10Gb Ethernet
330 device vmx # VMware VMXNET3 Ethernet
331 device wpi # Intel 3945ABG wireless NICs.
332 device axp # AMD EPYC integrated NIC
334 # IEEE 802.11 adapter firmware modules
336 # Intel PRO/Wireless 2100 firmware:
337 # ipwfw: BSS/IBSS/monitor mode firmware
338 # ipwbssfw: BSS mode firmware
339 # ipwibssfw: IBSS mode firmware
340 # ipwmonitorfw: Monitor mode firmware
341 # Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware:
342 # iwifw: BSS/IBSS/monitor mode firmware
343 # iwibssfw: BSS mode firmware
344 # iwiibssfw: IBSS mode firmware
345 # iwimonitorfw: Monitor mode firmware
346 # Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware:
347 # iwnfw: Single module to support all devices
348 # iwn1000fw: Specific module for the 1000 only
349 # iwn105fw: Specific module for the 105 only
350 # iwn135fw: Specific module for the 135 only
351 # iwn2000fw: Specific module for the 2000 only
352 # iwn2030fw: Specific module for the 2030 only
353 # iwn4965fw: Specific module for the 4965 only
354 # iwn5000fw: Specific module for the 5000 only
355 # iwn5150fw: Specific module for the 5150 only
356 # iwn6000fw: Specific module for the 6000 only
357 # iwn6000g2afw: Specific module for the 6000g2a only
358 # iwn6000g2bfw: Specific module for the 6000g2b only
359 # iwn6050fw: Specific module for the 6050 only
360 # wpifw: Intel 3945ABG Wireless LAN Controller firmware
386 # Non-Transparent Bridge (NTB) drivers
388 device if_ntb # Virtual NTB network interface
389 device ntb_transport # NTB packet transport driver
390 device ntb # NTB hardware interface
391 device ntb_hw_amd # AMD NTB hardware driver
392 device ntb_hw_intel # Intel NTB hardware driver
393 device ntb_hw_plx # PLX NTB hardware driver
396 #XXX this stores pointers in a 32bit field that is defined by the hardware
400 # Areca 11xx and 12xx series of SATA II RAID controllers.
403 device arcmsr # Areca SATA II RAID
406 # Microsemi smartpqi controllers.
407 # These controllers have a SCSI-like interface, and require the
408 # CAM infrastructure.
413 # 3ware 9000 series PATA/SATA RAID controller driver and options.
414 # The driver is implemented as a SIM, and so, needs the CAM infrastructure.
416 options TWA_DEBUG # 0-10; 10 prints the most messages.
417 device twa # 3ware 9000 series PATA/SATA RAID
420 # Adaptec FSA RAID controllers, including integrated DELL controllers,
421 # the Dell PERC 2/QC and the HP NetRAID-4M
423 device aacp # SCSI Passthrough interface (optional, CAM required)
426 # Highpoint RocketRAID 27xx.
430 # Highpoint RocketRAID 182x.
434 # Highpoint DC7280 and R750.
438 # Highpoint RocketRAID. Supports RR172x, RR222x, RR2240, RR232x, RR2340,
439 # RR2210, RR174x, RR2522, RR231x, RR230x.
443 # Highpoint RocketRaid 3xxx series SATA RAID
447 # IBM (now Adaptec) ServeRAID controllers
451 # Intel integrated Memory Controller (iMC) SMBus controller
452 # Sandybridge-Xeon, Ivybridge-Xeon, Haswell-Xeon, Broadwell-Xeon
456 # Intel C600 (Patsburg) integrated SAS controller
458 options ISCI_LOGGING # enable debugging in isci HAL
461 # NVM Express (NVMe) support
462 device nvme # base NVMe driver
463 device nvd # expose NVMe namespaces as disks, depends on nvme
466 # Intel Volume Management Device (VMD) support
467 device vmd # base VMD device
468 device vmd_bus # bus for VMD children
471 # PMC-Sierra SAS/SATA controller
479 # SafeNet crypto driver: can be moved to the MI NOTES as soon as
480 # it's tested on a big-endian machine
482 device safe # SafeNet 1141
483 options SAFE_DEBUG # enable debugging support: hw.safe.debug
484 options SAFE_RNDTEST # enable rndtest support
489 # The virtio entry provides a generic bus for use by the device drivers.
490 # It must be combined with an interface that communicates with the host.
491 # Multiple such interfaces are defined by the VirtIO specification. FreeBSD
492 # only has support for PCI. Therefore, virtio_pci must be statically
493 # compiled in or loaded as a module for the device drivers to function.
495 device virtio # Generic VirtIO bus (required)
496 device virtio_pci # VirtIO PCI Interface
497 device vtnet # VirtIO Ethernet device
498 device virtio_blk # VirtIO Block device
499 device virtio_scsi # VirtIO SCSI device
500 device virtio_balloon # VirtIO Memory Balloon device
501 device virtio_random # VirtIO Entropy device
502 device virtio_console # VirtIO Console device
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
511 #####################################################################
514 # Miscellaneous hardware:
516 # ipmi: Intelligent Platform Management Interface
517 # pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
518 # smbios: DMI/SMBIOS entry point
519 # vpd: Vital Product Data kernel interface
520 # asmc: Apple System Management Controller
521 # si: Specialix International SI/XIO or SX intelligent serial card
522 # tpm: Trusted Platform Module
524 # Notes on the Specialix SI/XIO driver:
525 # The host card is memory, not IO mapped.
526 # The Rev 1 host cards use a 64K chunk, on a 32K boundary.
527 # The Rev 2 host cards use a 32K chunk, on a 32K boundary.
528 # The cards can use an IRQ of 11, 12 or 15.
532 envvar hint.pbio.0.at="isa"
533 envvar hint.pbio.0.port="0x360"
538 device padlock_rng # VIA Padlock RNG
539 device rdrand_rng # Intel Bull Mountain RNG
540 device aesni # AES-NI OpenCrypto module
541 device ossl # OpenSSL OpenCrypto module
542 device ioat # Intel I/OAT DMA engine
545 # Laptop/Notebook options:
555 # Hardware watchdog timers:
557 # ichwd: Intel ICH watchdog timer
558 # amdsbwd: AMD SB7xx watchdog timer
559 # viawd: VIA south bridge watchdog timer
560 # wbwd: Winbond watchdog timer
561 # itwd: ITE Super I/O watchdog timer
570 # Temperature sensors:
572 # coretemp: on-die sensor on Intel Core and newer CPUs
573 # amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
579 # CPU control pseudo-device. Provides access to MSRs, CPUID info and
580 # microcode update feature.
590 # System Management Bus (SMB)
592 options ENABLE_ALART # Control alarm on Intel intpm driver
595 # AMD System Management Network (SMN)
600 # Number of initial kernel page table pages used for early bootstrap.
601 # This number should include enough pages to map the kernel and any
602 # modules or other data loaded with the kernel by the loader. Each
603 # page table page maps 2MB.
607 # EFI Runtime Services support
611 #####################################################################
614 #XXX keep these here for now and reactivate when support for emulating
615 #XXX these 32 bit binaries is added.
617 # Enable 32-bit runtime support for FreeBSD/i386 binaries.
618 options COMPAT_FREEBSD32
620 # Enable (32-bit) a.out binary support
623 # Enable 32-bit runtime support for CloudABI binaries.
624 options COMPAT_CLOUDABI32
626 # Enable 64-bit runtime support for CloudABI binaries.
627 options COMPAT_CLOUDABI64
629 # Enable Linux ABI emulation
630 #XXX#options COMPAT_LINUX
632 # Enable 32-bit Linux ABI emulation (requires COMPAT_FREEBSD32).
633 options COMPAT_LINUX32
635 # Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
639 #Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
643 #####################################################################
646 # NB: This depends on crypto, cryptodev and ZSTDIO
649 #####################################################################
652 # KSTACK_PAGES is the number of memory pages to assign to the kernel
653 # stack of each thread.
655 options KSTACK_PAGES=5
657 # Enable detailed accounting by the PV entry allocator.
661 #####################################################################
663 # More undocumented options for linting.
664 # Note that documenting these are not considered an affront.
666 options FB_INSTALL_CDEV # install a CDEV entry in /dev
668 options KBDIO_DEBUG=2
669 options KBD_MAXRETRY=4
670 options KBD_MAXWAIT=6
671 options KBD_RESETDELAY=201
675 options TIMER_FREQ=((14318182+6)/12)
678 options VM_KMEM_SIZE_MAX
679 options VM_KMEM_SIZE_SCALE
681 # Enable NDIS binary driver support
686 # GCOV (code coverage) support