Attachment #45938 for bug #70674

View | Details | Raw Unified | Return to bug 70674 | Differences between
Collapse All | Expand All




      some related keywords have been grouped together in a single section
      (such as Networking) even though they are actually scattered
      throughout the <filename>GENERIC</filename> file.  <anchor
      id="kernelconfig-options"> An exhaustive list of architecure
      dependent options and more detailed explanations of the device lines
      is present in the <filename>NOTES</filename> configuration file,
      located in the same directory as <filename>GENERIC</filename>. If you
      are in doubt as to the purpose or necessity of a line, check first in
      <filename>NOTES</filename>. Architecure independent options are
      stored in <filename>/usr/src/sys/conf/NOTES</filename>.</para>

    <note><para>In &os; 4.X and earlier <filename>NOTES</filename> is
      non-existent. Instead, see the <filename>LINT</filename> file for
      detailed explanations of options in <filename>GENERIC</filename>.
      </para></note>
      advisable to review the options in here also.</para></note>

    <indexterm>
      <primary>kernel</primary>

      clarity.  This example should match your copy in
      <filename>/usr/src/sys/i386/conf/GENERIC</filename> fairly
      closely.  For details of all the possible kernel options, see
      <filename>/usr/src/sys/i386/conf/NOTES</filename>.</para>

    <programlisting>#
# GENERIC -- Generic kernel configuration file for FreeBSD/i386
#
# For more information on this file, please read the handbook section on
# Kernel Configuration Files:
#
#    http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig-config.html
#
# The handbook is also available locally in /usr/share/doc/handbook
# if you've installed the doc distribution, otherwise always see the
# FreeBSD World Wide Web server (http://www.FreeBSD.org/) for the
# latest information.
#
# An exhaustive list of options and more detailed explanations of the
# device lines is also present in the ../../conf/NOTES and NOTES files.
# If you are in doubt as to the purpose or necessity of a line, check first
# in NOTES.
#
# $FreeBSD: /repoman/r/ncvs/src/sys/i386/conf/GENERIC,v 1.413 2004/08/11 01:34:18 rwatson Exp $</programlisting>

    <para>The following are the mandatory keywords required in
      <emphasis>every</emphasis> kernel you build:</para>

    </note>
    
    <programlisting># Floating point support - do not disable.
device          npx0</programlisting>
    
    <para><literal>npx0</literal> is the interface to the floating point
      math unit in &os;, which is either the hardware co-processor or
      the software math emulator.  This is <emphasis>not</emphasis>
      optional.</para>

    <programlisting># Pseudo devices
device   loop          # Network loopback</programlisting>

    <para>This is the generic loopback device for TCP/IP.  If you telnet

      you are using the <quote>traditional</quote> way for building your kernels (See the <xref linkend="kernelconfig-building">
      for more informations.).</para>

    <programlisting>options          SCHED_ULE         # ULE scheduler</programlisting>

    <para>This line allows the kernel to simulate a math co-processor if
      your computer does not have one (386 or 486SX).  If you have a
      486DX, or a 386 or 486SX (with a separate 387 or 487 chip), or
      higher (&pentium;, &pentium;&nbsp;II, etc.), you can comment this line
      out.</para>

    <para>The new scheduler for &os; that has been designed for SMP, but
      will work just fine on UP systems too.</para>
	&os; are <emphasis>not</emphasis> very accurate.  If you do not
	have a math co-processor, and you need the best accuracy, it is
	recommended that you change this option to
	<literal>GPL_MATH_EMULATE</literal> to use the GNU math support,
	which is not included by default for licensing reasons.</para>

      <para>In &os; 5.X, math emulation is disabled by default,
      as older CPUs that do not have native floating point math support
      are far less common, and in many cases not supported by the
      <filename>GENERIC</filename> kernel without other additional options.</para></note>

    <programlisting>options          INET          #InterNETworking</programlisting>



    <para>This enables the IPv6 communication protocols.</para>

    <programlisting>options          FFS          #Berkeley Fast Filesystem</programlisting>
