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