]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/amd64/conf/NOTES
NOTES: Move OFED options to MI NOTES
[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 #
8
9 #
10 # Enable the kernel DTrace hooks which are required to load the DTrace
11 # kernel modules.
12 #
13 options         KDTRACE_HOOKS
14
15 # DTrace core
16 # NOTE: introduces CDDL-licensed components into the kernel
17 #device         dtrace
18
19 # DTrace modules
20 #device         dtrace_profile
21 #device         dtrace_sdt
22 #device         dtrace_fbt
23 #device         dtrace_systrace
24 #device         dtrace_prototype
25 #device         dtnfscl
26 #device         dtmalloc
27
28 # Alternatively include all the DTrace modules
29 #device         dtraceall
30
31 \f
32 #####################################################################
33 # SMP OPTIONS:
34 #
35 # Notes:
36 #
37 # IPI_PREEMPTION instructs the kernel to preempt threads running on other
38 #         CPUS if needed.  Relies on the PREEMPTION option
39
40 # Optional:
41 options         IPI_PREEMPTION
42 device          atpic                   # Optional legacy pic support
43 device          mptable                 # Optional MPSPEC mptable support
44
45 # Debugging options.
46 #
47 options         COUNT_XINVLTLB_HITS     # Counters for TLB events
48 options         COUNT_IPIS              # Per-CPU IPI interrupt counters
49
50
51 \f
52 #####################################################################
53 # CPU OPTIONS
54
55 #
56 # You must specify at least one CPU (the one you intend to run on);
57 # deleting the specification for CPUs you don't need to use may make
58 # parts of the system run faster.
59 #
60 cpu             HAMMER                  # aka K8, aka Opteron & Athlon64
61
62 #
63 # Options for CPU features.
64 #
65
66 \f
67 #####################################################################
68 # NETWORKING OPTIONS
69
70 #
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).
83 #
84 # Not all device drivers support this mode of operation at the time of
85 # this writing.  See polling(4) for more details.
86
87 options         DEVICE_POLLING
88
89 # BPF_JITTER adds support for BPF just-in-time compiler.
90
91 options         BPF_JITTER
92
93 \f
94 #####################################################################
95 # CLOCK OPTIONS
96
97 # Provide read/write access to the memory in the clock chip.
98 device          nvram           # Access to rtc cmos via /dev/nvram
99
100 \f
101 #####################################################################
102 # MISCELLANEOUS DEVICES AND OPTIONS
103
104 device          speaker         #Play IBM BASIC-style noises out your speaker
105 envvar          hint.speaker.0.at="isa"
106 envvar          hint.speaker.0.port="0x61"
107
108 \f
109 #####################################################################
110 # HARDWARE BUS CONFIGURATION
111
112 #
113 # ISA bus
114 #
115 device          isa
116
117 #
118 # Options for `isa':
119 #
120 # AUTO_EOI_1 enables the `automatic EOI' feature for the master 8259A
121 # interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
122 # This option breaks suspend/resume on some portables.
123 #
124 # AUTO_EOI_2 enables the `automatic EOI' feature for the slave 8259A
125 # interrupt controller.  This saves about 0.7-1.25 usec for each interrupt.
126 # Automatic EOI is documented not to work for the slave with the
127 # original i8259A, but it works for some clones and some integrated
128 # versions.
129 #
130 # MAXMEM specifies the amount of RAM on the machine; if this is not
131 # specified, FreeBSD will first read the amount of memory from the CMOS
132 # RAM, so the amount of memory will initially be limited to 64MB or 16MB
133 # depending on the BIOS.  If the BIOS reports 64MB, a memory probe will
134 # then attempt to detect the installed amount of RAM.  If this probe
135 # fails to detect >64MB RAM you will have to use the MAXMEM option.
136 # The amount is in kilobytes, so for a machine with 128MB of RAM, it would
137 # be 131072 (128 * 1024).
138 #
139 # BROKEN_KEYBOARD_RESET disables the use of the keyboard controller to
140 # reset the CPU for reboot.  This is needed on some systems with broken
141 # keyboard controllers.
142
143 options         AUTO_EOI_1
144 #options        AUTO_EOI_2
145
146 options         MAXMEM=(128*1024)
147 #options        BROKEN_KEYBOARD_RESET
148
149 #
150 # AGP GART support
151 device          agp
152
153 #
154 # AGP debugging.
155 #
156 options         AGP_DEBUG
157
158 \f
159 #####################################################################
160 # HARDWARE DEVICE CONFIGURATION
161
162 # To include support for VGA VESA video modes
163 options         VESA
164
165 # Turn on extra debugging checks and output for VESA support.
166 options         VESA_DEBUG
167
168 device          dpms            # DPMS suspend & resume via VESA BIOS
169
170 # x86 real mode BIOS emulator, required by atkbdc/dpms/vesa
171 options         X86BIOS
172
173 #
174 # Optional devices:
175 #
176
177 # PS/2 mouse
178 device          psm
179 envvar          hint.psm.0.at="atkbdc"
180 envvar          hint.psm.0.irq="12"
181
182 # Options for psm:
183 options         PSM_HOOKRESUME          #hook the system resume event, useful
184                                         #for some laptops
185 options         PSM_RESETAFTERSUSPEND   #reset the device at the resume event
186
187 # The keyboard controller; it controls the keyboard and the PS/2 mouse.
188 device          atkbdc
189 envvar          hint.atkbdc.0.at="isa"
190 envvar          hint.atkbdc.0.port="0x060"
191
192 # The AT keyboard
193 device          atkbd
194 envvar          hint.atkbd.0.at="atkbdc"
195 envvar          hint.atkbd.0.irq="1"
196
197 # Options for atkbd:
198 options         ATKBD_DFLT_KEYMAP       # specify the built-in keymap
199 makeoptions     ATKBD_DFLT_KEYMAP=fr.dvorak
200
201 # `flags' for atkbd:
202 #       0x01    Force detection of keyboard, else we always assume a keyboard
203 #       0x02    Don't reset keyboard, useful for some newer ThinkPads
204 #       0x03    Force detection and avoid reset, might help with certain
205 #               dockingstations
206 #       0x04    Old-style (XT) keyboard support, useful for older ThinkPads
207
208 # Video card driver for VGA adapters.
209 device          vga
210 envvar          hint.vga.0.at="isa"
211
212 # Options for vga:
213 # Try the following option if the mouse pointer is not drawn correctly
214 # or font does not seem to be loaded properly.  May cause flicker on
215 # some systems.
216 options         VGA_ALT_SEQACCESS
217
218 # If you can dispense with some vga driver features, you may want to
219 # use the following options to save some memory.
220 #options        VGA_NO_FONT_LOADING     # don't save/load font
221 #options        VGA_NO_MODE_CHANGE      # don't change video modes
222
223 # Older video cards may require this option for proper operation.
224 options         VGA_SLOW_IOACCESS       # do byte-wide i/o's to TS and GDC regs
225
226 # The following option probably won't work with the LCD displays.
227 options         VGA_WIDTH90             # support 90 column modes
228
229 # Debugging.
230 options         VGA_DEBUG
231
232 # vt(4) drivers.
233 device          vt_vga          # VGA
234 device          vt_efifb        # EFI framebuffer
235 device          vt_vbefb        # VBE framebuffer
236
237 # Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA.
238 device          s3pci
239
240 # 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support.  This will create
241 # the /dev/3dfx0 device to work with glide implementations.  This should get
242 # linked to /dev/3dfx and /dev/voodoo.  Note that this is not the same as
243 # the tdfx DRI module from XFree86 and is completely unrelated.
244 #
245
246 device          tdfx                    # Enable 3Dfx Voodoo support
247
248 #
249 # ACPI support using the Intel ACPI Component Architecture reference
250 # implementation.
251 #
252 # ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
253 # kernel environment variables to select initial debugging levels for the
254 # Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
255 # defined when it is built).
256
257 device          acpi
258 options         ACPI_DEBUG
259
260 # The cpufreq(4) driver provides support for non-ACPI CPU frequency control
261 device          cpufreq
262
263 #
264 # Network interfaces:
265 #
266
267 # axp: AMD EPYC integrated NIC
268 #       Requires the miibus module
269 # bxe:  Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
270 #       adapters.
271 # ice:  Intel 800 Series Physical Function
272 #       Requires the ice_ddp module for full functionality
273 # igc:  Intel I225 2.5Gb Ethernet adapter
274 # ipw:  Intel PRO/Wireless 2100 IEEE 802.11 adapter
275 #       Requires the ipw firmware module
276 # irdma: Intel 800 Series RDMA driver
277 #        Requires the ice module
278 # iwi:  Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
279 #       Requires the iwi firmware module
280 # iwn:  Intel Wireless WiFi Link 1000/105/135/2000/4965/5000/6000/6050 abgn
281 #       802.11 network adapters
282 #       Requires the iwn firmware module
283 # mthca: Mellanox HCA InfiniBand
284 # mlx4ib: Mellanox ConnectX HCA InfiniBand
285 # mlx4en: Mellanox ConnectX HCA Ethernet
286 # nfe:  nVidia nForce MCP on-board Ethernet Networking (BSD open source)
287 # qlxgb: QLogic 3200 and 8200 series 10 Gigabit Ethernet & CNA Adapter
288 # qlxgbe: QLogic 8300 series 10 Gigabit Ethernet & CNA Adapter
289 # qlxge: QLogic 8100 series 10 Gigabit Ethernet & CNA Adapter
290 # qlnxe: Cavium QLogic 41000/45000 series 10/25/40/100 Gigabit Ethernet & CNA Adapter
291 # sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters
292 # vmx:  VMware VMXNET3 Ethernet (BSD open source)
293 # wpi:  Intel 3945ABG Wireless LAN controller
294 #       Requires the wpi firmware module
295
296 device          axp             # AMD EPYC integrated NIC
297 device          bxe             # Broadcom NetXtreme II BCM5771X/BCM578XX 10GbE
298 device          igc             # Intel I225 2.5G Ethernet
299 device          ipw             # Intel 2100 wireless NICs.
300 device          iwi             # Intel 2200BG/2225BG/2915ABG wireless NICs.
301 device          iwn             # Intel 4965/1000/5000/6000 wireless NICs.
302 device          ixl             # Intel 700 Series Physical Function
303 device          iavf            # Intel Adaptive Virtual Function
304 device          ice             # Intel 800 Series Physical Function
305 device          ice_ddp         # Intel 800 Series DDP Package
306 device          irdma           # Intel 800 Series RDMA driver
307 device          mthca           # Mellanox HCA InfiniBand
308 device          mlx4            # Shared code module between IB and Ethernet
309 device          mlx4ib          # Mellanox ConnectX HCA InfiniBand
310 device          mlx4en          # Mellanox ConnectX HCA Ethernet
311 device          nfe             # nVidia nForce MCP on-board Ethernet
312 device          qlxgb           # QLogic 3200/8200 Ethernet
313 device          qlxgbe          # QLogic 8300 Ethernet
314 device          qlxge           # QLogic 8100 Ethernet
315 device          qlnxe           # QLogic 41000/45000 Ethernet
316 device          sfxge           # Solarflare SFC9000 10Gb Ethernet
317 device          vmx             # VMware VMXNET3 Ethernet
318 device          wpi             # Intel 3945ABG wireless NICs.
319
320 # IEEE 802.11 adapter firmware modules
321
322 # Intel PRO/Wireless 2100 firmware:
323 #   ipwfw:              BSS/IBSS/monitor mode firmware
324 #   ipwbssfw:           BSS mode firmware
325 #   ipwibssfw:          IBSS mode firmware
326 #   ipwmonitorfw:       Monitor mode firmware
327 # Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware:
328 #   iwifw:              BSS/IBSS/monitor mode firmware
329 #   iwibssfw:           BSS mode firmware
330 #   iwiibssfw:          IBSS mode firmware
331 #   iwimonitorfw:       Monitor mode firmware
332 # Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware:
333 #   iwnfw:              Single module to support all devices
334 #   iwn1000fw:          Specific module for the 1000 only
335 #   iwn105fw:           Specific module for the 105 only
336 #   iwn135fw:           Specific module for the 135 only
337 #   iwn2000fw:          Specific module for the 2000 only
338 #   iwn2030fw:          Specific module for the 2030 only
339 #   iwn4965fw:          Specific module for the 4965 only
340 #   iwn5000fw:          Specific module for the 5000 only
341 #   iwn5150fw:          Specific module for the 5150 only
342 #   iwn6000fw:          Specific module for the 6000 only
343 #   iwn6000g2afw:       Specific module for the 6000g2a only
344 #   iwn6000g2bfw:       Specific module for the 6000g2b only
345 #   iwn6050fw:          Specific module for the 6050 only
346 # wpifw:        Intel 3945ABG Wireless LAN Controller firmware
347
348 device          iwifw
349 device          iwibssfw
350 device          iwiibssfw
351 device          iwimonitorfw
352 device          ipwfw
353 device          ipwbssfw
354 device          ipwibssfw
355 device          ipwmonitorfw
356 device          iwnfw
357 device          iwn1000fw
358 device          iwn105fw
359 device          iwn135fw
360 device          iwn2000fw
361 device          iwn2030fw
362 device          iwn4965fw
363 device          iwn5000fw
364 device          iwn5150fw
365 device          iwn6000fw
366 device          iwn6000g2afw
367 device          iwn6000g2bfw
368 device          iwn6050fw
369 device          wpifw
370
371 # net80211 options
372 options         IEEE80211_DEBUG_REFCNT
373
374 #
375 # Non-Transparent Bridge (NTB) drivers
376 #
377 device          if_ntb          # Virtual NTB network interface
378 device          ntb_transport   # NTB packet transport driver
379 device          ntb             # NTB hardware interface
380 device          ntb_hw_amd      # AMD NTB hardware driver
381 device          ntb_hw_intel    # Intel NTB hardware driver
382 device          ntb_hw_plx      # PLX NTB hardware driver
383
384 #
385 #XXX this stores pointers in a 32bit field that is defined by the hardware
386 #device pst
387
388 #
389 # Areca 11xx and 12xx series of SATA II RAID controllers.
390 # CAM is required.
391 #
392 device          arcmsr          # Areca SATA II RAID
393
394 #
395 # Microsemi smartpqi controllers.
396 # These controllers have a SCSI-like interface, and require the
397 # CAM infrastructure.
398 #
399 device          smartpqi
400
401 #
402 # Adaptec FSA RAID controllers, including integrated DELL controllers,
403 # the Dell PERC 2/QC and the HP NetRAID-4M
404 device          aac
405 device          aacp    # SCSI Passthrough interface (optional, CAM required)
406
407 #
408 # Highpoint RocketRAID 27xx.
409 device          hpt27xx
410
411 #
412 # Highpoint RocketRAID 182x.
413 device          hptmv
414
415 #
416 # Highpoint DC7280 and R750.
417 device          hptnr
418
419 #
420 # Highpoint RocketRAID.  Supports RR172x, RR222x, RR2240, RR232x, RR2340,
421 # RR2210, RR174x, RR2522, RR231x, RR230x.
422 device          hptrr
423
424 #
425 # Highpoint RocketRaid 3xxx series SATA RAID
426 device          hptiop
427
428 #
429 # IBM (now Adaptec) ServeRAID controllers
430 device          ips
431
432 #
433 # Intel integrated Memory Controller (iMC) SMBus controller
434 #       Sandybridge-Xeon, Ivybridge-Xeon, Haswell-Xeon, Broadwell-Xeon
435 device          imcsmb
436
437 #
438 # Intel C600 (Patsburg) integrated SAS controller
439 device          isci
440 options         ISCI_LOGGING    # enable debugging in isci HAL
441
442 #
443 # NVM Express (NVMe) support
444 device         nvme    # base NVMe driver
445 device         nvd     # expose NVMe namespaces as disks, depends on nvme
446
447 #
448 # Intel Volume Management Device (VMD) support
449 device          vmd
450
451 #
452 # PMC-Sierra SAS/SATA controller
453 device          pmspcv
454
455 #
456 # Intel QuickAssist driver with OpenCrypto support
457 #
458 # Only for legacy Atom C2XXX chipsets.
459 device          qat_c2xxx
460
461 #
462 # SafeNet crypto driver: can be moved to the MI NOTES as soon as
463 # it's tested on a big-endian machine
464 #
465 device          safe            # SafeNet 1141
466 options         SAFE_DEBUG      # enable debugging support: hw.safe.debug
467 options         SAFE_RNDTEST    # enable rndtest support
468
469 #
470 # VirtIO support
471 #
472 # The virtio entry provides a generic bus for use by the device drivers.
473 # It must be combined with an interface that communicates with the host.
474 # Multiple such interfaces are defined by the VirtIO specification. FreeBSD
475 # only has support for PCI. Therefore, virtio_pci must be statically
476 # compiled in or loaded as a module for the device drivers to function.
477 #
478 device          virtio          # Generic VirtIO bus (required)
479 device          virtio_pci      # VirtIO PCI Interface
480 device          vtnet           # VirtIO Ethernet device
481 device          virtio_blk      # VirtIO Block device
482 device          virtio_scsi     # VirtIO SCSI device
483 device          virtio_balloon  # VirtIO Memory Balloon device
484 device          virtio_random   # VirtIO Entropy device
485 device          virtio_console  # VirtIO Console device
486
487 # Linux KVM paravirtualization support
488 device          kvm_clock       # KVM paravirtual clock driver
489
490 # Google Virtual NIC
491 device          gve             # Google Virtual NIC (gVNIC) driver
492
493 # Microsoft Hyper-V enhancement support
494 device          hyperv          # HyperV drivers
495 device          hvhid           # HyperV HID device
496
497 # Xen HVM Guest Optimizations
498 options         XENHVM          # Xen HVM kernel infrastructure
499 device          xenefi          # Xen EFI timer device
500 device          xenpci          # Xen HVM Hypervisor services driver
501 device          xentimer        # Xen x86 PV timer device
502
503 #####################################################################
504
505 #
506 # Miscellaneous hardware:
507 #
508 # ipmi: Intelligent Platform Management Interface
509 # pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
510 # smbios: DMI/SMBIOS entry point (requires EFIRT option)
511 # vpd: Vital Product Data kernel interface
512 # asmc: Apple System Management Controller
513 # si: Specialix International SI/XIO or SX intelligent serial card
514 # tpm: Trusted Platform Module
515
516 # Notes on the Specialix SI/XIO driver:
517 #  The host card is memory, not IO mapped.
518 #  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
519 #  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
520 #  The cards can use an IRQ of 11, 12 or 15.
521
522 device          ipmi
523 device          pbio
524 envvar          hint.pbio.0.at="isa"
525 envvar          hint.pbio.0.port="0x360"
526 device          smbios
527 device          vpd
528 device          asmc
529 device          tpm
530 device          padlock_rng     # VIA Padlock RNG
531 device          rdrand_rng      # Intel Bull Mountain RNG
532 device          aesni           # AES-NI OpenCrypto module
533 device          ossl            # OpenSSL OpenCrypto module
534 device          ioat            # Intel I/OAT DMA engine
535
536 #
537 # Laptop/Notebook options:
538 #
539
540 device backlight
541
542 #
543 # I2C Bus
544 #
545
546 #
547 # Hardware watchdog timers:
548 #
549 # ichwd: Intel ICH watchdog timer
550 # amdsbwd: AMD SB7xx watchdog timer
551 # viawd: VIA south bridge watchdog timer
552 # wbwd: Winbond watchdog timer
553 # itwd: ITE Super I/O watchdog timer
554 #
555 device          ichwd
556 device          amdsbwd
557 device          viawd
558 device          wbwd
559 device          itwd
560
561 #
562 # Temperature sensors:
563 #
564 # coretemp: on-die sensor on Intel Core and newer CPUs
565 # amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
566 #
567 device          coretemp
568 device          amdtemp
569
570 #
571 # CPU control pseudo-device. Provides access to MSRs, CPUID info and
572 # microcode update feature.
573 #
574 device          cpuctl
575
576 #
577 # SuperIO driver.
578 #
579 device          superio
580
581 #
582 # System Management Bus (SMB)
583 #
584 options         ENABLE_ALART            # Control alarm on Intel intpm driver
585
586 #
587 # AMD System Management Network (SMN)
588 #
589 device          amdsmn
590
591 #
592 # Number of initial kernel page table pages used for early bootstrap.
593 # This number should include enough pages to map the kernel and any
594 # modules or other data loaded with the kernel by the loader.  Each
595 # page table page maps 2MB.
596 #
597 options         NKPT=31
598
599 # EFI Runtime Services support
600 options         EFIRT
601
602 #
603 # HID-over-I2C support
604 #
605 device          iichid          # HID-over-I2C support
606 options         IICHID_DEBUG    # Enable HID-over-I2C debug messages
607 options         IICHID_SAMPLING # Workaround missing GPIO INTR support
608
609 #####################################################################
610 # ABI Emulation
611
612 #XXX keep these here for now and reactivate when support for emulating
613 #XXX these 32 bit binaries is added.
614
615 # Enable 32-bit runtime support for FreeBSD/i386 binaries.
616 options         COMPAT_FREEBSD32
617
618 # Enable (32-bit) a.out binary support
619 options         COMPAT_AOUT
620
621 #####################################################################
622 # ZFS support
623
624 # NB: This depends on crypto, cryptodev and ZSTDIO
625 options         ZFS
626
627 #####################################################################
628 # VM OPTIONS
629
630 # KSTACK_PAGES is the number of memory pages to assign to the kernel
631 # stack of each thread.
632
633 options         KSTACK_PAGES=5
634
635 # Enable detailed accounting by the PV entry allocator.
636
637 options         PV_STATS
638
639 #####################################################################
640
641 # More undocumented options for linting.
642 # Note that documenting these are not considered an affront.
643
644 options         KBDIO_DEBUG=2
645 options         KBD_MAXRETRY=4
646 options         KBD_MAXWAIT=6
647 options         KBD_RESETDELAY=201
648
649 options         PSM_DEBUG=1
650
651 options         TIMER_FREQ=((14318182+6)/12)
652
653 options         VM_KMEM_SIZE
654 options         VM_KMEM_SIZE_MAX
655 options         VM_KMEM_SIZE_SCALE
656
657 # GCOV (code coverage) support
658
659 options         LINDEBUGFS
660 options         GCOV