firewire: state userland requirements in Kconfig help

[linux-2.6.git] / drivers / firewire / Kconfig

diff --git a/drivers/firewire/Kconfig b/drivers/firewire/Kconfig
index 5fc56fac97006325507a1bdafdcb291d0b7707eb..fa6d6abefd4d14d9bdb8c372118a1ddbcea7b2fb 100644 (file)
--- a/drivers/firewire/Kconfig
+++ b/drivers/firewire/Kconfig
@@ -1,31 +1,31 @@
-# -*- shell-script -*-
-
-comment "An alternative FireWire stack is available with EXPERIMENTAL=y"
+comment "A new alternative FireWire stack is available with EXPERIMENTAL=y"
        depends on EXPERIMENTAL=n
 
+comment "Enable only one of the two stacks, unless you know what you are doing"
+       depends on EXPERIMENTAL
+
 config FIREWIRE
-       tristate "IEEE 1394 (FireWire) support (JUJU alternative stack, experimental)"
+       tristate "New FireWire stack, EXPERIMENTAL"
        depends on EXPERIMENTAL
+       select CRC_ITU_T
        help
-         IEEE 1394 describes a high performance serial bus, which is also
-         known as FireWire(tm) or i.Link(tm) and is used for connecting all
-         sorts of devices (most notably digital video cameras) to your
-         computer.
-
-         If you have FireWire hardware and want to use it, say Y here.  This
-         is the core support only, you will also need to select a driver for
-         your IEEE 1394 adapter.
+         This is the "Juju" FireWire stack, a new alternative implementation
+         designed for robustness and simplicity.  You can build either this
+         stack, or the old stack (the ieee1394 driver, ohci1394 etc.) or both.
+         Please read http://wiki.linux1394.org/JujuMigration before you
+         enable the new stack.
 
          To compile this driver as a module, say M here: the module will be
-         called fw-core.
+         called firewire-core.
 
-         This is the "JUJU" FireWire stack, an alternative implementation
-         designed for robustness and simplicity.  You can build either this
-         stack, or the classic stack (the ieee1394 driver, ohci1394 etc.)
-         or both.
+         This module functionally replaces ieee1394, raw1394, and video1394.
+         To access it from application programs, you generally need at least
+         libraw1394 version 2.  IIDC/DCAM applications also need libdc1394
+         version 2.  No libraries are required to access storage devices
+         through the firewire-sbp2 driver.
 
 config FIREWIRE_OHCI
-       tristate "Support for OHCI FireWire host controllers"
+       tristate "OHCI-1394 controllers"
        depends on PCI && FIREWIRE
        help
          Enable this driver if you have a FireWire controller based
@@ -33,14 +33,37 @@ config FIREWIRE_OHCI
          is the only chipset in use, so say Y here.
 
          To compile this driver as a module, say M here:  The module will be
-         called fw-ohci.
+         called firewire-ohci.  It replaces ohci1394 of the classic IEEE 1394
+         stack.
+
+         NOTE:
 
-         If you also build ohci1394 of the classic IEEE 1394 driver stack,
-         blacklist either ohci1394 or fw-ohci to let hotplug load the desired
-         driver.
+         You should only build either firewire-ohci or the old ohci1394 driver,
+         but not both.  If you nevertheless want to install both, you should
+         configure them only as modules and blacklist the driver(s) which you
+         don't want to have auto-loaded.  Add either
+
+             blacklist firewire-ohci
+         or
+             blacklist ohci1394
+             blacklist video1394
+             blacklist dv1394
+
+         to /etc/modprobe.conf or /etc/modprobe.d/* and update modprobe.conf
+         depending on your distribution.  The latter two modules should be
+         blacklisted together with ohci1394 because they depend on ohci1394.
+
+         If you have an old modprobe which doesn't implement the blacklist
+         directive, use "install modulename /bin/true" for the modules to be
+         blacklisted.
+
+config FIREWIRE_OHCI_DEBUG
+       bool
+       depends on FIREWIRE_OHCI
+       default y
 
 config FIREWIRE_SBP2
-       tristate "Support for storage devices (SBP-2 protocol driver)"
+       tristate "Storage devices (SBP-2 protocol)"
        depends on FIREWIRE && SCSI
        help
          This option enables you to use SBP-2 devices connected to a
@@ -49,12 +72,8 @@ config FIREWIRE_SBP2
          like scanners.
 
          To compile this driver as a module, say M here:  The module will be
-         called fw-sbp2.
+         called firewire-sbp2.  It replaces sbp2 of the classic IEEE 1394
+         stack.
 
          You should also enable support for disks, CD-ROMs, etc. in the SCSI
          configuration section.
-
-         If you also build sbp2 of the classic IEEE 1394 driver stack,
-         blacklist either sbp2 or fw-sbp2 to let hotplug load the desired
-         driver.
-