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