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 #####################################################################
26 # IPI_PREEMPTION instructs the kernel to preempt threads running on other
27 # CPUS if needed. Relies on the PREEMPTION option
30 options IPI_PREEMPTION
31 device atpic # Optional legacy pic support
32 device mptable # Optional MPSPEC mptable support
41 options COUNT_XINVLTLB_HITS # Counters for TLB events
42 options COUNT_IPIS # Per-CPU IPI interrupt counters
46 #####################################################################
50 # You must specify at least one CPU (the one you intend to run on);
51 # deleting the specification for CPUs you don't need to use may make
52 # parts of the system run faster.
54 cpu HAMMER # aka K8, aka Opteron & Athlon64
57 # Options for CPU features.
61 # PERFMON causes the driver for Pentium/Pentium Pro performance counters
62 # to be compiled. See perfmon(4) for more information.
67 #####################################################################
71 # DEVICE_POLLING adds support for mixed interrupt-polling handling
72 # of network device drivers, which has significant benefits in terms
73 # of robustness to overloads and responsivity, as well as permitting
74 # accurate scheduling of the CPU time between kernel network processing
75 # and other activities. The drawback is a moderate (up to 1/HZ seconds)
76 # potential increase in response times.
77 # It is strongly recommended to use HZ=1000 or 2000 with DEVICE_POLLING
78 # to achieve smoother behaviour.
79 # Additionally, you can enable/disable polling at runtime with help of
80 # the ifconfig(8) utility, and select the CPU fraction reserved to
81 # userland with the sysctl variable kern.polling.user_frac
82 # (default 50, range 0..100).
84 # Not all device drivers support this mode of operation at the time of
85 # this writing. See polling(4) for more details.
87 options DEVICE_POLLING
89 # BPF_JITTER adds support for BPF just-in-time compiler.
93 # OpenFabrics Enterprise Distribution (Infiniband).
95 options OFED_DEBUG_INIT
97 # Sockets Direct Protocol
107 #####################################################################
110 # Provide read/write access to the memory in the clock chip.
111 device nvram # Access to rtc cmos via /dev/nvram
114 #####################################################################
115 # MISCELLANEOUS DEVICES AND OPTIONS
117 device speaker #Play IBM BASIC-style noises out your speaker
118 hint.speaker.0.at="isa"
119 hint.speaker.0.port="0x61"
120 device gzip #Exec gzipped a.out's. REQUIRES COMPAT_AOUT!
123 #####################################################################
124 # HARDWARE BUS CONFIGURATION
134 # AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
135 # interrupt controller. This saves about 0.7-1.25 usec for each interrupt.
136 # This option breaks suspend/resume on some portables.
138 # AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
139 # interrupt controller. This saves about 0.7-1.25 usec for each interrupt.
140 # Automatic EOI is documented not to work for for the slave with the
141 # original i8259A, but it works for some clones and some integrated
144 # MAXMEM specifies the amount of RAM on the machine; if this is not
145 # specified, FreeBSD will first read the amount of memory from the CMOS
146 # RAM, so the amount of memory will initially be limited to 64MB or 16MB
147 # depending on the BIOS. If the BIOS reports 64MB, a memory probe will
148 # then attempt to detect the installed amount of RAM. If this probe
149 # fails to detect >64MB RAM you will have to use the MAXMEM option.
150 # The amount is in kilobytes, so for a machine with 128MB of RAM, it would
151 # be 131072 (128 * 1024).
153 # BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
154 # reset the CPU for reboot. This is needed on some systems with broken
155 # keyboard controllers.
160 options MAXMEM=(128*1024)
161 #options BROKEN_KEYBOARD_RESET
164 # PCI bus & PCI options:
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 hint.psm.0.at="atkbdc"
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 hint.atkbdc.0.at="isa"
209 hint.atkbdc.0.port="0x060"
213 hint.atkbd.0.at="atkbdc"
217 options ATKBD_DFLT_KEYMAP # specify the built-in keymap
218 makeoptions ATKBD_DFLT_KEYMAP=jp.106
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.
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
251 # Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA.
254 # 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support. This will create
255 # the /dev/3dfx0 device to work with glide implementations. This should get
256 # linked to /dev/3dfx and /dev/voodoo. Note that this is not the same as
257 # the tdfx DRI module from XFree86 and is completely unrelated.
259 # To enable Linuxulator support, one must also include COMPAT_LINUX in the
260 # config as well. The other option is to load both as modules.
262 device tdfx # Enable 3Dfx Voodoo support
263 #XXX#device tdfx_linux # Enable Linuxulator support
266 # ACPI support using the Intel ACPI Component Architecture reference
269 # ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
270 # kernel environment variables to select initial debugging levels for the
271 # Intel ACPICA code. (Note that the Intel code must also have USE_DEBUGGER
272 # defined when it is built).
277 # The cpufreq(4) driver provides support for non-ACPI CPU frequency control
280 # Direct Rendering modules for 3D acceleration.
281 device drm # DRM core module required by DRM drivers
282 device i915drm # Intel i830 through i915
283 device mach64drm # ATI Rage Pro, Rage Mobility P/M, Rage XL
284 device mgadrm # AGP Matrox G200, G400, G450, G550
285 device r128drm # ATI Rage 128
286 device radeondrm # ATI Radeon
287 device savagedrm # S3 Savage3D, Savage4
288 device sisdrm # SiS 300/305, 540, 630
289 device tdfxdrm # 3dfx Voodoo 3/4/5 and Banshee
291 options DRM_DEBUG # Include debug printfs (slow)
294 # Network interfaces:
297 # bxe: Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
299 # ed: Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
300 # HP PC Lan+, various PC Card devices
302 # ipw: Intel PRO/Wireless 2100 IEEE 802.11 adapter
303 # Requires the ipw firmware module
304 # iwi: Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
305 # Requires the iwi firmware module
306 # iwn: Intel Wireless WiFi Link 4965/1000/5000/6000 802.11 network adapters
307 # Requires the iwn firmware module
308 # ixl: Intel XL710 40Gbe PCIE Ethernet
309 # ixlv: Intel XL710 40Gbe VF PCIE Ethernet
310 # mlx4ib: Mellanox ConnectX HCA InfiniBand
311 # mlxen: Mellanox ConnectX HCA Ethernet
312 # mthca: Mellanox HCA InfiniBand
313 # nfe: nVidia nForce MCP on-board Ethernet Networking (BSD open source)
314 # nve: nVidia nForce MCP on-board Ethernet Networking
315 # sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters
316 # vmx: VMware VMXNET3 Ethernet (BSD open source)
317 # wpi: Intel 3945ABG Wireless LAN controller
318 # Requires the wpi firmware module
320 device bxe # Broadcom NetXtreme II BCM5771X/BCM578XX 10GbE
321 device ed # NE[12]000, SMC Ultra, 3c503, DS8390 cards
325 device ipw # Intel 2100 wireless NICs.
326 device iwi # Intel 2200BG/2225BG/2915ABG wireless NICs.
327 device iwn # Intel 4965/1000/5000/6000 wireless NICs.
328 device ixl # Intel XL710 40Gbe PCIE Ethernet
329 device ixlv # Intel XL710 40Gbe VF PCIE Ethernet
330 device mlx4ib # Mellanox ConnectX HCA InfiniBand
331 device mlxen # Mellanox ConnectX HCA Ethernet
332 device mthca # Mellanox HCA InfiniBand
333 device nfe # nVidia nForce MCP on-board Ethernet
334 device nve # nVidia nForce MCP on-board Ethernet Networking
335 device sfxge # Solarflare SFC9000 10Gb Ethernet
336 device vmx # VMware VMXNET3 Ethernet
337 device wpi # Intel 3945ABG wireless NICs.
339 # IEEE 802.11 adapter firmware modules
341 # Intel PRO/Wireless 2100 firmware:
342 # ipwfw: BSS/IBSS/monitor mode firmware
343 # ipwbssfw: BSS mode firmware
344 # ipwibssfw: IBSS mode firmware
345 # ipwmonitorfw: Monitor mode firmware
346 # Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware:
347 # iwifw: BSS/IBSS/monitor mode firmware
348 # iwibssfw: BSS mode firmware
349 # iwiibssfw: IBSS mode firmware
350 # iwimonitorfw: Monitor mode firmware
351 # Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware:
352 # iwnfw: Single module to support the 4965/1000/5000/5150/6000
353 # iwn4965fw: Specific module for the 4965 only
354 # iwn1000fw: Specific module for the 1000 only
355 # iwn5000fw: Specific module for the 5000 only
356 # iwn5150fw: Specific module for the 5150 only
357 # iwn6000fw: Specific module for the 6000 only
358 # iwn6050fw: Specific module for the 6050 only
359 # wpifw: Intel 3945ABG Wireless LAN Controller firmware
378 # Intel Non-Transparent Bridge (NTB) hardware
379 device ntb_hw # Hardware Abstraction Layer for the NTB
380 device if_ntb # Simulated ethernet device using the NTB
383 #XXX this stores pointers in a 32bit field that is defined by the hardware
387 # Areca 11xx and 12xx series of SATA II RAID controllers.
390 device arcmsr # Areca SATA II RAID
393 # 3ware 9000 series PATA/SATA RAID controller driver and options.
394 # The driver is implemented as a SIM, and so, needs the CAM infrastructure.
396 options TWA_DEBUG # 0-10; 10 prints the most messages.
397 options TWA_FLASH_FIRMWARE # firmware image bundled when defined.
398 device twa # 3ware 9000 series PATA/SATA RAID
401 # SCSI host adapters:
403 # ncv: NCR 53C500 based SCSI host adapters.
404 # nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
405 # stg: TMC 18C30, 18C50 based SCSI host adapters.
412 # Adaptec FSA RAID controllers, including integrated DELL controllers,
413 # the Dell PERC 2/QC and the HP NetRAID-4M
415 device aacp # SCSI Passthrough interface (optional, CAM required)
418 # Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming families
419 device aacraid # Container interface, CAM required
422 # Highpoint RocketRAID 27xx.
426 # Highpoint RocketRAID 182x.
430 # Highpoint DC7280 and R750.
434 # Highpoint RocketRAID. Supports RR172x, RR222x, RR2240, RR232x, RR2340,
435 # RR2210, RR174x, RR2522, RR231x, RR230x.
439 # Highpoint RocketRaid 3xxx series SATA RAID
443 # IBM (now Adaptec) ServeRAID controllers
447 # Intel integrated Memory Controller (iMC) SMBus controller
448 # Sandybridge-Xeon, Ivybridge-Xeon, Haswell-Xeon, Broadwell-Xeon
452 # Intel C600 (Patsburg) integrated SAS controller
454 options ISCI_LOGGING # enable debugging in isci HAL
457 # NVM Express (NVMe) support
458 device nvme # base NVMe driver
459 device nvd # expose NVMe namespaces as disks, depends on nvme
462 # PMC-Sierra SAS/SATA controller
466 # SafeNet crypto driver: can be moved to the MI NOTES as soon as
467 # it's tested on a big-endian machine
469 device safe # SafeNet 1141
470 options SAFE_DEBUG # enable debugging support: hw.safe.debug
471 options SAFE_RNDTEST # enable rndtest support
476 # The virtio entry provides a generic bus for use by the device drivers.
477 # It must be combined with an interface that communicates with the host.
478 # Multiple such interfaces defined by the VirtIO specification. FreeBSD
479 # only has support for PCI. Therefore, virtio_pci must be statically
480 # compiled in or loaded as a module for the device drivers to function.
482 device virtio # Generic VirtIO bus (required)
483 device virtio_pci # VirtIO PCI Interface
484 device vtnet # VirtIO Ethernet device
485 device virtio_blk # VirtIO Block device
486 device virtio_scsi # VirtIO SCSI device
487 device virtio_balloon # VirtIO Memory Balloon device
488 device virtio_random # VirtIO Entropy device
489 device virtio_console # VirtIO Console device
491 # Microsoft Hyper-V enchancement support
492 options HYPERV # Hyper-V kernel infrastructure
493 device hyperv # HyperV drivers
495 # Xen HVM Guest Optimizations
496 options XENHVM # Xen HVM kernel infrastructure
497 device xenpci # Xen HVM Hypervisor services driver
499 #####################################################################
502 # Miscellaneous hardware:
504 # ipmi: Intelligent Platform Management Interface
505 # pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
506 # smbios: DMI/SMBIOS entry point
507 # vpd: Vital Product Data kernel interface
508 # asmc: Apple System Management Controller
509 # si: Specialix International SI/XIO or SX intelligent serial card
510 # tpm: Trusted Platform Module
512 # Notes on the Specialix SI/XIO driver:
513 # The host card is memory, not IO mapped.
514 # The Rev 1 host cards use a 64K chunk, on a 32K boundary.
515 # The Rev 2 host cards use a 32K chunk, on a 32K boundary.
516 # The cards can use an IRQ of 11, 12 or 15.
521 hint.pbio.0.port="0x360"
527 device padlock_rng # VIA Padlock RNG
528 device rdrand_rng # Intel Bull Mountain RNG
529 device aesni # AES-NI OpenCrypto module
532 # Laptop/Notebook options:
541 # Hardware watchdog timers:
543 # ichwd: Intel ICH watchdog timer
544 # amdsbwd: AMD SB7xx watchdog timer
545 # viawd: VIA south bridge watchdog timer
546 # wbwd: Winbond watchdog timer
554 # Temperature sensors:
556 # coretemp: on-die sensor on Intel Core and newer CPUs
557 # amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
563 # CPU control pseudo-device. Provides access to MSRs, CPUID info and
564 # microcode update feature.
569 # System Management Bus (SMB)
571 options ENABLE_ALART # Control alarm on Intel intpm driver
574 # Number of initial kernel page table pages used for early bootstrap.
575 # This number should include enough pages to map the kernel and any
576 # modules or other data loaded with the kernel by the loader. Each
577 # page table page maps 2MB.
582 #####################################################################
585 #XXX keep these here for now and reactivate when support for emulating
586 #XXX these 32 bit binaries is added.
588 # Enable 32-bit runtime support for FreeBSD/i386 binaries.
589 options COMPAT_FREEBSD32
591 # Enable iBCS2 runtime support for SCO and ISC binaries
594 # Emulate spx device for client side of SVR3 local X interface
595 #XXX#options SPX_HACK
597 # Enable Linux ABI emulation
598 #XXX#options COMPAT_LINUX
600 # Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_FREEBSD32)
601 options COMPAT_LINUX32
603 # Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
607 #Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
612 # SysVR4 ABI emulation
614 # The svr4 ABI emulator can be statically compiled into the kernel or loaded as
616 # The STREAMS network emulation code can also be compiled statically or as a
617 # module. If loaded as a module, it must be loaded before the svr4 module
618 # (the /usr/sbin/svr4 script does this for you). If compiling statically,
619 # the `streams' device must be configured into any kernel which also
620 # specifies COMPAT_SVR4. It is possible to have a statically-configured
621 # STREAMS device and a dynamically loadable svr4 emulator; the /usr/sbin/svr4
622 # script understands that it doesn't need to load the `streams' module under
623 # those circumstances.
624 # Caveat: At this time, `options KTRACE' is required for the svr4 emulator
625 # (whether static or dynamic).
627 #XXX#options COMPAT_SVR4 # build emulator statically
628 #XXX#options DEBUG_SVR4 # enable verbose debugging
629 #XXX#device streams # STREAMS network driver (required for svr4).
632 #####################################################################
635 # KSTACK_PAGES is the number of memory pages to assign to the kernel
636 # stack of each thread.
638 options KSTACK_PAGES=5
640 # Enable detailed accounting by the PV entry allocator.
644 #####################################################################
646 # More undocumented options for linting.
647 # Note that documenting these are not considered an affront.
649 options FB_INSTALL_CDEV # install a CDEV entry in /dev
651 options KBDIO_DEBUG=2
652 options KBD_MAXRETRY=4
653 options KBD_MAXWAIT=6
654 options KBD_RESETDELAY=201
658 options TIMER_FREQ=((14318182+6)/12)
661 options VM_KMEM_SIZE_MAX
662 options VM_KMEM_SIZE_SCALE
664 # Enable NDIS binary driver support
668 # Linux-specific pseudo devices support
671 # Module to enable execution of application via emulators like QEMU
672 options IMAGACT_BINMISC