xref: /freebsd/sys/conf/options (revision c678bc4f13a340ad88debe321afd0097db2590cb)
1# $FreeBSD$
2#
3#        On the handling of kernel options
4#
5# All kernel options should be listed in LINT, with suitable
6# descriptions.  Negative options (options that make some code not
7# compile) should be commented out; LINT should compile as much code
8# as possible.  Try to structure option-using code so that a single
9# option only switch code on, or only switch code off, to make it
10# possible to have a full compile-test.  If necessary, you can check
11# for COMPILING_LINT to get maximum code coverage.
12#
13# All new options shall also be listed in either "conf/options" or
14# "<machine>/conf/options.<machine>".  Options that affect a single
15# source-file <xxx>.[c|s] should be directed into "opt_<xxx>.h", while
16# options that affect multiple files should either go in
17# "opt_global.h" if this is a kernel-wide option (used just about
18# everywhere), or in "opt_<option-name-in-lower-case>.h" if it affect
19# only some files.  Note that the effect of listing only an option
20# without a header-file-name in conf/options (and cousins) is that the
21# last convention is followed.
22#
23# This handling scheme is not yet fully implemented.
24#
25#
26# Format of this file:
27# Option name	filename
28#
29# If filename is missing, the default is
30# opt_<name-of-option-in-lower-case>.h
31
32# Adaptec Array Controller driver options
33AAC_COMPAT_LINUX	opt_acc.h	# Enable the linux ioctl interface
34
35AAC_DEBUG		opt_aac.h	# Debugging levels:
36					# 0 - quiet, only emit warnings
37					# 1 - noisy, emit major function
38					#     points and things done
39					# 2 - extremely noisy, emit trace
40					#     items in loops, etc.
41
42# Adaptec aic7xxx SCSI controller options
43AHC_ALLOW_MEMIO		opt_aic7xxx.h	# Allow PCI devices to use memory
44					# mapped I/O
45
46AHC_TMODE_ENABLE	opt_aic7xxx.h	# Bitmap of units to enable
47					# targetmode operations.
48
49AHC_DUMP_EEPROM		opt_aic7xxx.h	# Dump the contents of our
50					# configuration prom.
51
52AHC_DEBUG_SEQUENCER	opt_aic7xxx.h	# Enable diagnostic sequencer code
53
54ADW_ALLOW_MEMIO		opt_adw.h	# Allow PCI devices to use memory
55					# mapped I/O
56
57# Miscellaneous options.
58BLEED
59COMPAT_43	opt_compat.h
60COMPAT_SUNOS	opt_compat.h
61COMPILING_LINT	opt_global.h
62CY_PCI_FASTINTR
63DDB
64DDB_UNATTENDED	opt_ddb.h
65GDB_REMOTE_CHAT	opt_ddb.h
66NODEVFS		opt_devfs.h
67HW_WDOG
68KTRACE
69LIBICONV
70MD_ROOT		opt_md.h
71MD_ROOT_SIZE	opt_md.h
72NTIMECOUNTER	opt_ntp.h
73NSWAPDEV	opt_swap.h
74PPS_SYNC	opt_ntp.h
75QUOTA
76SPX_HACK
77SUIDDIR		opt_suiddir.h
78SYSVMSG		opt_sysvipc.h
79SYSVSEM		opt_sysvipc.h
80SYSVSHM		opt_sysvipc.h
81SHMALL		opt_sysvipc.h
82SHMMAX		opt_sysvipc.h
83SHMMAXPGS	opt_sysvipc.h
84SHMMIN		opt_sysvipc.h
85SHMMNI		opt_sysvipc.h
86SHMSEG		opt_sysvipc.h
87SEMMAP		opt_sysvipc.h
88SEMMNI		opt_sysvipc.h
89SEMMNS		opt_sysvipc.h
90SEMMNU		opt_sysvipc.h
91SEMMSL		opt_sysvipc.h
92SEMOPM		opt_sysvipc.h
93SEMUME		opt_sysvipc.h
94MSGMNB		opt_sysvipc.h
95MSGMNI		opt_sysvipc.h
96MSGSEG		opt_sysvipc.h
97MSGSSZ		opt_sysvipc.h
98MSGTQL		opt_sysvipc.h
99UCONSOLE
100VFS_AIO
101
102# POSIX kernel options
103P1003_1B			opt_posix.h
104_KPOSIX_PRIORITY_SCHEDULING	opt_posix.h
105_KPOSIX_VERSION			opt_posix.h
106
107# TrustedBSD and POSIX.1e Kernel Options
108CAPABILITIES	opt_cap.h
109
110# Do we want the config file compiled into the kernel?
111INCLUDE_CONFIG_FILE	opt_config.h
112
113# Options for static file systems.  These should only be used at config
114# time, since the corresponding lkms cannot work if there are any static
115# dependencies.  Unusability is enforced by hiding the defines for the
116# options in a never-included header.
117CD9660		opt_dontuse.h
118CODA		opt_dontuse.h
119EXT2FS		opt_dontuse.h
120FDESCFS		opt_dontuse.h
121FFS		opt_dontuse.h
122IFS		opt_dontuse.h
123LINPROCFS	opt_dontuse.h
124MSDOSFS		opt_dontuse.h
125NULLFS		opt_dontuse.h
126NWFS		opt_dontuse.h
127PORTALFS	opt_dontuse.h
128PROCFS		opt_dontuse.h
129UMAPFS		opt_dontuse.h
130NTFS		opt_dontuse.h
131HPFS		opt_dontuse.h
132UNIONFS		opt_dontuse.h
133
134# These static filesystems has one slightly bogus static dependency in
135# sys/i386/i386/autoconf.c.  If any of these filesystems are
136# statically compiled into the kernel, code for mounting them as root
137# filesystems will be enabled - but look below.
138NFS
139
140# If you are following the conditions in the copyright,
141# you can enable soft-updates which will speed up a lot of thigs
142# and make the system safer from crashes at the same time.
143# otherwise a STUB module will be compiled in.
144SOFTUPDATES	opt_ffs.h
145
146# Enabling this option turns on support for Access Control Lists in UFS,
147# which can be used to support high security configurations.  Depends on
148# UFS_EXTATTR.
149UFS_ACL		opt_ufs.h
150
151# Enabling this option turns on support for extended attributes in UFS-based
152# file systems, which can be used to support high security configurations
153# as well as new file system features.
154UFS_EXTATTR	opt_ufs.h
155UFS_EXTATTR_AUTOSTART	opt_ufs.h
156
157# The above static dependencies are planned removed, with a
158# <filesystem>_ROOT option to control if it usable as root.  This list
159# allows these options to be present in config files already (though
160# they won't make any difference yet).
161NFS_ROOT	opt_nfsroot.h
162
163# Options used only in param.c.
164HZ		opt_param.h
165MAXFILES	opt_param.h
166MAXUSERS	opt_param.h
167NBUF		opt_param.h
168NMBCLUSTERS	opt_param.h
169NSFBUFS		opt_param.h
170
171# Generic SCSI options.
172CAM_MAX_HIGHPOWER	opt_cam.h
173CAMDEBUG		opt_cam.h
174CAM_DEBUG_DELAY		opt_cam.h
175CAM_DEBUG_BUS		opt_cam.h
176CAM_DEBUG_TARGET	opt_cam.h
177CAM_DEBUG_LUN		opt_cam.h
178CAM_DEBUG_FLAGS		opt_cam.h
179SCSI_DELAY		opt_scsi.h
180SCSI_NO_SENSE_STRINGS	opt_scsi.h
181SCSI_NO_OP_STRINGS	opt_scsi.h
182
183# Options used only in cam/scsi/scsi_cd.c
184CHANGER_MIN_BUSY_SECONDS	opt_cd.h
185CHANGER_MAX_BUSY_SECONDS	opt_cd.h
186
187# Options used only in cam/scsi/scsi_sa.c.
188SA_SPACE_TIMEOUT	opt_sa.h
189SA_REWIND_TIMEOUT	opt_sa.h
190SA_ERASE_TIMEOUT	opt_sa.h
191SA_1FM_AT_EOD		opt_sa.h
192
193# Options used only in cam/scsi/scsi_pt.c
194SCSI_PT_DEFAULT_TIMEOUT	opt_pt.h
195
196# Options used only in cam/scsi/scsi_ses.c
197SES_ENABLE_PASSTHROUGH	opt_ses.h
198
199# Options used in dev/sym/ (Symbios SCSI driver).
200SYM_SETUP_LP_PROBE_MAP	opt_sym.h	#-Low Priority Probe Map (bits)
201					# Allows the ncr to take precedence
202					# 1 (1<<0) -> 810a, 860
203					# 2 (1<<1) -> 825a, 875, 885, 895
204					# 4 (1<<2) -> 895a, 896, 1510d
205SYM_SETUP_SCSI_DIFF	opt_sym.h	#-HVD support for 825a, 875, 885
206					# disabled:0 (default), enabled:1
207SYM_SETUP_PCI_PARITY	opt_sym.h	#-PCI parity checking
208					# disabled:0, enabled:1 (default)
209SYM_SETUP_MAX_LUN	opt_sym.h	#-Number of LUNs supported
210					# default:8, range:[1..64]
211
212# Options used only in pci/ncr.c
213SCSI_NCR_DEBUG		opt_ncr.h
214SCSI_NCR_MAX_SYNC	opt_ncr.h
215SCSI_NCR_MAX_WIDE	opt_ncr.h
216SCSI_NCR_MYADDR		opt_ncr.h
217
218# Options used only in pci/isp_pci.c
219ISP_TARGET_MODE		opt_isp.h
220
221# Options used in the 'ata' ATA/ATAPI driver
222ACD_DEBUG		opt_ata.h
223AST_DEBUG		opt_ata.h
224ATAPI_DEBUG		opt_ata.h
225ATA_DEBUG		opt_ata.h
226ATA_STATIC_ID		opt_ata.h
227DEV_ATADISK		opt_ata.h
228DEV_ATAPICD		opt_ata.h
229DEV_ATAPIST		opt_ata.h
230DEV_ATAPIFD		opt_ata.h
231
232# Resource limits.
233DFLDSIZ			opt_rlimit.h
234MAXDSIZ			opt_rlimit.h
235
236# Net stuff.
237ACCEPT_FILTER_DATA
238ACCEPT_FILTER_HTTP
239BOOTP			opt_bootp.h
240BOOTP_COMPAT		opt_bootp.h
241BOOTP_NFSROOT		opt_bootp.h
242BOOTP_NFSV3		opt_bootp.h
243BOOTP_WIRED_TO		opt_bootp.h
244BRIDGE			opt_bdg.h
245ETHER_II		opt_ef.h
246ETHER_8023		opt_ef.h
247ETHER_8022		opt_ef.h
248ETHER_SNAP		opt_ef.h
249MROUTING		opt_mrouting.h
250INET			opt_inet.h
251SOMAXCONN		opt_inet.h
252INET6			opt_inet6.h
253IPSEC			opt_ipsec.h
254IPSEC_ESP		opt_ipsec.h
255IPSEC_DEBUG		opt_ipsec.h
256IPDIVERT
257DUMMYNET		opt_ipdn.h
258IPFILTER		opt_ipfilter.h
259IPFILTER_LOG		opt_ipfilter.h
260IPFILTER_DEFAULT_BLOCK	opt_ipfilter.h
261PFIL_HOOKS		opt_pfil_hooks.h
262IPFIREWALL		opt_ipfw.h
263IPFIREWALL_VERBOSE	opt_ipfw.h
264IPFIREWALL_VERBOSE_LIMIT	opt_ipfw.h
265IPFIREWALL_DEFAULT_TO_ACCEPT	opt_ipfw.h
266IPFIREWALL_FORWARD		opt_ipfw.h
267IPV6FIREWALL		opt_ip6fw.h
268IPV6FIREWALL_VERBOSE	opt_ip6fw.h
269IPV6FIREWALL_VERBOSE_LIMIT	opt_ip6fw.h
270IPV6FIREWALL_DEFAULT_TO_ACCEPT	opt_ip6fw.h
271IPSTEALTH
272IPX			opt_ipx.h
273IPXIP			opt_ipx.h
274IPTUNNEL		opt_ipx.h
275LIBMCHAIN
276NCP			opt_ncp.h
277NETATALK		opt_atalk.h
278PPP_BSDCOMP		opt_ppp.h
279PPP_DEFLATE		opt_ppp.h
280PPP_FILTER		opt_ppp.h
281SLIP_IFF_OPTS		opt_slip.h
282TCPDEBUG
283TCP_DROP_SYNFIN		opt_tcp_input.h
284XBONEHACK
285
286# Netgraph(4). Use option NETGRAPH to enable the base netgraph code.
287# Each netgraph node type can be either be compiled into the kernel
288# or loaded dynamically. To get the former, include the corresponding
289# option below. Each type has its own man page, e.g. ng_async(4).
290NETGRAPH
291NETGRAPH_ASYNC		opt_netgraph.h
292NETGRAPH_BPF		opt_netgraph.h
293NETGRAPH_BRIDGE		opt_netgraph.h
294NETGRAPH_CISCO		opt_netgraph.h
295NETGRAPH_ECHO		opt_netgraph.h
296NETGRAPH_ETHER		opt_netgraph.h
297NETGRAPH_FRAME_RELAY	opt_netgraph.h
298NETGRAPH_HOLE		opt_netgraph.h
299NETGRAPH_IFACE		opt_netgraph.h
300NETGRAPH_KSOCKET	opt_netgraph.h
301NETGRAPH_LMI		opt_netgraph.h
302# MPPC compression requires proprietary files (not included)
303NETGRAPH_MPPC_COMPRESSION	opt_netgraph.h
304NETGRAPH_MPPC_ENCRYPTION	opt_netgraph.h
305NETGRAPH_ONE2MANY	opt_netgraph.h
306NETGRAPH_PPP		opt_netgraph.h
307NETGRAPH_PPPOE		opt_netgraph.h
308NETGRAPH_PPTPGRE	opt_netgraph.h
309NETGRAPH_RFC1490	opt_netgraph.h
310NETGRAPH_SOCKET		opt_netgraph.h
311NETGRAPH_TEE		opt_netgraph.h
312NETGRAPH_TTY		opt_netgraph.h
313NETGRAPH_UI		opt_netgraph.h
314NETGRAPH_VJC		opt_netgraph.h
315
316# ATM (HARP version)
317ATM_CORE		opt_atm.h
318ATM_IP			opt_atm.h
319ATM_SIGPVC		opt_atm.h
320ATM_SPANS		opt_atm.h
321ATM_UNI			opt_atm.h
322
323# XXX Conflict: # of devices vs network protocol (Native ATM).
324# This makes "atm.h" unusable.
325NATM			opt_natm.h
326
327DPT_ALLOW_MEMIO		opt_dpt.h	# Allow PCI devices to use memory
328					# mapped I/O
329# DPT driver debug flags
330DPT_MEASURE_PERFORMANCE	opt_dpt.h
331DPT_HANDLE_TIMEOUTS	opt_dpt.h
332DPT_TIMEOUT_FACTOR	opt_dpt.h
333DPT_LOST_IRQ		opt_dpt.h
334DPT_RESET_HBA		opt_dpt.h
335
336# Adaptec ASR and DPT V/VI controller options
337ASR_MEASURE_PERFORMANCE	opt_asr.h
338
339# Misc debug flags.  Most of these should probably be replaced with
340# 'DEBUG', and then let people recompile just the interesting modules
341# with 'make CC="cc -DDEBUG"'.
342CLUSTERDEBUG		opt_debug_cluster.h
343DEBUG_1284		opt_ppb_1284.h
344VP0_DEBUG		opt_vpo.h
345LPT_DEBUG		opt_lpt.h
346PLIP_DEBUG		opt_plip.h
347LOCKF_DEBUG		opt_debug_lockf.h
348LOUTB			opt_debug_outb.h
349NPX_DEBUG		opt_debug_npx.h
350NETATALKDEBUG		opt_atalk.h
351SI_DEBUG		opt_debug_si.h
352
353# Fb options
354FB_DEBUG		opt_fb.h
355FB_INSTALL_CDEV		opt_fb.h
356
357# ppbus related options
358PERIPH_1284		opt_ppb_1284.h
359DONTPROBE_1284		opt_ppb_1284.h
360
361# smbus related options
362ENABLE_ALART		opt_intpm.h
363
364# These cause changes all over the kernel
365BLKDEV_IOSIZE		opt_global.h
366DEBUG			opt_global.h
367DEBUG_LOCKS		opt_global.h
368DEBUG_VFS_LOCKS		opt_global.h
369DIAGNOSTIC		opt_global.h
370ENABLE_VFS_IOOPT	opt_global.h
371INVARIANT_SUPPORT	opt_global.h
372INVARIANTS		opt_global.h
373REGRESSION		opt_global.h
374SIMPLELOCK_DEBUG	opt_global.h
375VFS_BIO_DEBUG		opt_global.h
376
377# These are VM related options
378VM_KMEM_SIZE		opt_vm.h
379VM_KMEM_SIZE_SCALE	opt_vm.h
380VM_KMEM_SIZE_MAX	opt_vm.h
381NO_SWAPPING		opt_vm.h
382PQ_NOOPT		opt_vmpage.h
383PQ_NORMALCACHE		opt_vmpage.h
384PQ_MEDIUMCACHE		opt_vmpage.h
385PQ_LARGECACHE		opt_vmpage.h
386PQ_HUGECACHE		opt_vmpage.h
387PQ_CACHESIZE		opt_vmpage.h
388
389# Standard SMP options
390SMP			opt_global.h
391
392# sys/netkey
393KEY
394
395# Size of the kernel message buffer
396MSGBUF_SIZE		opt_msgbuf.h
397
398# PCI related options
399PCI_QUIET		opt_pci.h
400
401# NFS options
402NFS_MINATTRTIMO		opt_nfs.h
403NFS_MAXATTRTIMO		opt_nfs.h
404NFS_MINDIRATTRTIMO	opt_nfs.h
405NFS_MAXDIRATTRTIMO	opt_nfs.h
406NFS_GATHERDELAY		opt_nfs.h
407NFS_UIDHASHSIZ		opt_nfs.h
408NFS_WDELAYHASHSIZ	opt_nfs.h
409NFS_MUIDHASHSIZ		opt_nfs.h
410NFS_NOSERVER		opt_nfs.h
411NFS_DEBUG		opt_nfs.h
412
413# For the Bt848/Bt848A/Bt849/Bt878/Bt879 driver
414OVERRIDE_CARD			opt_bktr.h
415OVERRIDE_TUNER			opt_bktr.h
416OVERRIDE_DBX			opt_bktr.h
417OVERRIDE_MSP			opt_bktr.h
418BROOKTREE_SYSTEM_DEFAULT	opt_bktr.h
419BROOKTREE_ALLOC_PAGES		opt_bktr.h
420BKTR_OVERRIDE_CARD		opt_bktr.h
421BKTR_OVERRIDE_TUNER		opt_bktr.h
422BKTR_OVERRIDE_DBX		opt_bktr.h
423BKTR_OVERRIDE_MSP		opt_bktr.h
424BKTR_SYSTEM_DEFAULT		opt_bktr.h
425BKTR_ALLOC_PAGES		opt_bktr.h
426BKTR_USE_PLL			opt_bktr.h
427BKTR_GPIO_ACCESS		opt_bktr.h
428BKTR_NO_MSP_RESET		opt_bktr.h
429BKTR_430_FX_MODE		opt_bktr.h
430BKTR_SIS_VIA_MODE		opt_bktr.h
431
432# meteor opt_meteor.h
433METEOR_ALLOC_PAGES	opt_meteor.h
434METEOR_TEST_VIDEO	opt_meteor.h
435METEOR_SYSTEM_DEFAULT	opt_meteor.h
436METEOR_DEALLOC_PAGES	opt_meteor.h
437METEOR_DEALLOC_ABOVE	opt_meteor.h
438
439# Various mi ISA bus flags
440COM_ESP			opt_sio.h
441COM_MULTIPORT		opt_sio.h
442BREAK_TO_DEBUGGER	opt_comconsole.h
443ALT_BREAK_TO_DEBUGGER	opt_comconsole.h
444DEV_ISA			opt_isa.h
445
446# Include tweaks for running under the SimOS machine simulator.
447SIMOS			opt_simos.h
448
449# options for bus/device framework
450BUS_DEBUG		opt_bus.h
451DEVICE_SYSCTLS		opt_bus.h
452
453# options for USB support
454UHCI_DEBUG		opt_usb.h
455OHCI_DEBUG		opt_usb.h
456USB_DEBUG		opt_usb.h
457UGEN_DEBUG		opt_usb.h
458UHID_DEBUG		opt_usb.h
459UHUB_DEBUG		opt_usb.h
460UKBD_DEBUG		opt_usb.h
461ULPT_DEBUG		opt_usb.h
462UMASS_DEBUG		opt_usb.h
463UMS_DEBUG		opt_usb.h
464URIO_DEBUG		opt_usb.h
465UKBD_DFLT_KEYMAP	opt_ukbd.h
466
467# Vinum options
468VINUMDEBUG		opt_vinum.h
469
470# Embedded system options
471INIT_PATH		opt_init_path.h
472
473ROOTDEVNAME		opt_rootdevname.h
474
475FDC_DEBUG		opt_fdc.h
476PCFCLOCK_VERBOSE	opt_pcfclock.h
477PCFCLOCK_MAX_RETRIES	opt_pcfclock.h
478TDFX_LINUX opt_tdfx.h
479
480KTR			opt_global.h
481KTR_MASK		opt_ktr.h
482KTR_CPUMASK		opt_ktr.h
483KTR_COMPILE		opt_global.h
484KTR_ENTRIES		opt_global.h
485KTR_EXTEND		opt_global.h
486KTR_VERBOSE		opt_ktr.h
487MUTEX_DEBUG		opt_global.h
488CV_DEBUG		opt_global.h
489WITNESS			opt_global.h
490WITNESS_DDB		opt_witness.h
491WITNESS_SKIPSPIN	opt_witness.h
492
493# options for ACPI support
494ACPI_DEBUG		opt_acpi.h
495AML_DEBUG		opt_acpi.h
496ACPI_NO_ENABLE_ON_BOOT	opt_acpi.h
497
498# options for DEVFS, see sys/fs/devfs/devfs.h
499NDEVFSINO		opt_devfs.h
500NDEVFSOVERFLOW		opt_devfs.h
501
502# various 'device presence' options.
503DEV_MCA			opt_mca.h
504DEV_BPF			opt_bpf.h
505