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