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