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 hint.speaker.0.at="isa"
129 hint.speaker.0.port="0x61"
130 device gzip #Exec gzipped a.out's. REQUIRES COMPAT_AOUT!
133 #####################################################################
134 # HARDWARE BUS CONFIGURATION
144 # AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
145 # interrupt controller. This saves about 0.7-1.25 usec for each interrupt.
146 # This option breaks suspend/resume on some portables.
148 # AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
149 # interrupt controller. This saves about 0.7-1.25 usec for each interrupt.
150 # Automatic EOI is documented not to work for for the slave with the
151 # original i8259A, but it works for some clones and some integrated
154 # MAXMEM specifies the amount of RAM on the machine; if this is not
155 # specified, FreeBSD will first read the amount of memory from the CMOS
156 # RAM, so the amount of memory will initially be limited to 64MB or 16MB
157 # depending on the BIOS. If the BIOS reports 64MB, a memory probe will
158 # then attempt to detect the installed amount of RAM. If this probe
159 # fails to detect >64MB RAM you will have to use the MAXMEM option.
160 # The amount is in kilobytes, so for a machine with 128MB of RAM, it would
161 # be 131072 (128 * 1024).
163 # BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
164 # reset the CPU for reboot. This is needed on some systems with broken
165 # keyboard controllers.
170 options MAXMEM=(128*1024)
171 #options BROKEN_KEYBOARD_RESET
183 #####################################################################
184 # HARDWARE DEVICE CONFIGURATION
186 # To include support for VGA VESA video modes
189 # Turn on extra debugging checks and output for VESA support.
192 device dpms # DPMS suspend & resume via VESA BIOS
194 # x86 real mode BIOS emulator, required by atkbdc/dpms/vesa
203 hint.psm.0.at="atkbdc"
207 options PSM_HOOKRESUME #hook the system resume event, useful
209 options PSM_RESETAFTERSUSPEND #reset the device at the resume event
211 # The keyboard controller; it controls the keyboard and the PS/2 mouse.
213 hint.atkbdc.0.at="isa"
214 hint.atkbdc.0.port="0x060"
218 hint.atkbd.0.at="atkbdc"
222 options ATKBD_DFLT_KEYMAP # specify the built-in keymap
223 makeoptions ATKBD_DFLT_KEYMAP=fr.dvorak
226 # 0x01 Force detection of keyboard, else we always assume a keyboard
227 # 0x02 Don't reset keyboard, useful for some newer ThinkPads
228 # 0x03 Force detection and avoid reset, might help with certain
230 # 0x04 Old-style (XT) keyboard support, useful for older ThinkPads
232 # Video card driver for VGA adapters.
237 # Try the following option if the mouse pointer is not drawn correctly
238 # or font does not seem to be loaded properly. May cause flicker on
240 options VGA_ALT_SEQACCESS
242 # If you can dispense with some vga driver features, you may want to
243 # use the following options to save some memory.
244 #options VGA_NO_FONT_LOADING # don't save/load font
245 #options VGA_NO_MODE_CHANGE # don't change video modes
247 # Older video cards may require this option for proper operation.
248 options VGA_SLOW_IOACCESS # do byte-wide i/o's to TS and GDC regs
250 # The following option probably won't work with the LCD displays.
251 options VGA_WIDTH90 # support 90 column modes
258 device vt_efifb # EFI 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
289 # Direct Rendering modules for 3D acceleration.
290 device drm # DRM core module required by DRM drivers
291 device mach64drm # ATI Rage Pro, Rage Mobility P/M, Rage XL
292 device mgadrm # AGP Matrox G200, G400, G450, G550
293 device r128drm # ATI Rage 128
294 device savagedrm # S3 Savage3D, Savage4
295 device sisdrm # SiS 300/305, 540, 630
296 device tdfxdrm # 3dfx Voodoo 3/4/5 and Banshee
298 options DRM_DEBUG # Include debug printfs (slow)
301 # Network interfaces:
304 # bxe: Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
306 # ed: Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
307 # HP PC Lan+, various PC Card devices
309 # ipw: Intel PRO/Wireless 2100 IEEE 802.11 adapter
310 # Requires the ipw firmware module
311 # iwi: Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
312 # Requires the iwi firmware module
313 # iwn: Intel Wireless WiFi Link 1000/105/135/2000/4965/5000/6000/6050 abgn
314 # 802.11 network adapters
315 # Requires the iwn firmware module
316 # ixl: Intel XL710 40Gbe PCIE Ethernet
317 # ixlv: Intel XL710 40Gbe VF PCIE Ethernet
318 # mlx4ib: Mellanox ConnectX HCA InfiniBand
319 # mlx4en: Mellanox ConnectX HCA Ethernet
320 # mthca: Mellanox HCA InfiniBand
321 # nfe: nVidia nForce MCP on-board Ethernet Networking (BSD open source)
322 # sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters
323 # vmx: VMware VMXNET3 Ethernet (BSD open source)
324 # wpi: Intel 3945ABG Wireless LAN controller
325 # Requires the wpi firmware module
327 device bxe # Broadcom NetXtreme II BCM5771X/BCM578XX 10GbE
328 device ed # NE[12]000, SMC Ultra, 3c503, DS8390 cards
332 device ipw # Intel 2100 wireless NICs.
333 device iwi # Intel 2200BG/2225BG/2915ABG wireless NICs.
334 device iwn # Intel 4965/1000/5000/6000 wireless NICs.
335 device ixl # Intel XL710 40Gbe PCIE Ethernet
336 options IXL_IW # Enable iWARP Client Interface in ixl(4)
337 device ixlv # Intel XL710 40Gbe VF PCIE Ethernet
338 device mlx4 # Shared code module between IB and Ethernet
339 device mlx4ib # Mellanox ConnectX HCA InfiniBand
340 device mlx4en # Mellanox ConnectX HCA Ethernet
341 device mthca # Mellanox HCA InfiniBand
342 device nfe # nVidia nForce MCP on-board Ethernet
343 device sfxge # Solarflare SFC9000 10Gb Ethernet
344 device vmx # VMware VMXNET3 Ethernet
345 device wpi # Intel 3945ABG wireless NICs.
347 # IEEE 802.11 adapter firmware modules
349 # Intel PRO/Wireless 2100 firmware:
350 # ipwfw: BSS/IBSS/monitor mode firmware
351 # ipwbssfw: BSS mode firmware
352 # ipwibssfw: IBSS mode firmware
353 # ipwmonitorfw: Monitor mode firmware
354 # Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware:
355 # iwifw: BSS/IBSS/monitor mode firmware
356 # iwibssfw: BSS mode firmware
357 # iwiibssfw: IBSS mode firmware
358 # iwimonitorfw: Monitor mode firmware
359 # Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware:
360 # iwnfw: Single module to support all devices
361 # iwn1000fw: Specific module for the 1000 only
362 # iwn105fw: Specific module for the 105 only
363 # iwn135fw: Specific module for the 135 only
364 # iwn2000fw: Specific module for the 2000 only
365 # iwn2030fw: Specific module for the 2030 only
366 # iwn4965fw: Specific module for the 4965 only
367 # iwn5000fw: Specific module for the 5000 only
368 # iwn5150fw: Specific module for the 5150 only
369 # iwn6000fw: Specific module for the 6000 only
370 # iwn6000g2afw: Specific module for the 6000g2a only
371 # iwn6000g2bfw: Specific module for the 6000g2b only
372 # iwn6050fw: Specific module for the 6050 only
373 # wpifw: Intel 3945ABG Wireless LAN Controller firmware
398 # Intel Non-Transparent Bridge (NTB) hardware
399 device ntb_hw # Hardware Abstraction Layer for the NTB
400 device if_ntb # Simulated ethernet device using the NTB
403 #XXX this stores pointers in a 32bit field that is defined by the hardware
407 # Areca 11xx and 12xx series of SATA II RAID controllers.
410 device arcmsr # Areca SATA II RAID
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 options TWA_FLASH_FIRMWARE # firmware image bundled when defined.
418 device twa # 3ware 9000 series PATA/SATA RAID
421 # SCSI host adapters:
423 # ncv: NCR 53C500 based SCSI host adapters.
424 # nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
425 # stg: TMC 18C30, 18C50 based SCSI host adapters.
432 # Adaptec FSA RAID controllers, including integrated DELL controllers,
433 # the Dell PERC 2/QC and the HP NetRAID-4M
435 device aacp # SCSI Passthrough interface (optional, CAM required)
438 # Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming families
439 device aacraid # Container interface, CAM required
442 # Highpoint RocketRAID 27xx.
446 # Highpoint RocketRAID 182x.
450 # Highpoint DC7280 and R750.
454 # Highpoint RocketRAID. Supports RR172x, RR222x, RR2240, RR232x, RR2340,
455 # RR2210, RR174x, RR2522, RR231x, RR230x.
459 # Highpoint RocketRaid 3xxx series SATA RAID
463 # IBM (now Adaptec) ServeRAID controllers
467 # Intel C600 (Patsburg) integrated SAS controller
469 options ISCI_LOGGING # enable debugging in isci HAL
472 # NVM Express (NVMe) support
473 device nvme # base NVMe driver
474 device nvd # expose NVMe namespaces as disks, depends on nvme
477 # PMC-Sierra SAS/SATA controller
481 # SafeNet crypto driver: can be moved to the MI NOTES as soon as
482 # it's tested on a big-endian machine
484 device safe # SafeNet 1141
485 options SAFE_DEBUG # enable debugging support: hw.safe.debug
486 options SAFE_RNDTEST # enable rndtest support
491 # The virtio entry provides a generic bus for use by the device drivers.
492 # It must be combined with an interface that communicates with the host.
493 # Multiple such interfaces are defined by the VirtIO specification. FreeBSD
494 # only has support for PCI. Therefore, virtio_pci must be statically
495 # compiled in or loaded as a module for the device drivers to function.
497 device virtio # Generic VirtIO bus (required)
498 device virtio_pci # VirtIO PCI Interface
499 device vtnet # VirtIO Ethernet device
500 device virtio_blk # VirtIO Block device
501 device virtio_scsi # VirtIO SCSI device
502 device virtio_balloon # VirtIO Memory Balloon device
503 device virtio_random # VirtIO Entropy device
504 device virtio_console # VirtIO Console device
506 # Microsoft Hyper-V enhancement support
507 device hyperv # HyperV drivers
509 # Xen HVM Guest Optimizations
510 options XENHVM # Xen HVM kernel infrastructure
511 device xenpci # Xen HVM Hypervisor services driver
513 #####################################################################
516 # Miscellaneous hardware:
518 # ipmi: Intelligent Platform Management Interface
519 # pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
520 # smbios: DMI/SMBIOS entry point
521 # vpd: Vital Product Data kernel interface
522 # asmc: Apple System Management Controller
523 # si: Specialix International SI/XIO or SX intelligent serial card
524 # tpm: Trusted Platform Module
526 # Notes on the Specialix SI/XIO driver:
527 # The host card is memory, not IO mapped.
528 # The Rev 1 host cards use a 64K chunk, on a 32K boundary.
529 # The Rev 2 host cards use a 32K chunk, on a 32K boundary.
530 # The cards can use an IRQ of 11, 12 or 15.
535 hint.pbio.0.port="0x360"
540 device padlock_rng # VIA Padlock RNG
541 device rdrand_rng # Intel Bull Mountain RNG
542 device aesni # AES-NI OpenCrypto module
543 device ioat # Intel I/OAT DMA engine
546 # 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
568 # Temperature sensors:
570 # coretemp: on-die sensor on Intel Core and newer CPUs
571 # amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
577 # CPU control pseudo-device. Provides access to MSRs, CPUID info and
578 # microcode update feature.
583 # System Management Bus (SMB)
585 options ENABLE_ALART # Control alarm on Intel intpm driver
588 # Number of initial kernel page table pages used for early bootstrap.
589 # This number should include enough pages to map the kernel and any
590 # modules or other data loaded with the kernel by the loader. Each
591 # page table page maps 2MB.
595 # EFI Runtime Services support (not functional yet).
599 #####################################################################
602 #XXX keep these here for now and reactivate when support for emulating
603 #XXX these 32 bit binaries is added.
605 # Enable 32-bit runtime support for FreeBSD/i386 binaries.
606 options COMPAT_FREEBSD32
608 # Enable iBCS2 runtime support for SCO and ISC binaries
611 # Emulate spx device for client side of SVR3 local X interface
612 #XXX#options SPX_HACK
614 # Enable 32-bit runtime support for CloudABI binaries.
615 options COMPAT_CLOUDABI32
617 # Enable 64-bit runtime support for CloudABI binaries.
618 options COMPAT_CLOUDABI64
620 # Enable Linux ABI emulation
621 #XXX#options COMPAT_LINUX
623 # Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_FREEBSD32)
624 options COMPAT_LINUX32
626 # Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
630 #Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
634 #####################################################################
637 # KSTACK_PAGES is the number of memory pages to assign to the kernel
638 # stack of each thread.
640 options KSTACK_PAGES=5
642 # Enable detailed accounting by the PV entry allocator.
646 #####################################################################
648 # More undocumented options for linting.
649 # Note that documenting these are not considered an affront.
651 options FB_INSTALL_CDEV # install a CDEV entry in /dev
653 options KBDIO_DEBUG=2
654 options KBD_MAXRETRY=4
655 options KBD_MAXWAIT=6
656 options KBD_RESETDELAY=201
660 options TIMER_FREQ=((14318182+6)/12)
663 options VM_KMEM_SIZE_MAX
664 options VM_KMEM_SIZE_SCALE
666 # Enable NDIS binary driver support