xref: /freebsd/sys/amd64/conf/NOTES (revision a0e793cbf1951d07fc47a0d9ea389d7dacba5213)
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.
12profile         2
13
14#
15# Enable the kernel DTrace hooks which are required to load the DTrace
16# kernel modules.
17#
18options 	KDTRACE_HOOKS
19
20
21#####################################################################
22# SMP OPTIONS:
23#
24# Notes:
25#
26# IPI_PREEMPTION instructs the kernel to preempt threads running on other
27#	  CPUS if needed.  Relies on the PREEMPTION option
28
29# Optional:
30options 	IPI_PREEMPTION
31device		atpic			# Optional legacy pic support
32device		mptable			# Optional MPSPEC mptable support
33
34#
35# Watchdog routines.
36#
37options 	MP_WATCHDOG
38
39# Debugging options.
40#
41options 	COUNT_XINVLTLB_HITS	# Counters for TLB events
42options 	COUNT_IPIS		# Per-CPU IPI interrupt counters
43
44
45
46#####################################################################
47# CPU OPTIONS
48
49#
50# You must specify at least one CPU (the one you intend to run on);
51# deleting the specification for CPUs you don't need to use may make
52# parts of the system run faster.
53#
54cpu		HAMMER			# aka K8, aka Opteron & Athlon64
55
56#
57# Options for CPU features.
58#
59
60#
61# PERFMON causes the driver for Pentium/Pentium Pro performance counters
62# to be compiled.  See perfmon(4) for more information.
63#
64#XXX#options 	PERFMON
65
66
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
87options 	DEVICE_POLLING
88
89# BPF_JITTER adds support for BPF just-in-time compiler.
90
91options 	BPF_JITTER
92
93# OpenFabrics Enterprise Distribution (Infiniband).
94options 	OFED
95options 	OFED_DEBUG_INIT
96
97# Sockets Direct Protocol
98options 	SDP
99options 	SDP_DEBUG
100
101# IP over Infiniband
102options 	IPOIB
103options 	IPOIB_DEBUG
104options 	IPOIB_CM
105
106
107#####################################################################
108# CLOCK OPTIONS
109
110# Provide read/write access to the memory in the clock chip.
111device		nvram		# Access to rtc cmos via /dev/nvram
112
113
114#####################################################################
115# MISCELLANEOUS DEVICES AND OPTIONS
116
117device		speaker		#Play IBM BASIC-style noises out your speaker
118hint.speaker.0.at="isa"
119hint.speaker.0.port="0x61"
120device		gzip		#Exec gzipped a.out's.  REQUIRES COMPAT_AOUT!
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 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# PCI bus & PCI options:
165#
166device		pci
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
198hint.psm.0.at="atkbdc"
199hint.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
208hint.atkbdc.0.at="isa"
209hint.atkbdc.0.port="0x060"
210
211# The AT keyboard
212device		atkbd
213hint.atkbd.0.at="atkbdc"
214hint.atkbd.0.irq="1"
215
216# Options for atkbd:
217options 	ATKBD_DFLT_KEYMAP	# specify the built-in keymap
218makeoptions	ATKBD_DFLT_KEYMAP=jp.106
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
229hint.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
254
255# Linear framebuffer driver for S3 VESA 1.2 cards. Works on top of VESA.
256device		s3pci
257
258# 3Dfx Voodoo Graphics, Voodoo II /dev/3dfx CDEV support.  This will create
259# the /dev/3dfx0 device to work with glide implementations.  This should get
260# linked to /dev/3dfx and /dev/voodoo.  Note that this is not the same as
261# the tdfx DRI module from XFree86 and is completely unrelated.
262#
263# To enable Linuxulator support, one must also include COMPAT_LINUX in the
264# config as well.  The other option is to load both as modules.
265
266device		tdfx			# Enable 3Dfx Voodoo support
267#XXX#device 	tdfx_linux		# Enable Linuxulator support
268
269#
270# ACPI support using the Intel ACPI Component Architecture reference
271# implementation.
272#
273# ACPI_DEBUG enables the use of the debug.acpi.level and debug.acpi.layer
274# kernel environment variables to select initial debugging levels for the
275# Intel ACPICA code.  (Note that the Intel code must also have USE_DEBUGGER
276# defined when it is built).
277
278device		acpi
279options 	ACPI_DEBUG
280
281# The cpufreq(4) driver provides support for non-ACPI CPU frequency control
282device		cpufreq
283
284# Direct Rendering modules for 3D acceleration.
285device		drm		# DRM core module required by DRM drivers
286device		i915drm		# Intel i830 through i915
287device		mach64drm	# ATI Rage Pro, Rage Mobility P/M, Rage XL
288device		mgadrm		# AGP Matrox G200, G400, G450, G550
289device		r128drm		# ATI Rage 128
290device		radeondrm	# ATI Radeon
291device		savagedrm	# S3 Savage3D, Savage4
292device		sisdrm		# SiS 300/305, 540, 630
293device		tdfxdrm		# 3dfx Voodoo 3/4/5 and Banshee
294device		viadrm		# VIA
295options 	DRM_DEBUG	# Include debug printfs (slow)
296
297#
298# Network interfaces:
299#
300
301# bxe:  Broadcom NetXtreme II (BCM5771X/BCM578XX) PCIe 10Gb Ethernet
302#       adapters.
303# ed:   Western Digital and SMC 80xx; Novell NE1000 and NE2000; 3Com 3C503
304#       HP PC Lan+, various PC Card devices
305#       (requires miibus)
306# ipw:	Intel PRO/Wireless 2100 IEEE 802.11 adapter
307#	Requires the ipw firmware module
308# iwi:	Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 adapters
309#	Requires the iwi firmware module
310# iwn:	Intel Wireless WiFi Link 4965/1000/5000/6000 802.11 network adapters
311#	Requires the iwn firmware module
312# mlx4ib: Mellanox ConnectX HCA InfiniBand
313# mlxen: Mellanox ConnectX HCA Ethernet
314# mthca: Mellanox HCA InfiniBand
315# nfe:	nVidia nForce MCP on-board Ethernet Networking (BSD open source)
316# sfxge: Solarflare SFC9000 family 10Gb Ethernet adapters
317# vmx:	VMware VMXNET3 Ethernet (BSD open source)
318# wpi:	Intel 3945ABG Wireless LAN controller
319#	Requires the wpi firmware module
320
321device		bxe		# Broadcom NetXtreme II BCM5771X/BCM578XX 10GbE
322device		ed		# NE[12]000, SMC Ultra, 3c503, DS8390 cards
323options 	ED_3C503
324options 	ED_HPP
325options 	ED_SIC
326device		ipw		# Intel 2100 wireless NICs.
327device		iwi		# Intel 2200BG/2225BG/2915ABG wireless NICs.
328device		iwn		# Intel 4965/1000/5000/6000 wireless NICs.
329device  	mlx4ib		# Mellanox ConnectX HCA InfiniBand
330device  	mlxen		# Mellanox ConnectX HCA Ethernet
331device  	mthca		# Mellanox HCA InfiniBand
332device		nfe		# nVidia nForce MCP on-board Ethernet
333device		sfxge		# Solarflare SFC9000 10Gb Ethernet
334device		vmx		# VMware VMXNET3 Ethernet
335device		wpi		# Intel 3945ABG wireless NICs.
336
337# IEEE 802.11 adapter firmware modules
338
339# Intel PRO/Wireless 2100 firmware:
340#   ipwfw:		BSS/IBSS/monitor mode firmware
341#   ipwbssfw:		BSS mode firmware
342#   ipwibssfw:		IBSS mode firmware
343#   ipwmonitorfw:	Monitor mode firmware
344# Intel PRO/Wireless 2200BG/2225BG/2915ABG firmware:
345#   iwifw:		BSS/IBSS/monitor mode firmware
346#   iwibssfw:		BSS mode firmware
347#   iwiibssfw:		IBSS mode firmware
348#   iwimonitorfw:	Monitor mode firmware
349# Intel Wireless WiFi Link 4965/1000/5000/6000 series firmware:
350#   iwnfw:		Single module to support the 4965/1000/5000/5150/6000
351#   iwn4965fw:		Specific module for the 4965 only
352#   iwn1000fw:		Specific module for the 1000 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#   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		iwn4965fw
369device		iwn1000fw
370device		iwn5000fw
371device		iwn5150fw
372device		iwn6000fw
373device		iwn6050fw
374device		wpifw
375
376# Intel Non-Transparent Bridge (NTB) hardware
377device		ntb_hw	# Hardware Abstraction Layer for the NTB
378device		if_ntb	# Simulated ethernet device using the NTB
379
380#
381#XXX this stores pointers in a 32bit field that is defined by the hardware
382#device	pst
383
384#
385# Areca 11xx and 12xx series of SATA II RAID controllers.
386# CAM is required.
387#
388device		arcmsr		# Areca SATA II RAID
389
390#
391# 3ware 9000 series PATA/SATA RAID controller driver and options.
392# The driver is implemented as a SIM, and so, needs the CAM infrastructure.
393#
394options 	TWA_DEBUG		# 0-10; 10 prints the most messages.
395options 	TWA_FLASH_FIRMWARE	# firmware image bundled when defined.
396device		twa			# 3ware 9000 series PATA/SATA RAID
397
398#
399# SCSI host adapters:
400#
401# ncv: NCR 53C500 based SCSI host adapters.
402# nsp: Workbit Ninja SCSI-3 based PC Card SCSI host adapters.
403# stg: TMC 18C30, 18C50 based SCSI host adapters.
404
405device		ncv
406device		nsp
407device		stg
408
409#
410# Adaptec FSA RAID controllers, including integrated DELL controllers,
411# the Dell PERC 2/QC and the HP NetRAID-4M
412device		aac
413device		aacp	# SCSI Passthrough interface (optional, CAM required)
414
415#
416# Adaptec by PMC RAID controllers, Series 6/7/8 and upcoming families
417device		aacraid		# Container interface, CAM required
418
419#
420# Highpoint RocketRAID 27xx.
421device		hpt27xx
422
423#
424# Highpoint RocketRAID 182x.
425device		hptmv
426
427#
428# Highpoint DC7280 and R750.
429device		hptnr
430
431#
432# Highpoint RocketRAID.  Supports RR172x, RR222x, RR2240, RR232x, RR2340,
433# RR2210, RR174x, RR2522, RR231x, RR230x.
434device		hptrr
435
436#
437# Highpoint RocketRaid 3xxx series SATA RAID
438device		hptiop
439
440#
441# IBM (now Adaptec) ServeRAID controllers
442device		ips
443
444#
445# Intel C600 (Patsburg) integrated SAS controller
446device		isci
447options 	ISCI_LOGGING	# enable debugging in isci HAL
448
449#
450# NVM Express (NVMe) support
451device         nvme    # base NVMe driver
452device         nvd     # expose NVMe namespaces as disks, depends on nvme
453
454#
455# SafeNet crypto driver: can be moved to the MI NOTES as soon as
456# it's tested on a big-endian machine
457#
458device		safe		# SafeNet 1141
459options 	SAFE_DEBUG	# enable debugging support: hw.safe.debug
460options 	SAFE_RNDTEST	# enable rndtest support
461
462#
463# VirtIO support
464#
465# The virtio entry provides a generic bus for use by the device drivers.
466# It must be combined with an interface that communicates with the host.
467# Multiple such interfaces are defined by the VirtIO specification. FreeBSD
468# only has support for PCI. Therefore, virtio_pci must be statically
469# compiled in or loaded as a module for the device drivers to function.
470#
471device		virtio		# Generic VirtIO bus (required)
472device		virtio_pci	# VirtIO PCI Interface
473device		vtnet		# VirtIO Ethernet device
474device		virtio_blk	# VirtIO Block device
475device		virtio_scsi	# VirtIO SCSI device
476device		virtio_balloon	# VirtIO Memory Balloon device
477device		virtio_random	# VirtIO Entropy device
478
479device 		hyperv		# HyperV drivers
480
481# Xen HVM Guest Optimizations
482options 	XENHVM		# Xen HVM kernel infrastructure
483device 		xenpci		# Xen HVM Hypervisor services driver
484
485#####################################################################
486
487#
488# Miscellaneous hardware:
489#
490# ipmi: Intelligent Platform Management Interface
491# pbio: Parallel (8255 PPI) basic I/O (mode 0) port (e.g. Advantech PCL-724)
492# smbios: DMI/SMBIOS entry point
493# vpd: Vital Product Data kernel interface
494# asmc: Apple System Management Controller
495# si: Specialix International SI/XIO or SX intelligent serial card
496# tpm: Trusted Platform Module
497
498# Notes on the Specialix SI/XIO driver:
499#  The host card is memory, not IO mapped.
500#  The Rev 1 host cards use a 64K chunk, on a 32K boundary.
501#  The Rev 2 host cards use a 32K chunk, on a 32K boundary.
502#  The cards can use an IRQ of 11, 12 or 15.
503
504device		ipmi
505device		pbio
506hint.pbio.0.at="isa"
507hint.pbio.0.port="0x360"
508device		smbios
509device		vpd
510device		asmc
511#device		si
512device		tpm
513device		padlock_rng	# VIA Padlock RNG
514device		rdrand_rng	# Intel Bull Mountain RNG
515device		aesni		# AES-NI OpenCrypto module
516
517#
518# Laptop/Notebook options:
519#
520
521
522#
523# I2C Bus
524#
525
526#
527# Hardware watchdog timers:
528#
529# ichwd: Intel ICH watchdog timer
530# amdsbwd: AMD SB7xx watchdog timer
531# viawd: VIA south bridge watchdog timer
532# wbwd: Winbond watchdog timer
533#
534device		ichwd
535device		amdsbwd
536device		viawd
537device		wbwd
538
539#
540# Temperature sensors:
541#
542# coretemp: on-die sensor on Intel Core and newer CPUs
543# amdtemp: on-die sensor on AMD K8/K10/K11 CPUs
544#
545device		coretemp
546device		amdtemp
547
548#
549# CPU control pseudo-device. Provides access to MSRs, CPUID info and
550# microcode update feature.
551#
552device		cpuctl
553
554#
555# System Management Bus (SMB)
556#
557options 	ENABLE_ALART		# Control alarm on Intel intpm driver
558
559#
560# Number of initial kernel page table pages used for early bootstrap.
561# This number should include enough pages to map the kernel and any
562# modules or other data loaded with the kernel by the loader.  Each
563# page table page maps 2MB.
564#
565options 	NKPT=31
566
567
568#####################################################################
569# ABI Emulation
570
571#XXX keep these here for now and reactivate when support for emulating
572#XXX these 32 bit binaries is added.
573
574# Enable 32-bit runtime support for FreeBSD/i386 binaries.
575options 	COMPAT_FREEBSD32
576
577# Enable iBCS2 runtime support for SCO and ISC binaries
578#XXX#options 	IBCS2
579
580# Emulate spx device for client side of SVR3 local X interface
581#XXX#options 	SPX_HACK
582
583# Enable Linux ABI emulation
584#XXX#options 	COMPAT_LINUX
585
586# Enable 32-bit Linux ABI emulation (requires COMPAT_43 and COMPAT_FREEBSD32)
587options 	COMPAT_LINUX32
588
589# Enable the linux-like proc filesystem support (requires COMPAT_LINUX32
590# and PSEUDOFS)
591options 	LINPROCFS
592
593#Enable the linux-like sys filesystem support (requires COMPAT_LINUX32
594# and PSEUDOFS)
595options 	LINSYSFS
596
597#
598# SysVR4 ABI emulation
599#
600# The svr4 ABI emulator can be statically compiled into the kernel or loaded as
601# a KLD module.
602# The STREAMS network emulation code can also be compiled statically or as a
603# module.  If loaded as a module, it must be loaded before the svr4 module
604# (the /usr/sbin/svr4 script does this for you).  If compiling statically,
605# the `streams' device must be configured into any kernel which also
606# specifies COMPAT_SVR4.  It is possible to have a statically-configured
607# STREAMS device and a dynamically loadable svr4 emulator;  the /usr/sbin/svr4
608# script understands that it doesn't need to load the `streams' module under
609# those circumstances.
610# Caveat:  At this time, `options KTRACE' is required for the svr4 emulator
611# (whether static or dynamic).
612#
613#XXX#options 	COMPAT_SVR4	# build emulator statically
614#XXX#options 	DEBUG_SVR4	# enable verbose debugging
615#XXX#device	streams		# STREAMS network driver (required for svr4).
616
617
618#####################################################################
619# VM OPTIONS
620
621# KSTACK_PAGES is the number of memory pages to assign to the kernel
622# stack of each thread.
623
624options 	KSTACK_PAGES=5
625
626# Enable detailed accounting by the PV entry allocator.
627
628options 	PV_STATS
629
630#####################################################################
631
632# More undocumented options for linting.
633# Note that documenting these are not considered an affront.
634
635options 	FB_INSTALL_CDEV		# install a CDEV entry in /dev
636
637options 	KBDIO_DEBUG=2
638options 	KBD_MAXRETRY=4
639options 	KBD_MAXWAIT=6
640options 	KBD_RESETDELAY=201
641
642options 	PSM_DEBUG=1
643
644options 	TIMER_FREQ=((14318182+6)/12)
645
646options 	VM_KMEM_SIZE
647options 	VM_KMEM_SIZE_MAX
648options 	VM_KMEM_SIZE_SCALE
649
650# Enable NDIS binary driver support
651options 	NDISAPI
652device		ndis
653