FreeBSD/Linux Kernel Cross Reference
sys/amd64/conf/NOTES
1 #
2 # NOTES -- Lines that can be cut/pasted into kernel and hints configs.
3 #
4 # This file contains machine dependent kernel configuration notes. For
5 # machine independent notes, look in /sys/conf/NOTES.
6 #
7 # $FreeBSD: releng/11.0/sys/amd64/conf/NOTES 299010 2016-05-03 22:13:04Z pfg $
8 #
9
10 #
11 # We want LINT to cover profiling as well.
12 profile 2
13
14 #
15 # Enable the kernel DTrace hooks which are required to load the DTrace
16 # kernel modules.
17 #
18 options KDTRACE_HOOKS
19
20 # DTrace core
21 # NOTE: introduces CDDL-licensed components into the kernel
22 #device dtrace
23
24 # DTrace modules
25 #device dtrace_profile
26 #device dtrace_sdt
27 #device dtrace_fbt
28 #device dtrace_systrace
29 #device dtrace_prototype
30 #device dtnfscl
31 #device dtmalloc
32
33 # Alternatively include all the DTrace modules
34 #device dtraceall
35
36
37 #####################################################################
38 # SMP OPTIONS:
39 #
40 # Notes:
41 #
42 # IPI_PREEMPTION instructs the kernel to preempt threads running on other
43 # CPUS if needed. Relies on the PREEMPTION option
44
45 # Optional:
46 options IPI_PREEMPTION
47 device atpic # Optional legacy pic support
48 device mptable # Optional MPSPEC mptable support
49
50 #
51 # Watchdog routines.
52 #
53 options MP_WATCHDOG
54
55 # Debugging options.
56 #
57 options COUNT_XINVLTLB_HITS # Counters for TLB events
58 options COUNT_IPIS # Per-CPU IPI interrupt counters
59
60
61
62 #####################################################################
63 # CPU OPTIONS
64
65 #
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.
69 #
70 cpu HAMMER # aka K8, aka Opteron & Athlon64
71
72 #
73 # Options for CPU features.
74 #
75
76 #
77 # PERFMON causes the driver for Pentium/Pentium Pro performance counters
78 # to be compiled. See perfmon(4) for more information.
79 #
80 #XXX#options PERFMON
81
82
83 #####################################################################
84 # NETWORKING OPTIONS
85
86 #
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).
99 #
100 # Not all device drivers support this mode of operation at the time of
101 # this writing. See polling(4) for more details.
102
103 options DEVICE_POLLING
104
105 # BPF_JITTER adds support for BPF just-in-time compiler.
106
107 options BPF_JITTER
108
109 # OpenFabrics Enterprise Distribution (Infiniband).
110 options OFED
111 options OFED_DEBUG_INIT
112
113 # Sockets Direct Protocol
114 options SDP
115 options SDP_DEBUG
116
117 # IP over Infiniband
118 options IPOIB
119 options IPOIB_DEBUG
120 options IPOIB_CM
121
122
123 #####################################################################
124 # CLOCK OPTIONS
125
126 # Provide read/write access to the memory in the clock chip.
127 device nvram # Access to rtc cmos via /dev/nvram
128
129
130 #####################################################################
131 # MISCELLANEOUS DEVICES AND OPTIONS
132
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!
137
138
139 #####################################################################
140 # HARDWARE BUS CONFIGURATION
141
142 #
143 # ISA bus
144 #
145 device isa
146
147 #
148 # Options for `isa':
149 #
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.
153 #
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
158 # versions.
159 #
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).
168 #
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.
172
173 options AUTO_EOI_1
174 #options AUTO_EOI_2
175
176 options MAXMEM=(128*1024)
177 #options BROKEN_KEYBOARD_RESET
178
179 #
180 # AGP GART support
181 device agp
182
183 #
184 # AGP debugging.
185 #
186 options AGP_DEBUG
187
188
189 #####################################################################
190 # HARDWARE DEVICE CONFIGURATION
191
192 # To include support for VGA VESA video modes
193 options VESA
194
195 # Turn on extra debugging checks and output for VESA support.
196 options VESA_DEBUG
197
198 device dpms # DPMS suspend & resume via VESA BIOS
199
200 # x86 real mode BIOS emulator, required by atkbdc/dpms/vesa
201 options X86BIOS
202
203 #
204 # Optional devices:
205 #
206
207 # PS/2 mouse
208 device psm
209 hint.psm.0.at="atkbdc"
210 hint.psm.0.irq="12"
211
212 # Options for psm:
213 options PSM_HOOKRESUME #hook the system resume event, useful
214 #for some laptops
215 options PSM_RESETAFTERSUSPEND #reset the device at the resume event
216
217 # The keyboard controller; it controls the keyboard and the PS/2 mouse.
218 device atkbdc
219 hint.atkbdc.0.at="isa"
220 hint.atkbdc.0.port="0x060"
221
222 # The AT keyboard
223 device atkbd
224 hint.atkbd.0.at="atkbdc"
225 hint.atkbd.0.irq="1"
226
227 # Options for atkbd:
228 options ATKBD_DFLT_KEYMAP # specify the built-in keymap
229 makeoptions ATKBD_DFLT_KEYMAP=fr.dvorak
230
231 # `flags' for atkbd:
232 # 0x01 Force detection of keyboard, else we always assume a keyboard
233 # 0x02 Don't reset keyboard, useful for some newer ThinkPads
234 # 0x03 Force detection and avoid reset, might help with certain
235 # dockingstations
236 # 0x04 Old-style (XT) keyboard support, useful for older ThinkPads
237
238 # Video card driver for VGA adapters.
239 device vga
240 hint.vga.0.at="isa"
241
242 # Options for vga:
243 # Try the following option if the mouse pointer is not drawn correctly
244 # or font does not seem to be loaded properly. May cause flicker on
245 # some systems.
246 options VGA_ALT_SEQACCESS
247
248 # If you can dispense with some vga driver features, you may want to
249 # use the following options to save some memory.
250 #options VGA_NO_FONT_LOADING # don't save/load font
251 #options VGA_NO_MODE_CHANGE # don't change video modes
252
253 # Older video cards may require this option for proper operation.
254 options VGA_SLOW_IOACCESS # do byte-wide i/o's to TS and GDC regs
255
256 # The following option probably won't work with the LCD displays.
257 options VGA_WIDTH90 # support 90 column modes
258
259 # Debugging.
260 options VGA_DEBUG
261
262 # vt(4) drivers.
263 device vt_vga # VGA
264 device vt_efifb # EFI framebuffer
265
266 # Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA.
267 device s3pci
268
269 # 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support. This will create
270 # the /dev/3dfx0 device to work with glide implementations. This should get
271 # linked to /dev/3dfx and /dev/voodoo. Note that this is not the same as
272 # the tdfx DRI module from XFree86 and is completely unrelated.
273 #
274 # To enable Linuxulator support, one must also include COMPAT_LINUX in the
275 # config as well. The other option is to load both as modules.
276
277 device tdfx # Enable 3Dfx Voodoo support
278 #XXX#device tdfx_linux # Enable Linuxulator support
279
280 #
281 # ACPI support using the Intel ACPI Component Architecture reference
282 # implementation.
283 #
284 # ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
285 # kernel environment variables to select initial debugging levels for the
286 # Intel ACPICA code. (Note that the Intel code must also have USE_DEBUGGER
287 # defined when it is built).
288
289 device acpi
290 options ACPI_DEBUG
291
292 # The cpufreq(4) driver provides support for non-ACPI CPU frequency control
293 device cpufreq
294
295 # Direct Rendering modules for 3D acceleration.
296 device drm # DRM core module required by DRM drivers
297 device i915drm # Intel i830 through i915
298 device mach64drm # ATI Rage Pro, Rage Mobility P/M, Rage XL
299 device mgadrm # AGP Matrox G200, G400, G450, G550
300 device r128drm # ATI Rage 128
301 device radeondrm # ATI Radeon
302 device savagedrm # S3 Savage3D, Savage4
303 device sisdrm # SiS 300/305, 540, 630
304 device tdfxdrm # 3dfx Voodoo 3/4/5 and Banshee
305 device viadrm # VIA
306 options DRM_DEBUG # Include debug printfs (slow)
307
308 #
309 # Network interfaces:
310 #
311
312 # bxe: Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
313 # adapters.
314 # ed: Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
315 # HP PC Lan+, various PC Card devices
316 # (requires miibus)
317 # ipw: Intel PRO/Wireless 2100 IEEE 802.11 adapter
318 # Requires the ipw firmware module
319 # iwi: Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
320 # Requires the iwi firmware module
321 # iwn: Intel Wireless WiFi Link 1000/105/135/2000/4965/5000/6000/6050 abgn
322 # 802.11 network adapters
323 # Requires the iwn firmware module
324 # ixl: Intel XL710 40Gbe PCIE Ethernet
325 # ixlv: Intel XL710 40Gbe VF PCIE Ethernet
326 # mlx4ib: Mellanox ConnectX HCA InfiniBand
327 # mlxen: Mellanox ConnectX HCA Ethernet
328 # mthca: Mellanox HCA InfiniBand
329 # nfe: nVidia nForce MCP on-board Ethernet Networking (BSD open source)
330 # sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters
331 # vmx: VMware VMXNET3 Ethernet (BSD open source)
332 # wpi: Intel 3945ABG Wireless LAN controller
333 # Requires the wpi firmware module
334
335 device bxe # Broadcom NetXtreme II BCM5771X/BCM578XX 10GbE
336 device ed # NE[12]000, SMC Ultra, 3c503, DS8390 cards
337 options ED_3C503
338 options ED_HPP
339 options ED_SIC
340 device ipw # Intel 2100 wireless NICs.
341 device iwi # Intel 2200BG/2225BG/2915ABG wireless NICs.
342 device iwn # Intel 4965/1000/5000/6000 wireless NICs.
343 device ixl # Intel XL710 40Gbe PCIE Ethernet
344 device ixlv # Intel XL710 40Gbe VF PCIE Ethernet
345 device mlx4ib # Mellanox ConnectX HCA InfiniBand
346 device mlxen # Mellanox ConnectX HCA Ethernet
347 device mthca # Mellanox HCA InfiniBand
348 device nfe # nVidia nForce MCP on-board Ethernet
349 device sfxge # Solarflare SFC9000 10Gb Ethernet
350 device vmx # VMware VMXNET3 Ethernet
351 device wpi # Intel 3945ABG wireless NICs.
352
353 # IEEE 802.11 adapter firmware modules
354
355 # Intel PRO/Wireless 2100 firmware:
356 # ipwfw: BSS/IBSS/monitor mode firmware
357 # ipwbssfw: BSS mode firmware
358 # ipwibssfw: IBSS mode firmware
359 # ipwmonitorfw: Monitor mode firmware
360 # Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware:
361 # iwifw: BSS/IBSS/monitor mode firmware
362 # iwibssfw: BSS mode firmware
363 # iwiibssfw: IBSS mode firmware
364 # iwimonitorfw: Monitor mode firmware
365 # Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware:
366 # iwnfw: Single module to support all devices
367 # iwn1000fw: Specific module for the 1000 only
368 # iwn105fw: Specific module for the 105 only
369 # iwn135fw: Specific module for the 135 only
370 # iwn2000fw: Specific module for the 2000 only
371 # iwn2030fw: Specific module for the 2030 only
372 # iwn4965fw: Specific module for the 4965 only
373 # iwn5000fw: Specific module for the 5000 only
374 # iwn5150fw: Specific module for the 5150 only
375 # iwn6000fw: Specific module for the 6000 only
376 # iwn6000g2afw: Specific module for the 6000g2a only
377 # iwn6000g2bfw: Specific module for the 6000g2b only
378 # iwn6050fw: Specific module for the 6050 only
379 # wpifw: Intel 3945ABG Wireless LAN Controller firmware
380
381 device iwifw
382 device iwibssfw
383 device iwiibssfw
384 device iwimonitorfw
385 device ipwfw
386 device ipwbssfw
387 device ipwibssfw
388 device ipwmonitorfw
389 device iwnfw
390 device iwn1000fw
391 device iwn105fw
392 device iwn135fw
393 device iwn2000fw
394 device iwn2030fw
395 device iwn4965fw
396 device iwn5000fw
397 device iwn5150fw
398 device iwn6000fw
399 device iwn6000g2afw
400 device iwn6000g2bfw
401 device iwn6050fw
402 device wpifw
403
404 # Intel Non-Transparent Bridge (NTB) hardware
405 device ntb_hw # Hardware Abstraction Layer for the NTB
406 device if_ntb # Simulated ethernet device using the NTB
407
408 #
409 #XXX this stores pointers in a 32bit field that is defined by the hardware
410 #device pst
411
412 #
413 # Areca 11xx and 12xx series of SATA II RAID controllers.
414 # CAM is required.
415 #
416 device arcmsr # Areca SATA II RAID
417
418 #
419 # 3ware 9000 series PATA/SATA RAID controller driver and options.
420 # The driver is implemented as a SIM, and so, needs the CAM infrastructure.
421 #
422 options TWA_DEBUG # 0-10; 10 prints the most messages.
423 options TWA_FLASH_FIRMWARE # firmware image bundled when defined.
424 device twa # 3ware 9000 series PATA/SATA RAID
425
426 #
427 # SCSI host adapters:
428 #
429 # ncv: NCR 53C500 based SCSI host adapters.
430 # nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
431 # stg: TMC 18C30, 18C50 based SCSI host adapters.
432
433 device ncv
434 device nsp
435 device stg
436
437 #
438 # Adaptec FSA RAID controllers, including integrated DELL controllers,
439 # the Dell PERC 2/QC and the HP NetRAID-4M
440 device aac
441 device aacp # SCSI Passthrough interface (optional, CAM required)
442
443 #
444 # Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming families
445 device aacraid # Container interface, CAM required
446
447 #
448 # Highpoint RocketRAID 27xx.
449 device hpt27xx
450
451 #
452 # Highpoint RocketRAID 182x.
453 device hptmv
454
455 #
456 # Highpoint DC7280 and R750.
457 device hptnr
458
459 #
460 # Highpoint RocketRAID. Supports RR172x, RR222x, RR2240, RR232x, RR2340,
461 # RR2210, RR174x, RR2522, RR231x, RR230x.
462 device hptrr
463
464 #
465 # Highpoint RocketRaid 3xxx series SATA RAID
466 device hptiop
467
468 #
469 # IBM (now Adaptec) ServeRAID controllers
470 device ips
471
472 #
473 # Intel C600 (Patsburg) integrated SAS controller
474 device isci
475 options ISCI_LOGGING # enable debugging in isci HAL
476
477 #
478 # NVM Express (NVMe) support
479 device nvme # base NVMe driver
480 device nvd # expose NVMe namespaces as disks, depends on nvme
481
482 #
483 # PMC-Sierra SAS/SATA controller
484 device pmspcv
485
486 #
487 # SafeNet crypto driver: can be moved to the MI NOTES as soon as
488 # it's tested on a big-endian machine
489 #
490 device safe # SafeNet 1141
491 options SAFE_DEBUG # enable debugging support: hw.safe.debug
492 options SAFE_RNDTEST # enable rndtest support
493
494 #
495 # VirtIO support
496 #
497 # The virtio entry provides a generic bus for use by the device drivers.
498 # It must be combined with an interface that communicates with the host.
499 # Multiple such interfaces are defined by the VirtIO specification. FreeBSD
500 # only has support for PCI. Therefore, virtio_pci must be statically
501 # compiled in or loaded as a module for the device drivers to function.
502 #
503 device virtio # Generic VirtIO bus (required)
504 device virtio_pci # VirtIO PCI Interface
505 device vtnet # VirtIO Ethernet device
506 device virtio_blk # VirtIO Block device
507 device virtio_scsi # VirtIO SCSI device
508 device virtio_balloon # VirtIO Memory Balloon device
509 device virtio_random # VirtIO Entropy device
510 device virtio_console # VirtIO Console device
511
512 # Microsoft Hyper-V enhancement support
513 device hyperv # HyperV drivers
514
515 # Xen HVM Guest Optimizations
516 options XENHVM # Xen HVM kernel infrastructure
517 device xenpci # Xen HVM Hypervisor services driver
518
519 #####################################################################
520
521 #
522 # Miscellaneous hardware:
523 #
524 # ipmi: Intelligent Platform Management Interface
525 # pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
526 # smbios: DMI/SMBIOS entry point
527 # vpd: Vital Product Data kernel interface
528 # asmc: Apple System Management Controller
529 # si: Specialix International SI/XIO or SX intelligent serial card
530 # tpm: Trusted Platform Module
531
532 # Notes on the Specialix SI/XIO driver:
533 # The host card is memory, not IO mapped.
534 # The Rev 1 host cards use a 64K chunk, on a 32K boundary.
535 # The Rev 2 host cards use a 32K chunk, on a 32K boundary.
536 # The cards can use an IRQ of 11, 12 or 15.
537
538 device ipmi
539 device pbio
540 hint.pbio.0.at="isa"
541 hint.pbio.0.port="0x360"
542 device smbios
543 device vpd
544 device asmc
545 device si
546 device tpm
547 device padlock_rng # VIA Padlock RNG
548 device rdrand_rng # Intel Bull Mountain RNG
549 device aesni # AES-NI OpenCrypto module
550 device ioat # Intel I/OAT DMA engine
551
552 #
553 # Laptop/Notebook options:
554 #
555
556
557 #
558 # I2C Bus
559 #
560
561 #
562 # Hardware watchdog timers:
563 #
564 # ichwd: Intel ICH watchdog timer
565 # amdsbwd: AMD SB7xx watchdog timer
566 # viawd: VIA south bridge watchdog timer
567 # wbwd: Winbond watchdog timer
568 #
569 device ichwd
570 device amdsbwd
571 device viawd
572 device wbwd
573
574 #
575 # Temperature sensors:
576 #
577 # coretemp: on-die sensor on Intel Core and newer CPUs
578 # amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
579 #
580 device coretemp
581 device amdtemp
582
583 #
584 # CPU control pseudo-device. Provides access to MSRs, CPUID info and
585 # microcode update feature.
586 #
587 device cpuctl
588
589 #
590 # System Management Bus (SMB)
591 #
592 options ENABLE_ALART # Control alarm on Intel intpm driver
593
594 #
595 # Number of initial kernel page table pages used for early bootstrap.
596 # This number should include enough pages to map the kernel and any
597 # modules or other data loaded with the kernel by the loader. Each
598 # page table page maps 2MB.
599 #
600 options NKPT=31
601
602
603 #####################################################################
604 # ABI Emulation
605
606 #XXX keep these here for now and reactivate when support for emulating
607 #XXX these 32 bit binaries is added.
608
609 # Enable 32-bit runtime support for FreeBSD/i386 binaries.
610 options COMPAT_FREEBSD32
611
612 # Enable iBCS2 runtime support for SCO and ISC binaries
613 #XXX#options IBCS2
614
615 # Emulate spx device for client side of SVR3 local X interface
616 #XXX#options SPX_HACK
617
618 # Enable 64-bit runtime support for CloudABI binaries.
619 options COMPAT_CLOUDABI64
620
621 # Enable Linux ABI emulation
622 #XXX#options COMPAT_LINUX
623
624 # Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_FREEBSD32)
625 options COMPAT_LINUX32
626
627 # Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
628 # and PSEUDOFS)
629 options LINPROCFS
630
631 #Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
632 # and PSEUDOFS)
633 options LINSYSFS
634
635 #
636 # SysVR4 ABI emulation
637 #
638 # The svr4 ABI emulator can be statically compiled into the kernel or loaded as
639 # a KLD module.
640 # The STREAMS network emulation code can also be compiled statically or as a
641 # module. If loaded as a module, it must be loaded before the svr4 module
642 # (the /usr/sbin/svr4 script does this for you). If compiling statically,
643 # the `streams' device must be configured into any kernel which also
644 # specifies COMPAT_SVR4. It is possible to have a statically-configured
645 # STREAMS device and a dynamically loadable svr4 emulator; the /usr/sbin/svr4
646 # script understands that it doesn't need to load the `streams' module under
647 # those circumstances.
648 # Caveat: At this time, `options KTRACE' is required for the svr4 emulator
649 # (whether static or dynamic).
650 #
651 #XXX#options COMPAT_SVR4 # build emulator statically
652 #XXX#options DEBUG_SVR4 # enable verbose debugging
653 #XXX#device streams # STREAMS network driver (required for svr4).
654
655
656 #####################################################################
657 # VM OPTIONS
658
659 # KSTACK_PAGES is the number of memory pages to assign to the kernel
660 # stack of each thread.
661
662 options KSTACK_PAGES=5
663
664 # Enable detailed accounting by the PV entry allocator.
665
666 options PV_STATS
667
668 #####################################################################
669
670 # More undocumented options for linting.
671 # Note that documenting these are not considered an affront.
672
673 options FB_INSTALL_CDEV # install a CDEV entry in /dev
674
675 options KBDIO_DEBUG=2
676 options KBD_MAXRETRY=4
677 options KBD_MAXWAIT=6
678 options KBD_RESETDELAY=201
679
680 options PSM_DEBUG=1
681
682 options TIMER_FREQ=((14318182+6)/12)
683
684 options VM_KMEM_SIZE
685 options VM_KMEM_SIZE_MAX
686 options VM_KMEM_SIZE_SCALE
687
688 # Enable NDIS binary driver support
689 options NDISAPI
690 device ndis
Cache object: 4ff332dd325802a023e21d3c3438cdc4
|