]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/amd64/conf/NOTES
Import DTS files from Linux 5.0
[FreeBSD/FreeBSD.git] / 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$
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 \f
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 \f
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 \f
77 #####################################################################
78 # NETWORKING OPTIONS
79
80 #
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).
93 #
94 # Not all device drivers support this mode of operation at the time of
95 # this writing.  See polling(4) for more details.
96
97 options         DEVICE_POLLING
98
99 # BPF_JITTER adds support for BPF just-in-time compiler.
100
101 options         BPF_JITTER
102
103 # OpenFabrics Enterprise Distribution (Infiniband).
104 options         OFED
105 options         OFED_DEBUG_INIT
106
107 # Sockets Direct Protocol
108 options         SDP
109 options         SDP_DEBUG
110
111 # IP over Infiniband
112 options         IPOIB
113 options         IPOIB_DEBUG
114 options         IPOIB_CM
115
116 \f
117 #####################################################################
118 # CLOCK OPTIONS
119
120 # Provide read/write access to the memory in the clock chip.
121 device          nvram           # Access to rtc cmos via /dev/nvram
122
123 \f
124 #####################################################################
125 # MISCELLANEOUS DEVICES AND OPTIONS
126
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!
131
132 \f
133 #####################################################################
134 # HARDWARE BUS CONFIGURATION
135
136 #
137 # ISA bus
138 #
139 device          isa
140
141 #
142 # Options for `isa':
143 #
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.
147 #
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
152 # versions.
153 #
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).
162 #
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.
166
167 options         AUTO_EOI_1
168 #options        AUTO_EOI_2
169
170 options         MAXMEM=(128*1024)
171 #options        BROKEN_KEYBOARD_RESET
172
173 #
174 # AGP GART support
175 device          agp
176
177 #
178 # AGP debugging.
179 #
180 options         AGP_DEBUG
181
182 \f
183 #####################################################################
184 # HARDWARE DEVICE CONFIGURATION
185
186 # To include support for VGA VESA video modes
187 options         VESA
188
189 # Turn on extra debugging checks and output for VESA support.
190 options         VESA_DEBUG
191
192 device          dpms            # DPMS suspend & resume via VESA BIOS
193
194 # x86 real mode BIOS emulator, required by atkbdc/dpms/vesa
195 options         X86BIOS
196
197 #
198 # Optional devices:
199 #
200
201 # PS/2 mouse
202 device          psm
203 hint.psm.0.at="atkbdc"
204 hint.psm.0.irq="12"
205
206 # Options for psm:
207 options         PSM_HOOKRESUME          #hook the system resume event, useful
208                                         #for some laptops
209 options         PSM_RESETAFTERSUSPEND   #reset the device at the resume event
210
211 # The keyboard controller; it controls the keyboard and the PS/2 mouse.
212 device          atkbdc
213 hint.atkbdc.0.at="isa"
214 hint.atkbdc.0.port="0x060"
215
216 # The AT keyboard
217 device          atkbd
218 hint.atkbd.0.at="atkbdc"
219 hint.atkbd.0.irq="1"
220
221 # Options for atkbd:
222 options         ATKBD_DFLT_KEYMAP       # specify the built-in keymap
223 makeoptions     ATKBD_DFLT_KEYMAP=fr.dvorak
224
225 # `flags' for atkbd:
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
229 #               dockingstations
230 #       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
231
232 # Video card driver for VGA adapters.
233 device          vga
234 hint.vga.0.at="isa"
235
236 # Options for vga:
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
239 # some systems.
240 options         VGA_ALT_SEQACCESS
241
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
246
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
249
250 # The following option probably won't work with the LCD displays.
251 options         VGA_WIDTH90             # support 90 column modes
252
253 # Debugging.
254 options         VGA_DEBUG
255
256 # vt(4) drivers.
257 device          vt_vga          # VGA
258 device          vt_efifb        # EFI framebuffer
259
260 # Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA.
261 device          s3pci
262
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.
267 #
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.
270
271 device          tdfx                    # Enable 3Dfx Voodoo support
272 #XXX#device     tdfx_linux              # Enable Linuxulator support
273
274 #
275 # ACPI support using the Intel ACPI Component Architecture reference
276 # implementation.
277 #
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).
282
283 device          acpi
284 options         ACPI_DEBUG
285
286 # The cpufreq(4) driver provides support for non-ACPI CPU frequency control
287 device          cpufreq
288
289 #
290 # Network interfaces:
291 #
292
293 # bxe:  Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
294 #       adapters.
295 # ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
296 #       HP PC Lan+, various PC Card devices
297 #       (requires miibus)
298 # ipw:  Intel PRO/Wireless 2100 IEEE 802.11 adapter
299 #       Requires the ipw firmware module
300 # iwi:  Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
301 #       Requires the iwi firmware module
302 # iwn:  Intel Wireless WiFi Link 1000/105/135/2000/4965/5000/6000/6050 abgn
303 #       802.11 network adapters
304 #       Requires the iwn firmware module
305 # mthca: Mellanox HCA InfiniBand
306 # mlx4ib: Mellanox ConnectX HCA InfiniBand
307 # mlx4en: Mellanox ConnectX HCA Ethernet
308 # nfe:  nVidia nForce MCP on-board Ethernet Networking (BSD open source)
309 # sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters
310 # vmx:  VMware VMXNET3 Ethernet (BSD open source)
311 # wpi:  Intel 3945ABG Wireless LAN controller
312 #       Requires the wpi firmware module
313
314 device          bxe             # Broadcom NetXtreme II BCM5771X/BCM578XX 10GbE
315 device          ed              # NE[12]000, SMC Ultra, 3c503, DS8390 cards
316 options         ED_3C503
317 options         ED_HPP
318 options         ED_SIC
319 device          ipw             # Intel 2100 wireless NICs.
320 device          iwi             # Intel 2200BG/2225BG/2915ABG wireless NICs.
321 device          iwn             # Intel 4965/1000/5000/6000 wireless NICs.
322 device          ixl             # Intel 700 Series Physical Function
323 device          iavf            # Intel Adaptive Virtual Function
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
333 # IEEE 802.11 adapter firmware modules
334
335 # Intel PRO/Wireless 2100 firmware:
336 #   ipwfw:              BSS/IBSS/monitor mode firmware
337 #   ipwbssfw:           BSS mode firmware
338 #   ipwibssfw:          IBSS mode firmware
339 #   ipwmonitorfw:       Monitor mode firmware
340 # Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware:
341 #   iwifw:              BSS/IBSS/monitor mode firmware
342 #   iwibssfw:           BSS mode firmware
343 #   iwiibssfw:          IBSS mode firmware
344 #   iwimonitorfw:       Monitor mode firmware
345 # Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware:
346 #   iwnfw:              Single module to support all devices
347 #   iwn1000fw:          Specific module for the 1000 only
348 #   iwn105fw:           Specific module for the 105 only
349 #   iwn135fw:           Specific module for the 135 only
350 #   iwn2000fw:          Specific module for the 2000 only
351 #   iwn2030fw:          Specific module for the 2030 only
352 #   iwn4965fw:          Specific module for the 4965 only
353 #   iwn5000fw:          Specific module for the 5000 only
354 #   iwn5150fw:          Specific module for the 5150 only
355 #   iwn6000fw:          Specific module for the 6000 only
356 #   iwn6000g2afw:       Specific module for the 6000g2a only
357 #   iwn6000g2bfw:       Specific module for the 6000g2b only
358 #   iwn6050fw:          Specific module for the 6050 only
359 # wpifw:        Intel 3945ABG Wireless LAN Controller firmware
360
361 device          iwifw
362 device          iwibssfw
363 device          iwiibssfw
364 device          iwimonitorfw
365 device          ipwfw
366 device          ipwbssfw
367 device          ipwibssfw
368 device          ipwmonitorfw
369 device          iwnfw
370 device          iwn1000fw
371 device          iwn105fw
372 device          iwn135fw
373 device          iwn2000fw
374 device          iwn2030fw
375 device          iwn4965fw
376 device          iwn5000fw
377 device          iwn5150fw
378 device          iwn6000fw
379 device          iwn6000g2afw
380 device          iwn6000g2bfw
381 device          iwn6050fw
382 device          wpifw
383
384 #
385 # Non-Transparent Bridge (NTB) drivers
386 #
387 device          if_ntb          # Virtual NTB network interface
388 device          ntb_transport   # NTB packet transport driver
389 device          ntb             # NTB hardware interface
390 device          ntb_hw_intel    # Intel NTB hardware driver
391 device          ntb_hw_plx      # PLX NTB hardware driver
392
393 #
394 #XXX this stores pointers in a 32bit field that is defined by the hardware
395 #device pst
396
397 #
398 # Areca 11xx and 12xx series of SATA II RAID controllers.
399 # CAM is required.
400 #
401 device          arcmsr          # Areca SATA II RAID
402
403 #
404 # Microsemi smartpqi controllers.
405 # These controllers have a SCSI-like interface, and require the
406 # CAM infrastructure.
407 #
408 device          smartpqi
409
410 #
411 # 3ware 9000 series PATA/SATA RAID controller driver and options.
412 # The driver is implemented as a SIM, and so, needs the CAM infrastructure.
413 #
414 options         TWA_DEBUG               # 0-10; 10 prints the most messages.
415 device          twa                     # 3ware 9000 series PATA/SATA RAID
416
417 #
418 # Adaptec FSA RAID controllers, including integrated DELL controllers,
419 # the Dell PERC 2/QC and the HP NetRAID-4M
420 device          aac
421 device          aacp    # SCSI Passthrough interface (optional, CAM required)
422
423 #
424 # Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming families
425 device          aacraid         # Container interface, CAM required
426
427 #
428 # Highpoint RocketRAID 27xx.
429 device          hpt27xx
430
431 #
432 # Highpoint RocketRAID 182x.
433 device          hptmv
434
435 #
436 # Highpoint DC7280 and R750.
437 device          hptnr
438
439 #
440 # Highpoint RocketRAID.  Supports RR172x, RR222x, RR2240, RR232x, RR2340,
441 # RR2210, RR174x, RR2522, RR231x, RR230x.
442 device          hptrr
443
444 #
445 # Highpoint RocketRaid 3xxx series SATA RAID
446 device          hptiop
447
448 #
449 # IBM (now Adaptec) ServeRAID controllers
450 device          ips
451
452 #
453 # Intel integrated Memory Controller (iMC) SMBus controller
454 #       Sandybridge-Xeon, Ivybridge-Xeon, Haswell-Xeon, Broadwell-Xeon
455 device          imcsmb
456
457 #
458 # Intel C600 (Patsburg) integrated SAS controller
459 device          isci
460 options         ISCI_LOGGING    # enable debugging in isci HAL
461
462 # LSI-Logic MPT-Fusion drivers
463 device          mpt                     # LSI-Logic MPT-Fusion
464 device          mps                     # LSI-Logic MPT-Fusion 2
465 device          mpr                     # LSI-Logic MPT-Fusion 3
466
467 #
468 # NVM Express (NVMe) support
469 device         nvme    # base NVMe driver
470 device         nvd     # expose NVMe namespaces as disks, depends on nvme
471
472 #
473 # PMC-Sierra SAS/SATA controller
474 device          pmspcv
475
476 #
477 # SafeNet crypto driver: can be moved to the MI NOTES as soon as
478 # it's tested on a big-endian machine
479 #
480 device          safe            # SafeNet 1141
481 options         SAFE_DEBUG      # enable debugging support: hw.safe.debug
482 options         SAFE_RNDTEST    # enable rndtest support
483
484 #
485 # VirtIO support
486 #
487 # The virtio entry provides a generic bus for use by the device drivers.
488 # It must be combined with an interface that communicates with the host.
489 # Multiple such interfaces are defined by the VirtIO specification. FreeBSD
490 # only has support for PCI. Therefore, virtio_pci must be statically
491 # compiled in or loaded as a module for the device drivers to function.
492 #
493 device          virtio          # Generic VirtIO bus (required)
494 device          virtio_pci      # VirtIO PCI Interface
495 device          vtnet           # VirtIO Ethernet device
496 device          virtio_blk      # VirtIO Block device
497 device          virtio_scsi     # VirtIO SCSI device
498 device          virtio_balloon  # VirtIO Memory Balloon device
499 device          virtio_random   # VirtIO Entropy device
500 device          virtio_console  # VirtIO Console device
501
502 # Microsoft Hyper-V enhancement support
503 device          hyperv          # HyperV drivers
504
505 # Xen HVM Guest Optimizations
506 options         XENHVM          # Xen HVM kernel infrastructure
507 device          xenpci          # Xen HVM Hypervisor services driver
508
509 #####################################################################
510
511 #
512 # Miscellaneous hardware:
513 #
514 # ipmi: Intelligent Platform Management Interface
515 # pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
516 # smbios: DMI/SMBIOS entry point
517 # vpd: Vital Product Data kernel interface
518 # asmc: Apple System Management Controller
519 # si: Specialix International SI/XIO or SX intelligent serial card
520 # tpm: Trusted Platform Module
521
522 # Notes on the Specialix SI/XIO driver:
523 #  The host card is memory, not IO mapped.
524 #  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
525 #  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
526 #  The cards can use an IRQ of 11, 12 or 15.
527
528 device          ipmi
529 device          pbio
530 hint.pbio.0.at="isa"
531 hint.pbio.0.port="0x360"
532 device          smbios
533 device          vpd
534 device          asmc
535 device          tpm
536 device          padlock_rng     # VIA Padlock RNG
537 device          rdrand_rng      # Intel Bull Mountain RNG
538 device          aesni           # AES-NI OpenCrypto module
539 device          ioat            # Intel I/OAT DMA engine
540
541 #
542 # Laptop/Notebook options:
543 #
544
545
546 #
547 # I2C Bus
548 #
549
550 #
551 # Hardware watchdog timers:
552 #
553 # ichwd: Intel ICH watchdog timer
554 # amdsbwd: AMD SB7xx watchdog timer
555 # viawd: VIA south bridge watchdog timer
556 # wbwd: Winbond watchdog timer
557 #
558 device          ichwd
559 device          amdsbwd
560 device          viawd
561 device          wbwd
562
563 #
564 # Temperature sensors:
565 #
566 # coretemp: on-die sensor on Intel Core and newer CPUs
567 # amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
568 #
569 device          coretemp
570 device          amdtemp
571
572 #
573 # CPU control pseudo-device. Provides access to MSRs, CPUID info and
574 # microcode update feature.
575 #
576 device          cpuctl
577
578 #
579 # System Management Bus (SMB)
580 #
581 options         ENABLE_ALART            # Control alarm on Intel intpm driver
582
583 #
584 # AMD System Management Network (SMN)
585 #
586 device          amdsmn
587
588 #
589 # Number of initial kernel page table pages used for early bootstrap.
590 # This number should include enough pages to map the kernel and any
591 # modules or other data loaded with the kernel by the loader.  Each
592 # page table page maps 2MB.
593 #
594 options         NKPT=31
595
596 # EFI Runtime Services support
597 options         EFIRT
598
599 \f
600 #####################################################################
601 # ABI Emulation
602
603 #XXX keep these here for now and reactivate when support for emulating
604 #XXX these 32 bit binaries is added.
605
606 # Enable 32-bit runtime support for FreeBSD/i386 binaries.
607 options         COMPAT_FREEBSD32
608
609 # Enable (32-bit) a.out binary support
610 options         COMPAT_AOUT
611
612 # Enable 32-bit runtime support for CloudABI binaries.
613 options         COMPAT_CLOUDABI32
614
615 # Enable 64-bit runtime support for CloudABI binaries.
616 options         COMPAT_CLOUDABI64
617
618 # Enable Linux ABI emulation
619 #XXX#options    COMPAT_LINUX
620
621 # Enable 32-bit Linux ABI emulation (requires COMPAT_FREEBSD32).
622 options         COMPAT_LINUX32
623
624 # Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
625 # and PSEUDOFS)
626 options         LINPROCFS
627
628 #Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
629 # and PSEUDOFS)
630 options         LINSYSFS
631
632 #####################################################################
633 # ZFS support
634
635 options         ZFS
636
637 #####################################################################
638 # VM OPTIONS
639
640 # KSTACK_PAGES is the number of memory pages to assign to the kernel
641 # stack of each thread.
642
643 options         KSTACK_PAGES=5
644
645 # Enable detailed accounting by the PV entry allocator.
646
647 options         PV_STATS
648
649 #####################################################################
650
651 # More undocumented options for linting.
652 # Note that documenting these are not considered an affront.
653
654 options         FB_INSTALL_CDEV         # install a CDEV entry in /dev
655
656 options         KBDIO_DEBUG=2
657 options         KBD_MAXRETRY=4
658 options         KBD_MAXWAIT=6
659 options         KBD_RESETDELAY=201
660
661 options         PSM_DEBUG=1
662
663 options         TIMER_FREQ=((14318182+6)/12)
664
665 options         VM_KMEM_SIZE
666 options         VM_KMEM_SIZE_MAX
667 options         VM_KMEM_SIZE_SCALE
668
669 # Enable NDIS binary driver support
670 options         NDISAPI
671 device          ndis
672
673
674 # GCOV (code coverage) support
675
676 options         LINDEBUGFS
677 options         GCOV