options          FFS_ROOT     #FFS usable as root device [keep this!]</programlisting>

    <para>This is the basic hard drive Filesystem.  Leave it in if you
      boot from the hard disk.</para>

    <note><para>In &os; 5.X, <literal>FFS_ROOT</literal> is no longer
      required.</para></note>

    <programlisting>options          UFS_ACL      #Support for access control lists</programlisting>

    <para>This option, present only in &os;&nbsp;5.X, enables kernel support

      filesystems) or &man.newfs.8; (for new filesystems)
      commands.</para>

    <programlisting>options          MD_ROOT      #MD is a potential root device</programlisting>
options          MD_ROOT      #MD is a potential root device</programlisting>

    <para>This is option enables support for a memory backed virtual disk
      as root device.</para>
      of swap space that you want to take advantage of.  A perfect place
      to mount an MFS partition is on the <filename>/tmp</filename>
      directory, since many programs store temporary data here.  To mount
      an MFS RAM disk on <filename>/tmp</filename>, add the following line
      to <filename>/etc/fstab</filename>:</para>

    <informalexample>
      <programlisting>/dev/ad1s2b	/tmp mfs rw 0 0</programlisting>
    </informalexample>

    <para>Now you simply need to either reboot, or run the command
      <command>mount /tmp</command>.</para>

    <note><para>In &os; 5.X, &man.md.4;-backed UFS file systems are
      used for memory file systems rather than MFS.  Information on
      configuring memory-backed file systems may be found in the manual pages
      for &man.mdconfig.8; and &man.mdmfs.8;, and in <xref linkend="disks-virtual">.  As a result, the
      <literal>MFS</literal> option is no longer supported.</para></note>

    <indexterm>
      <primary>kernel options</primary>

      <primary>kernel options</primary>
      <secondary>NFS_ROOT</secondary>
    </indexterm>
    <programlisting>options          NFSCLIENT    # Network Filesystem Client
options          NFSSERVER    # Network Filesystem Server
options          NFS_ROOT     # NFS usable as /, requires NFSCLIENT</programlisting>

    <para>The network Filesystem.  Unless you plan to mount partitions
      from a &unix; file server over TCP/IP, you can comment these

      unmount them (and does not require <literal>MSDOSFS</literal> at
      all).</para>

    <programlisting>options          CD9660       #ISO 9660 Filesystem</programlisting>
