xref: /freebsd/sys/amd64/conf/NOTES (revision 886164895f3f4805dc11171ac7980acaccf6ec77)
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.  For notes shared
6# with i386, look in /sys/x86/conf/NOTES.
7#
8#
9
10# GCOV (code coverage) support
11
12options 	LINDEBUGFS
13options 	GCOV
14
15
16#####################################################################
17# SMP OPTIONS:
18
19# Optional:
20device		atpic			# Optional legacy pic support
21device		mptable			# Optional MPSPEC mptable support
22
23
24#####################################################################
25# CPU OPTIONS
26
27#
28# You must specify at least one CPU (the one you intend to run on);
29# deleting the specification for CPUs you don't need to use may make
30# parts of the system run faster.
31#
32cpu		HAMMER			# aka K8, aka Opteron & Athlon64
33
34#
35# Options for CPU features.
36#
37
38
39#####################################################################
40# HARDWARE DEVICE CONFIGURATION
41
42#
43# Optional devices:
44#
45
46# vt(4) drivers.
47device		vt_efifb	# EFI framebuffer
48
49# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support.  This will create
50# the /dev/3dfx0 device to work with glide implementations.  This should get
51# linked to /dev/3dfx and /dev/voodoo.  Note that this is not the same as
52# the tdfx DRI module from XFree86 and is completely unrelated.
53#
54
55device		tdfx			# Enable 3Dfx Voodoo support
56
57#
58# RAID adapters
59#
60
61#XXX this stores pointers in a 32bit field that is defined by the hardware
62#device	pst
63
64# Thunderbolt (USB 4.0) support
65device		thunderbolt
66options		THUNDERBOLT_DEBUG
67
68#
69# Microsemi smartpqi controllers.
70# These controllers have a SCSI-like interface, and require the
71# CAM infrastructure.
72#
73device		smartpqi
74
75# Broadcom MPT Fusion, version 4, is 64-bit only
76device		mpi3mr			# LSI-Logic MPT-Fusion 4
77
78# Universal Flash Storage Host Controller Interface support
79device 		ufshci			# UFS host controller
80
81#
82# Network interfaces:
83#
84
85# axp: AMD EPYC integrated NIC
86#	Requires the miibus module
87# ice:	Intel 800 Series Physical Function
88#	Requires the ice_ddp module for full functionality
89# irdma: Intel 800 Series RDMA driver
90#        Requires the ice module
91# qlxgb: QLogic 3200 and 8200 series 10 Gigabit Ethernet & CNA Adapter
92# qlxgbe: QLogic 8300 series 10 Gigabit Ethernet & CNA Adapter
93# qlxge: QLogic 8100 series 10 Gigabit Ethernet & CNA Adapter
94# qlnxe: Cavium QLogic 41000/45000 series 10/25/40/100 Gigabit Ethernet & CNA Adapter
95# sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters
96
97device		axp		# AMD EPYC integrated NIC
98device		ixl		# Intel 700 Series Physical Function
99device		iavf		# Intel Adaptive Virtual Function
100device		ice		# Intel 800 Series Physical Function
101device		ice_ddp		# Intel 800 Series DDP Package
102device		irdma		# Intel 800 Series RDMA driver
103device		qlxgb		# QLogic 3200/8200 Ethernet
104device		qlxgbe		# QLogic 8300 Ethernet
105device		qlxge		# QLogic 8100 Ethernet
106device		qlnxe		# QLogic 41000/45000 Ethernet
107device		sfxge		# Solarflare SFC9000 10Gb Ethernet
108
109#####################################################################
110
111#
112# Miscellaneous hardware:
113#
114
115device		ioat		# Intel I/OAT DMA engine
116
117# EFI Runtime Services support
118options 	EFIRT
119
120# EFI pseudo-device
121device		efidev
122
123# EFI RTC
124device		efirtc
125
126# Apple System Management Controller (SMC)
127device		asmc
128options		ASMC_DEBUG	# Enable asmc(4)-specific debug logic.
129
130#
131# Intel QuickAssist driver with OpenCrypto support
132#
133# Only for legacy Atom C2XXX chipsets.
134device		qat_c2xxx
135
136# Xen HVM Guest Optimizations
137options 	XENHVM		# Xen HVM kernel infrastructure
138device		xenefi		# Xen EFI timer device
139device 		xenpci		# Xen HVM Hypervisor services driver
140device		xentimer	# Xen x86 PV timer device
141
142#####################################################################
143# ABI Emulation
144
145# Enable 32-bit runtime support for FreeBSD/i386 binaries.
146options 	COMPAT_FREEBSD32
147
148# Enable (32-bit) a.out binary support
149options 	COMPAT_AOUT
150
151#####################################################################
152# ZFS support
153
154# NB: This depends on crypto, cryptodev and ZSTDIO
155options 	ZFS
156
157#####################################################################
158# VM OPTIONS
159
160#
161# Number of initial kernel page table pages used for early bootstrap.
162# This number should include enough pages to map the kernel and any
163# modules or other data loaded with the kernel by the loader.  Each
164# page table page maps 2MB.
165#
166options 	NKPT=31
167
168# KSTACK_PAGES is the number of memory pages to assign to the kernel
169# stack of each thread.
170
171options 	KSTACK_PAGES=5
172
173# Enable detailed accounting by the PV entry allocator.
174
175options 	PV_STATS
176
177#####################################################################
178# Kernel sanitizers
179
180#options	COVERAGE		# Generic kernel coverage. Used by KCOV
181#options	KCOV			# Kernel Coverage Sanitizer
182# Warning: KUBSAN can result in a kernel too large for loader to load
183#options	KUBSAN			# Kernel Undefined Behavior Sanitizer
184#options	KCSAN			# Kernel Concurrency Sanitizer
185#options	KASAN			# Kernel Address Sanitizer
186#options	KMSAN			# Kernel Memory Sanitizer
187