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