options          CD9660_ROOT  #CD-ROM usable as root, CD9660 required</programlisting>

    <para>The ISO 9660 Filesystem for CDROMs.  Comment it out if you do
      not have a CDROM drive or only mount data CDs occasionally (since it

    <para>The process filesystem.  This is a <quote>pretend</quote>
      filesystem mounted on <filename>/proc</filename> which allows
      programs like &man.ps.1; to give you more information on what
      processes are running.  In &os; 5.X and above, use of
      <literal>PROCFS</literal> is not required under most circumstances,
      as most debugging and monitoring tools have been adapted to run
      without <literal>PROCFS</literal>.  In addition, 6.X-CURRENT kernels
      making use of <literal>PROCFS</literal> must now also include
      support for <literal>PSEUDOFS</literal>:</para>


      you do this, and &os; has trouble recognizing your SCSI devices,
      you will have to raise it back up.</para>

    <programlisting>options          GEOM_GPT            # GUID Partition Tables.</programlisting>

    <para>Allow users to grab the console, which is useful for X users.
      For example, you can create a console <application>xterm</application>
      by typing <command>xterm
      -C</command>, which will display any &man.write.1;,
      &man.talk.1;, and any other messages you receive, as well
      as any console messages sent by the kernel.</para>

    <note><para>In &os; 5.X, <literal>UCONSOLE</literal> is no
      longer required.</para></note>

    <programlisting>options          USERCONFIG          #boot -c editor</programlisting>

    <para>This option allows you to boot the configuration editor from the
      boot menu.</para>

    <programlisting>options          VISUAL_USERCONFIG   #visual boot -c editor</programlisting>

    <para>This option allows you to boot the visual configuration editor
      from the boot menu.</para>

    <para>This option brings the ability to have a large number of
      partitions on a single disk.</para>
	method.  For more information on &man.device.hints.5; please
	visit <xref linkend="device-hints">.</para></note>

    <programlisting>options          KTRACE              #ktrace(1) support</programlisting>


	these System V facilities.</para>
    </note>

    <programlisting>options          _KPOSIX_PRIORITY_SCHEDULING</programlisting>
options 	_KPOSIX_PRIORITY_SCHEDULING</programlisting>

    <para>Real-time extensions added in the 1993 &posix;.  Certain
      applications in the ports collection use these
      (such as <application>&staroffice;</application>).</para>

    <programlisting>options          PFIL_HOOKS          # pfil(9) framework</programlisting>
      provided by the <literal>_KPOSIX_PRIORITY_SCHEDULING</literal>
      option, and <literal>P1003_1B</literal> is no longer
      required.</para></note>

    <para>The pfil framework is required by the IPFILTER and IPFIREWALL
      options.</para>
      <secondary>ICMP_BANDLIM</secondary>
    </indexterm>
    <indexterm>
      <primary>Denial of Service (DoS)</primary>
    </indexterm>
    <programlisting>options		ICMP_BANDLIM		#Rate limit bad replies</programlisting>

    <programlisting>options          ADAPTIVE_GIANT      # Giant mutex is adaptive.</programlisting>
      typically want this option as it will help protect the machine from
      denial of service packet attacks.</para>

    <para>This option causes Giant to be included in the set of mutexes
      adaptively spun on.</para>
      </para></note>

    <indexterm>
      <primary>kernel options</primary>
      <secondary>SMP</secondary>
    </indexterm>
    <programlisting># To make an SMP kernel, the next two are needed
options        SMP         # Symmetric MultiProcessor Kernel
device         apic        # I/O APIC</programlisting>

    <para>The above are both required for SMP support.</para>


      IBM PS/2 (Micro Channel Architecture), &os; provides some
      limited support at this time.  For more information about the
      MCA support, see
      <filename>/usr/src/sys/i386/conf/NOTES</filename>.</para>

    <programlisting>device          eisa</programlisting>


      have these features.</para>

    <programlisting># Floppy drives
device          fdc</programlisting>

    <para>This is the floppy drive controller.</para>

    <para>This is the floppy drive controller.  <literal>fd0</literal> is
      the <devicename>A:</devicename> floppy drive, and
      <literal>fd1</literal> is the <devicename>B:</devicename>
      drive.</para>

    <programlisting>device          ata</programlisting>


    <para>This is needed along with <literal>device ata</literal> for
      ATA disk drives.</para>

    <programlisting>device          ataraid                 # ATA RAID drives</programlisting>

    <para>This is needed along with <literal>device ata</literal> for
      ATA RAID drives.</para>

    <programlisting><anchor id="kernelconfig-atapi">
device          atapicd                 # ATAPI CDROM drives</programlisting>


    <para>This makes the controller number static (like the old driver) or
      else the device numbers are dynamically allocated.</para>

    <programlisting># ATA and ATAPI devices
device          ata0        at isa? port IO_WD1 irq 14
device          ata1        at isa? port IO_WD2 irq 15</programlisting>

    <para>Use the above for older, non-PCI systems.</para>

    <programlisting># SCSI Controllers
device          ahb        # EISA AHA1742 family
device          ahc        # AHA2940 and onboard AIC7xxx devices
device          ahd        # AHA39320/29320 and onboard AIC79xx devices
device          amd        # AMD 53C974 (Teckram DC-390(T))
device          dpt        # DPT Smartcache - See LINT for options!
device          isp        # Qlogic family
device          mpt        # LSI-Logic MPT-Fusion
device          ncr        # NCR/Symbios Logic
device          sym        # NCR/Symbios Logic (newer chipsets + those of `ncr')
device          trm        # Tekram DC395U/UW/F DC315U adapters

device          adv        # Advansys SCSI adapters
device          adw        # Advansys wide SCSI adapters
device          aha        # Adaptec 154x SCSI adapters
device          aic        # Adaptec 15[012]x SCSI adapters, AIC-6[23]60.
device          bt         # Buslogic/Mylex MultiMaster SCSI adapters

device          ncv        # NCR 53C500
device          nsp        # Workbit Ninja SCSI-3
device          stg        # TMC 18C30/18C50</programlisting>

    <para>SCSI controllers.  Comment out any you do not have in your
      system.  If you have an IDE only system, you can remove these


    <programlisting># SCSI peripherals
device          scbus      # SCSI bus (required)
device          ch         # SCSI media changers
device          da         # Direct Access (disks)
device          sa         # Sequential Access (tape etc)
device          cd         # CD
device          pass       # Passthrough device (direct SCSI access)
device          ses        # SCSI Environmental Services (and SAF-TE)</programlisting>

    <para>SCSI peripherals.  Again, comment out any you do not have, or if
      you have only IDE hardware, you can remove them completely.</para>

	drivers are included in the kernel configuration.</para>
    </note>

    <programlisting># RAID controllers interfaced to the SCSI subsystem
device          ida        # Compaq Smart RAID
device          amr        # AMI MegaRAID
device          asr        # DPT SmartRAID V, VI and Adaptec SCSI RAID
device          ciss       # Compaq Smart RAID 5*
device          dpt        # DPT Smartcache III, IV - See NOTES for options
device          iir        # Intel Integrated RAID
device          ips        # IBM (Adaptec) ServeRAID
device          mly        # Mylex AcceleRAID/eXtremeRAID
device          twa        # 3ware 9000 series PATA/SATA RAID

# RAID controllers
device          aac        # Adaptec FSA RAID
device          aacp       # SCSI passthrough for aac (requires CAM)
device          ida        # Compaq Smart RAID
device          mlx        # Mylex DAC960 family
device          pst        # Promise Supertrak SX6000
device          twe        # 3ware ATA RAID</programlisting>

    <para>Supported RAID controllers.  If you do not have any of these,
      you can comment them out or remove them.</para>

    <programlisting>device          atkbdc	   # AT keyboard controller</programlisting>
device          atkbdc0    at isa? port IO_KBD</programlisting>

    <para>The keyboard controller (<literal>atkbdc</literal>) provides I/O
      services for the AT keyboard and PS/2 style pointing devices.  This

      (<literal>atkbd</literal>) and the PS/2 pointing device driver
      (<literal>psm</literal>).</para>

    <programlisting>device          atkbd	   # AT keyboard</programlisting>

    <para>The <literal>atkbd</literal> driver, together with
      <literal>atkbdc</literal> controller, provides access to the AT 84
      keyboard or the AT enhanced keyboard which is connected to the AT
      keyboard controller.</para>

    <programlisting>device          psm	   	# PS/2 mouse</programlisting>

    <para>Use this device if your mouse plugs into the PS/2 mouse
      port.</para>

    <programlisting>device          vga	   # VGA video card driver</programlisting>

    <para>The video card driver.</para>

    <programlisting>device          splash	   # Splash screen and screen saver support</programlisting>
device          splash</programlisting>

    <para>Splash screen at start up!  Screen savers require this
      too.  Use the line <literal>pseudo-device splash</literal> with
      &os;&nbsp;4.X.</para>

    <programlisting># syscons is the default console driver, resembling an SCO console
device          sc</programlisting>

    <para><literal>sc</literal> is the default console driver, which
      resembles a SCO console.  Since most full-screen programs access the
      console through a terminal database library like
      <filename>termcap</filename>, it should not matter whether you use
      this or <literal>vt</literal>, the <literal>VT220</literal>
      compatible console driver.  When you log in, set your
      <envar>TERM</envar> variable to <literal>scoansi</literal> if
      full-screen programs have trouble running under this console.</para>

    <programlisting># Enable this and PCVT_FREEBSD for pcvt vt220 compatible console driver
#device          vt
#options         XSERVER          # support for X server on a vt console
#options         FAT_CURSOR       # start with block cursor</programlisting>
# If you have a ThinkPAD, uncomment this along with the rest of the PCVT lines
#options         PCVT_SCANSET=2   # IBM keyboards are non-std</programlisting>

    <para>This is a VT220-compatible console driver, backward compatible to
      VT100/102.  It works well on some laptops which have hardware
      incompatibilities with <literal>sc</literal>.  Also set your
      <envar>TERM</envar> variable to <literal>vt100</literal> or
      <literal>vt220</literal> when you log in.  This driver might also
      prove useful when connecting to a large number of different machines
      over the network, where <filename>termcap</filename> or
      <filename>terminfo</filename> entries for the <literal>sc</literal>
      device are often not available &mdash; <literal>vt100</literal>
      should be available on virtually any platform.</para>

    <programlisting># Power management support (see NOTES for more options)
#device          apm</programlisting>

    <para>Advanced Power Management support.  Useful for laptops.</para>

    <note>
       <para>In &os; 5.X and above this is disabled in
	 <filename>GENERIC</filename> by default.</para>
    </note>

    <programlisting>#Add suspend/resume support for the i8254.
device		pmtimer</programlisting>

    <para>Timer device driver for power management events, such as APM and
      ACPI.</para>


    <programlisting># PCCARD (PCMCIA) support
# PCMCIA and cardbus bridge support
device          cbb             # cardbus (yenta) bridge
device          pccard          # PC Card (16-bit) bus
device          cardbus         # CardBus (32-bit) bus</programlisting>

    <para>PCMCIA support.  You want this if you are using a
      laptop.</para>

    <programlisting># Serial (COM) ports
device		sio		# 8250, 16[45]50 based serial ports</programlisting>
device          sio1     at isa? port IO_COM2 irq 3
device          sio2     at isa? disable port IO_COM3 irq 5
device          sio3     at isa? disable port IO_COM4 irq 9</programlisting>

    <para>These are the serial ports referred to as <devicename>COM</devicename> ports
      in the &ms-dos/&windows; world.</para>

    <note>

    </note>

    <programlisting># Parallel port
device          ppc</programlisting>

    <para>This is the ISA-bus parallel port interface.</para>


      <literal>scbus</literal> and <literal>da</literal> support.  Best
      performance is achieved with ports in EPP 1.9 mode.</para>

    <programlisting>#device          puc</programlisting>

    <para>Uncomment this device if you have a <quote>dumb</quote> serial or
      parallel PCI card that is supported by the &man.puc.4 glue driver.
      </para>

    <programlisting># PCI Ethernet NICs.
device          de         # DEC/Intel DC21x4x (<quote>Tulip</quote>)
device          em         # Intel PRO/1000 adapter Gigabit Ethernet Card
device          ixgb       # Intel PRO/10GbE Ethernet Card
device          txp        # 3Com 3cR990 (<quote>Typhoon</quote>)
device          vx         # 3Com 3c590, 3c595 (<quote>Vortex</quote>)</programlisting>

    <para>Various PCI network card drivers.  Comment out or remove any of
      these not present in your system.</para>

      by an individual driver.</para>

    <programlisting>device          dc         # DEC/Intel 21143 and various workalikes
device          bfe        # Broadcom BCM440x 10/100 Ethernet
device          bge        # Broadcom BCM570xx Gigabit Ethernet
device          dc         # DEC/Intel 21143 and various workalikes
device          fxp        # Intel EtherExpress PRO/100B (82557, 82558)
device          pcn        # AMD Am79C97x PCI 10/100 (precedence over 'lnc')
device          re         # RealTek 8139C+/8169/8169S/8110S
device          rl         # RealTek 8129/8139
device          sf         # Adaptec AIC-6915 (<quote>Starfire</quote>)
device          sis        # Silicon Integrated Systems SiS 900/SiS 7016
device          sk         # SysKonnect SK-984x & SK-982x gigabit Ethernet
device          ste        # Sundance ST201 (D-Link DFE-550TX)
device          ti         # Alteon Networks Tigon I/II gigabit Ethernet
device          tl         # Texas Instruments ThunderLAN
device          tx         # SMC EtherPower II (83c170 <quote>EPIC</quote>)
device          vr         # VIA Rhine, Rhine II
device          wb         # Winbond W89C840F
device          xl         # 3Com 3c90x (<quote>Boomerang</quote>, <quote>Cyclone</quote>)</programlisting>

    <para>Drivers that use the MII bus controller code.</para>

    <programlisting># ISA Ethernet NICs.  pccard NICs included.
device          cs         # Crystal Semiconductor CS89x0 NIC
# 'device ed' requires 'device miibus'
device          ed         # NE[12]000, SMC Ultra, 3c503, DS8390 cards
device          ex         # Intel EtherExpress Pro/10 and Pro/10+
device          ep         # Etherlink III based cards
device          fe         # Fujitsu MB8696x based cards
device          ie         # EtherExpress 8/16, 3C507, StarLAN 10 etc.
device          lnc        # NE2100, NE32-VL Lance Ethernet cards
device          sn         # SMC's 9000 series of Ethernet chips
device          xe         # Xircom pccard Ethernet

# ISA devices that use the old ISA shims
#device		le</programlisting>
# The probe order of these is presently determined by i386/isa/isa_compat.c.
device          ie0    at isa? port 0x300 irq 10 iomem 0xd0000
device          fe0    at isa? port 0x300
device          le0    at isa? port 0x300 irq 5 iomem 0xd0000
device          lnc0   at isa? port 0x280 irq 10 drq 0
device          cs0    at isa? port 0x300
device          sn0    at isa? port 0x300 irq 10
# requires PCCARD (PCMCIA) support to be activated
#device         xe0    at isa?</programlisting>

    <para>ISA Ethernet drivers.  See
      <filename>/usr/src/sys/i386/conf/NOTES</filename> for which cards are
      supported by which driver.</para>

    <programlisting>device   ether         # Ethernet support</programlisting>

      &os;&nbsp;4.X use the line <literal>pseudo-device
      ether</literal>.</para>

   <programlisting>device   mem            # Memory and kernel memory devices</programlisting>

    <para>The system memory devices.</para>

   <programlisting>device   io             # I/O device</programlisting>

    <para>This is a controlled security hole that allows a process to gain
      I/O privileges. This is useful in order to write userland programs
      that can handle hardware directly.</para>

   <programlisting>device   random         # Entropy device</programlisting>

    <para>Cryptographically secure random number generator.</para>

    <programlisting>device   sl            # Kernel SLIP</programlisting>

    <para><literal>sl</literal> is for SLIP support.  This has been almost
      entirely supplanted by PPP, which is easier to set up, better suited

      With &os;&nbsp;4.X use the line <literal>pseudo-device
      sl</literal>.</para>

    <programlisting>device   ppp           # Kernel PPP</programlisting>

    <para>This is for kernel PPP support for dial-up connections.  There
      is also a version of PPP implemented as a userland application that

    </note>

    <programlisting># USB support
#device         uhci       # UHCI PCI-&gt;USB interface
#device         ohci       # OHCI PCI-&gt;USB interface
device          usb        # USB Bus (required)
#device         udbp       # USB Double Bulk Pipe devices
device          ugen       # Generic
device          uhid       # <quote>Human Interface Devices</quote>
device          ukbd       # Keyboard
device          ulpt       # Printer
device          umass      # Disks/Mass storage - Requires scbus and da
device          ums        # Mouse
device          urio       # Diamond Rio 500 MP3 player
device          uscanner   # Scanners
# USB Ethernet, requires mii
device          aue        # ADMtek USB Ethernet
device          axe        # ASIX Electronics USB Ethernet
device          cue        # CATC USB Ethernet
device          kue        # Kawasaki LSI USB Ethernet
device          rue        # RealTek RTL8150 USB Ethernet</programlisting>

    <para>Support for various USB devices.</para>

    <programlisting># FireWire support
device          firewire   # FireWire bus code
device          sbp        # SCSI over FireWire (Requires scbus and da)
device          fwe        # Ethernet over FireWire (non-standard!)</programlisting>

    <para>Support for Firewire devices.</para>

    <para>For more information and additional devices supported by
      &os;, see
      <filename>/usr/src/sys/i386/conf/NOTES</filename>.</para>

      <sect2>
        <title>Large Memory Configurations (<acronym>PAE</acronym>)</title>

Return to bug 70674