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 # PERFMON causes the driver for Pentium/Pentium Pro performance counters
78 # to be compiled. See perfmon(4) for more information.
83 #####################################################################
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).
100 # Not all device drivers support this mode of operation at the time of
101 # this writing. See polling(4) for more details.
103 options DEVICE_POLLING
105 # BPF_JITTER adds support for BPF just-in-time compiler.
109 # OpenFabrics Enterprise Distribution (Infiniband).
111 options OFED_DEBUG_INIT
113 # Sockets Direct Protocol
123 #####################################################################
126 # Provide read/write access to the memory in the clock chip.
127 device nvram # Access to rtc cmos via /dev/nvram
130 #####################################################################
131 # MISCELLANEOUS DEVICES AND OPTIONS
133 device speaker #Play IBM BASIC-style noises out your speaker
134 hint.speaker.0.at="isa"
135 hint.speaker.0.port="0x61"
136 device gzip #Exec gzipped a.out's. REQUIRES COMPAT_AOUT!
139 #####################################################################
140 # HARDWARE BUS CONFIGURATION
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.
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
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).
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.
176 options MAXMEM=(128*1024)
177 #options BROKEN_KEYBOARD_RESET
180 # PCI bus & PCI options:
194 #####################################################################
195 # HARDWARE DEVICE CONFIGURATION
197 # To include support for VGA VESA video modes
200 # Turn on extra debugging checks and output for VESA support.
203 device dpms # DPMS suspend & resume via VESA BIOS
205 # x86 real mode BIOS emulator, required by atkbdc/dpms/vesa
214 hint.psm.0.at="atkbdc"
218 options PSM_HOOKRESUME #hook the system resume event, useful
220 options PSM_RESETAFTERSUSPEND #reset the device at the resume event
222 # The keyboard controller; it controls the keyboard and the PS/2 mouse.
224 hint.atkbdc.0.at="isa"
225 hint.atkbdc.0.port="0x060"
229 hint.atkbd.0.at="atkbdc"
233 options ATKBD_DFLT_KEYMAP # specify the built-in keymap
234 makeoptions ATKBD_DFLT_KEYMAP=fr.dvorak
237 # 0x01 Force detection of keyboard, else we always assume a keyboard
238 # 0x02 Don't reset keyboard, useful for some newer ThinkPads
239 # 0x03 Force detection and avoid reset, might help with certain
241 # 0x04 Old-style (XT) keyboard support, useful for older ThinkPads
243 # Video card driver for VGA adapters.
248 # Try the following option if the mouse pointer is not drawn correctly
249 # or font does not seem to be loaded properly. May cause flicker on
251 options VGA_ALT_SEQACCESS
253 # If you can dispense with some vga driver features, you may want to
254 # use the following options to save some memory.
255 #options VGA_NO_FONT_LOADING # don't save/load font
256 #options VGA_NO_MODE_CHANGE # don't change video modes
258 # Older video cards may require this option for proper operation.
259 options VGA_SLOW_IOACCESS # do byte-wide i/o's to TS and GDC regs
261 # The following option probably won't work with the LCD displays.
262 options VGA_WIDTH90 # support 90 column modes
269 device vt_efifb # EFI framebuffer
271 # Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA.
274 # 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support. This will create
275 # the /dev/3dfx0 device to work with glide implementations. This should get
276 # linked to /dev/3dfx and /dev/voodoo. Note that this is not the same as
277 # the tdfx DRI module from XFree86 and is completely unrelated.
279 # To enable Linuxulator support, one must also include COMPAT_LINUX in the
280 # config as well. The other option is to load both as modules.
282 device tdfx # Enable 3Dfx Voodoo support
283 #XXX#device tdfx_linux # Enable Linuxulator support
286 # ACPI support using the Intel ACPI Component Architecture reference
289 # ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
290 # kernel environment variables to select initial debugging levels for the
291 # Intel ACPICA code. (Note that the Intel code must also have USE_DEBUGGER
292 # defined when it is built).
297 # The cpufreq(4) driver provides support for non-ACPI CPU frequency control
300 # Direct Rendering modules for 3D acceleration.
301 device drm # DRM core module required by DRM drivers
302 device i915drm # Intel i830 through i915
303 device mach64drm # ATI Rage Pro, Rage Mobility P/M, Rage XL
304 device mgadrm # AGP Matrox G200, G400, G450, G550
305 device r128drm # ATI Rage 128
306 device radeondrm # ATI Radeon
307 device savagedrm # S3 Savage3D, Savage4
308 device sisdrm # SiS 300/305, 540, 630
309 device tdfxdrm # 3dfx Voodoo 3/4/5 and Banshee
311 options DRM_DEBUG # Include debug printfs (slow)
314 # Network interfaces:
317 # bxe: Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
319 # ed: Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
320 # HP PC Lan+, various PC Card devices
322 # ipw: Intel PRO/Wireless 2100 IEEE 802.11 adapter
323 # Requires the ipw firmware module
324 # iwi: Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
325 # Requires the iwi firmware module
326 # iwn: Intel Wireless WiFi Link 1000/105/135/2000/4965/5000/6000/6050 abgn
327 # 802.11 network adapters
328 # Requires the iwn firmware module
329 # ixl: Intel XL710 40Gbe PCIE Ethernet
330 # ixlv: Intel XL710 40Gbe VF PCIE Ethernet
331 # mlx4ib: Mellanox ConnectX HCA InfiniBand
332 # mlxen: Mellanox ConnectX HCA Ethernet
333 # mthca: Mellanox HCA InfiniBand
334 # nfe: nVidia nForce MCP on-board Ethernet Networking (BSD open source)
335 # sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters
336 # vmx: VMware VMXNET3 Ethernet (BSD open source)
337 # wpi: Intel 3945ABG Wireless LAN controller
338 # Requires the wpi firmware module
340 device bxe # Broadcom NetXtreme II BCM5771X/BCM578XX 10GbE
341 device ed # NE[12]000, SMC Ultra, 3c503, DS8390 cards
345 device ipw # Intel 2100 wireless NICs.
346 device iwi # Intel 2200BG/2225BG/2915ABG wireless NICs.
347 device iwn # Intel 4965/1000/5000/6000 wireless NICs.
348 device ixl # Intel XL710 40Gbe PCIE Ethernet
349 device ixlv # Intel XL710 40Gbe VF PCIE Ethernet
350 device mlx4ib # Mellanox ConnectX HCA InfiniBand
351 device mlxen # Mellanox ConnectX HCA Ethernet
352 device mthca # Mellanox HCA InfiniBand
353 device nfe # nVidia nForce MCP on-board Ethernet
354 device sfxge # Solarflare SFC9000 10Gb Ethernet
355 device vmx # VMware VMXNET3 Ethernet
356 device wpi # Intel 3945ABG wireless NICs.
358 # IEEE 802.11 adapter firmware modules
360 # Intel PRO/Wireless 2100 firmware:
361 # ipwfw: BSS/IBSS/monitor mode firmware
362 # ipwbssfw: BSS mode firmware
363 # ipwibssfw: IBSS mode firmware
364 # ipwmonitorfw: Monitor mode firmware
365 # Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware:
366 # iwifw: BSS/IBSS/monitor mode firmware
367 # iwibssfw: BSS mode firmware
368 # iwiibssfw: IBSS mode firmware
369 # iwimonitorfw: Monitor mode firmware
370 # Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware:
371 # iwnfw: Single module to support all devices
372 # iwn1000fw: Specific module for the 1000 only
373 # iwn105fw: Specific module for the 105 only
374 # iwn135fw: Specific module for the 135 only
375 # iwn2000fw: Specific module for the 2000 only
376 # iwn2030fw: Specific module for the 2030 only
377 # iwn4965fw: Specific module for the 4965 only
378 # iwn5000fw: Specific module for the 5000 only
379 # iwn5150fw: Specific module for the 5150 only
380 # iwn6000fw: Specific module for the 6000 only
381 # iwn6000g2afw: Specific module for the 6000g2a only
382 # iwn6000g2bfw: Specific module for the 6000g2b only
383 # iwn6050fw: Specific module for the 6050 only
384 # wpifw: Intel 3945ABG Wireless LAN Controller firmware
409 # Intel Non-Transparent Bridge (NTB) hardware
410 device ntb_hw # Hardware Abstraction Layer for the NTB
411 device if_ntb # Simulated ethernet device using the NTB
414 #XXX this stores pointers in a 32bit field that is defined by the hardware
418 # Areca 11xx and 12xx series of SATA II RAID controllers.
421 device arcmsr # Areca SATA II RAID
424 # 3ware 9000 series PATA/SATA RAID controller driver and options.
425 # The driver is implemented as a SIM, and so, needs the CAM infrastructure.
427 options TWA_DEBUG # 0-10; 10 prints the most messages.
428 options TWA_FLASH_FIRMWARE # firmware image bundled when defined.
429 device twa # 3ware 9000 series PATA/SATA RAID
432 # SCSI host adapters:
434 # ncv: NCR 53C500 based SCSI host adapters.
435 # nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
436 # stg: TMC 18C30, 18C50 based SCSI host adapters.
443 # Adaptec FSA RAID controllers, including integrated DELL controllers,
444 # the Dell PERC 2/QC and the HP NetRAID-4M
446 device aacp # SCSI Passthrough interface (optional, CAM required)
449 # Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming families
450 device aacraid # Container interface, CAM required
453 # Highpoint RocketRAID 27xx.
457 # Highpoint RocketRAID 182x.
461 # Highpoint DC7280 and R750.
465 # Highpoint RocketRAID. Supports RR172x, RR222x, RR2240, RR232x, RR2340,
466 # RR2210, RR174x, RR2522, RR231x, RR230x.
470 # Highpoint RocketRaid 3xxx series SATA RAID
474 # IBM (now Adaptec) ServeRAID controllers
478 # Intel C600 (Patsburg) integrated SAS controller
480 options ISCI_LOGGING # enable debugging in isci HAL
483 # NVM Express (NVMe) support
484 device nvme # base NVMe driver
485 device nvd # expose NVMe namespaces as disks, depends on nvme
488 # PMC-Sierra SAS/SATA controller
492 # SafeNet crypto driver: can be moved to the MI NOTES as soon as
493 # it's tested on a big-endian machine
495 device safe # SafeNet 1141
496 options SAFE_DEBUG # enable debugging support: hw.safe.debug
497 options SAFE_RNDTEST # enable rndtest support
502 # The virtio entry provides a generic bus for use by the device drivers.
503 # It must be combined with an interface that communicates with the host.
504 # Multiple such interfaces are defined by the VirtIO specification. FreeBSD
505 # only has support for PCI. Therefore, virtio_pci must be statically
506 # compiled in or loaded as a module for the device drivers to function.
508 device virtio # Generic VirtIO bus (required)
509 device virtio_pci # VirtIO PCI Interface
510 device vtnet # VirtIO Ethernet device
511 device virtio_blk # VirtIO Block device
512 device virtio_scsi # VirtIO SCSI device
513 device virtio_balloon # VirtIO Memory Balloon device
514 device virtio_random # VirtIO Entropy device
515 device virtio_console # VirtIO Console device
517 # Microsoft Hyper-V enchancement support
518 device hyperv # HyperV drivers
520 # Xen HVM Guest Optimizations
521 options XENHVM # Xen HVM kernel infrastructure
522 device xenpci # Xen HVM Hypervisor services driver
524 #####################################################################
527 # Miscellaneous hardware:
529 # ipmi: Intelligent Platform Management Interface
530 # pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
531 # smbios: DMI/SMBIOS entry point
532 # vpd: Vital Product Data kernel interface
533 # asmc: Apple System Management Controller
534 # si: Specialix International SI/XIO or SX intelligent serial card
535 # tpm: Trusted Platform Module
537 # Notes on the Specialix SI/XIO driver:
538 # The host card is memory, not IO mapped.
539 # The Rev 1 host cards use a 64K chunk, on a 32K boundary.
540 # The Rev 2 host cards use a 32K chunk, on a 32K boundary.
541 # The cards can use an IRQ of 11, 12 or 15.
546 hint.pbio.0.port="0x360"
552 device padlock_rng # VIA Padlock RNG
553 device rdrand_rng # Intel Bull Mountain RNG
554 device aesni # AES-NI OpenCrypto module
555 device ioat # Intel I/OAT DMA engine
558 # Laptop/Notebook options:
567 # Hardware watchdog timers:
569 # ichwd: Intel ICH watchdog timer
570 # amdsbwd: AMD SB7xx watchdog timer
571 # viawd: VIA south bridge watchdog timer
572 # wbwd: Winbond watchdog timer
580 # Temperature sensors:
582 # coretemp: on-die sensor on Intel Core and newer CPUs
583 # amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
589 # CPU control pseudo-device. Provides access to MSRs, CPUID info and
590 # microcode update feature.
595 # System Management Bus (SMB)
597 options ENABLE_ALART # Control alarm on Intel intpm driver
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.
608 #####################################################################
611 #XXX keep these here for now and reactivate when support for emulating
612 #XXX these 32 bit binaries is added.
614 # Enable 32-bit runtime support for FreeBSD/i386 binaries.
615 options COMPAT_FREEBSD32
617 # Enable iBCS2 runtime support for SCO and ISC binaries
620 # Emulate spx device for client side of SVR3 local X interface
621 #XXX#options SPX_HACK
623 # Enable 64-bit runtime support for CloudABI binaries.
624 options COMPAT_CLOUDABI64
626 # Enable Linux ABI emulation
627 #XXX#options COMPAT_LINUX
629 # Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_FREEBSD32)
630 options COMPAT_LINUX32
632 # Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
636 #Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
641 # SysVR4 ABI emulation
643 # The svr4 ABI emulator can be statically compiled into the kernel or loaded as
645 # The STREAMS network emulation code can also be compiled statically or as a
646 # module. If loaded as a module, it must be loaded before the svr4 module
647 # (the /usr/sbin/svr4 script does this for you). If compiling statically,
648 # the `streams' device must be configured into any kernel which also
649 # specifies COMPAT_SVR4. It is possible to have a statically-configured
650 # STREAMS device and a dynamically loadable svr4 emulator; the /usr/sbin/svr4
651 # script understands that it doesn't need to load the `streams' module under
652 # those circumstances.
653 # Caveat: At this time, `options KTRACE' is required for the svr4 emulator
654 # (whether static or dynamic).
656 #XXX#options COMPAT_SVR4 # build emulator statically
657 #XXX#options DEBUG_SVR4 # enable verbose debugging
658 #XXX#device streams # STREAMS network driver (required for svr4).
661 #####################################################################
664 # KSTACK_PAGES is the number of memory pages to assign to the kernel
665 # stack of each thread.
667 options KSTACK_PAGES=5
669 # Enable detailed accounting by the PV entry allocator.
673 #####################################################################
675 # More undocumented options for linting.
676 # Note that documenting these are not considered an affront.
678 options FB_INSTALL_CDEV # install a CDEV entry in /dev
680 options KBDIO_DEBUG=2
681 options KBD_MAXRETRY=4
682 options KBD_MAXWAIT=6
683 options KBD_RESETDELAY=201
687 options TIMER_FREQ=((14318182+6)/12)
690 options VM_KMEM_SIZE_MAX
691 options VM_KMEM_SIZE_SCALE
693 # Enable NDIS binary driver support