Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 5d7db049 authored by Stefan Richter's avatar Stefan Richter
Browse files

firewire, ieee1394: update Kconfig help 



Update the Kconfig help texts of both stacks to encourage a general move
from the older to the newer drivers.  However, do not label ieee1394 as
"Obsolete" yet, as the newer drivers have not been deployed as default
stack in the majority of Linux distributions yet, and those who start
doing so now may still want to install the old drivers as fallback for
unforeseen issues.

Since Linux 2.6.32, FireWire audio devices can be driven by the newer
firewire driver stack too, hence remove an outdated comment about audio
devices.  Also remove comments about library versions since the 2nd
generation of libraw1394 and libdc1394 is now in common use; details on
library versions can be read at the wiki link from the help texts.

Signed-off-by: default avatarStefan Richter <stefanr@s5r6.in-berlin.de>
parent 958a29cb

drivers/Kconfig

+1 −1
Original line number Original line Diff line number Diff line
@@ -28,7 +28,7 @@ source "drivers/md/Kconfig" 




source "drivers/message/fusion/Kconfig"

source "drivers/message/fusion/Kconfig"





source "drivers/ieee1394/Kconfig"

source "drivers/firewire/Kconfig"





source "drivers/message/i2o/Kconfig"

source "drivers/message/i2o/Kconfig"

drivers/firewire/Kconfig

+13 −31
Original line number Original line Diff line number Diff line 
menu "IEEE 1394 (FireWire) support"

	depends on PCI || BROKEN

	# firewire-core does not depend on PCI but is

	# not useful without PCI controller driver



comment "You can enable one or both FireWire driver stacks."

comment "You can enable one or both FireWire driver stacks."

comment "See the help texts for more information."

comment "The newer stack is recommended."





config FIREWIRE

config FIREWIRE

	tristate "FireWire driver stack"

	tristate "FireWire driver stack"
@@ -15,16 +20,6 @@ config FIREWIRE 
	  To compile this driver as a module, say M here: the module will be

	  To compile this driver as a module, say M here: the module will be

	  called firewire-core.

	  called firewire-core.





	  This module functionally replaces ieee1394, raw1394, and video1394.

	  To access it from application programs, you generally need at least

	  libraw1394 v2.  IIDC/DCAM applications need libdc1394 v2.

	  No libraries are required to access storage devices through the

	  firewire-sbp2 driver.



	  NOTE:

	  FireWire audio devices currently require the old drivers (ieee1394,

	  ohci1394, raw1394).



config FIREWIRE_OHCI

config FIREWIRE_OHCI

	tristate "OHCI-1394 controllers"

	tristate "OHCI-1394 controllers"

	depends on PCI && FIREWIRE

	depends on PCI && FIREWIRE
@@ -34,22 +29,7 @@ config FIREWIRE_OHCI 
	  is the only chipset in use, so say Y here.

	  is the only chipset in use, so say Y here.





	  To compile this driver as a module, say M here:  The module will be

	  To compile this driver as a module, say M here:  The module will be

	  called firewire-ohci.  It replaces ohci1394 of the classic IEEE 1394

	  called firewire-ohci.

	  stack.



	  NOTE:

	  If you want to install firewire-ohci and ohci1394 together, 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.





config FIREWIRE_OHCI_DEBUG

config FIREWIRE_OHCI_DEBUG

	bool

	bool
@@ -66,8 +46,7 @@ config FIREWIRE_SBP2 
	  like scanners.

	  like scanners.





	  To compile this driver as a module, say M here:  The module will be

	  To compile this driver as a module, say M here:  The module will be

	  called firewire-sbp2.  It replaces sbp2 of the classic IEEE 1394

	  called firewire-sbp2.

	  stack.





	  You should also enable support for disks, CD-ROMs, etc. in the SCSI

	  You should also enable support for disks, CD-ROMs, etc. in the SCSI

	  configuration section.

	  configuration section.
@@ -83,5 +62,8 @@ config FIREWIRE_NET 
	  NOTE, this driver is not stable yet!

	  NOTE, this driver is not stable yet!





	  To compile this driver as a module, say M here:  The module will be

	  To compile this driver as a module, say M here:  The module will be

	  called firewire-net.  It replaces eth1394 of the classic IEEE 1394

	  called firewire-net.

	  stack.
 


source "drivers/ieee1394/Kconfig"



endmenu

drivers/ieee1394/Kconfig

+42 −17
Original line number Original line Diff line number Diff line 
menu "IEEE 1394 (FireWire) support"

	depends on PCI || BROKEN



source "drivers/firewire/Kconfig"



config IEEE1394

config IEEE1394

	tristate "Legacy alternative FireWire driver stack"

	tristate "Legacy alternative FireWire driver stack"

	depends on PCI || BROKEN

	depends on PCI || BROKEN
@@ -16,8 +11,13 @@ config IEEE1394 
	  is the core support only, you will also need to select a driver for

	  is the core support only, you will also need to select a driver for

	  your IEEE 1394 adapter.

	  your IEEE 1394 adapter.





	  To compile this driver as a module, say M here: the

	  To compile this driver as a module, say M here: the module will be

	  module will be called ieee1394.

	  called ieee1394.



	  NOTE:

	  ieee1394 is superseded by the newer firewire-core driver.  See

	  http://ieee1394.wiki.kernel.org/index.php/Juju_Migration for

	  further information on how to switch to the new FireWire drivers.





config IEEE1394_OHCI1394

config IEEE1394_OHCI1394

	tristate "OHCI-1394 controllers"

	tristate "OHCI-1394 controllers"
@@ -29,19 +29,23 @@ config IEEE1394_OHCI1394 
	  use one of these chipsets.  It should work with any OHCI-1394

	  use one of these chipsets.  It should work with any OHCI-1394

	  compliant card, however.

	  compliant card, however.





	  To compile this driver as a module, say M here: the

	  To compile this driver as a module, say M here: the module will be

	  module will be called ohci1394.

	  called ohci1394.





	  NOTE:

	  NOTE:

	  ohci1394 is superseded by the newer firewire-ohci driver.  See

	  http://ieee1394.wiki.kernel.org/index.php/Juju_Migration for

	  further information on how to switch to the new FireWire drivers.



	  If you want to install firewire-ohci and ohci1394 together, you

	  If you want to install firewire-ohci and ohci1394 together, you

	  should configure them only as modules and blacklist the driver(s)

	  should configure them only as modules and blacklist the driver(s)

	  which you don't want to have auto-loaded.  Add either

	  which you don't want to have auto-loaded.  Add either





	      blacklist firewire-ohci

	  or

	      blacklist ohci1394

	      blacklist ohci1394

	      blacklist video1394

	      blacklist video1394

	      blacklist dv1394

	      blacklist dv1394

	  or

	      blacklist firewire-ohci





	  to /etc/modprobe.conf or /etc/modprobe.d/* and update modprobe.conf

	  to /etc/modprobe.conf or /etc/modprobe.d/* and update modprobe.conf

	  depending on your distribution.

	  depending on your distribution.
@@ -58,8 +62,8 @@ config IEEE1394_PCILYNX 
	  Instruments PCILynx chip.  Note: this driver is written for revision

	  Instruments PCILynx chip.  Note: this driver is written for revision

	  2 of this chip and may not work with revision 0.

	  2 of this chip and may not work with revision 0.





	  To compile this driver as a module, say M here: the

	  To compile this driver as a module, say M here: the module will be

	  module will be called pcilynx.

	  called pcilynx.





	  Only some old and now very rare PCI and CardBus cards and

	  Only some old and now very rare PCI and CardBus cards and

	  PowerMacs G3 B&W contain the PCILynx controller.  Therefore

	  PowerMacs G3 B&W contain the PCILynx controller.  Therefore
@@ -79,6 +83,14 @@ config IEEE1394_SBP2 
	  You should also enable support for disks, CD-ROMs, etc. in the SCSI

	  You should also enable support for disks, CD-ROMs, etc. in the SCSI

	  configuration section.

	  configuration section.





	  To compile this driver as a module, say M here: the module will be

	  called sbp2.



	  NOTE:

	  sbp2 is superseded by the newer firewire-sbp2 driver. See

	  http://ieee1394.wiki.kernel.org/index.php/Juju_Migration for

	  further information on how to switch to the new FireWire drivers.



config IEEE1394_SBP2_PHYS_DMA

config IEEE1394_SBP2_PHYS_DMA

	bool "Enable replacement for physical DMA in SBP2"

	bool "Enable replacement for physical DMA in SBP2"

	depends on IEEE1394_SBP2 && VIRT_TO_BUS && EXPERIMENTAL

	depends on IEEE1394_SBP2 && VIRT_TO_BUS && EXPERIMENTAL
@@ -111,6 +123,11 @@ config IEEE1394_ETH1394 




	  The module is called eth1394 although it does not emulate Ethernet.

	  The module is called eth1394 although it does not emulate Ethernet.





	  NOTE:

	  eth1394 is superseded by the newer firewire-net driver. See

	  http://ieee1394.wiki.kernel.org/index.php/Juju_Migration for

	  further information on how to switch to the new FireWire drivers.



config IEEE1394_RAWIO

config IEEE1394_RAWIO

	tristate "raw1394 userspace interface"

	tristate "raw1394 userspace interface"

	depends on IEEE1394

	depends on IEEE1394
@@ -123,6 +140,11 @@ config IEEE1394_RAWIO 
	  To compile this driver as a module, say M here: the module will be

	  To compile this driver as a module, say M here: the module will be

	  called raw1394.

	  called raw1394.





	  NOTE:

	  raw1394 is superseded by the newer firewire-core driver. See

	  http://ieee1394.wiki.kernel.org/index.php/Juju_Migration for

	  further information on how to switch to the new FireWire drivers.



config IEEE1394_VIDEO1394

config IEEE1394_VIDEO1394

	tristate "video1394 userspace interface"

	tristate "video1394 userspace interface"

	depends on IEEE1394 && IEEE1394_OHCI1394

	depends on IEEE1394 && IEEE1394_OHCI1394
@@ -136,13 +158,18 @@ config IEEE1394_VIDEO1394 
	  To compile this driver as a module, say M here: the module will be

	  To compile this driver as a module, say M here: the module will be

	  called video1394.

	  called video1394.





	  NOTE:

	  video1394 is superseded by the newer firewire-core driver. See

	  http://ieee1394.wiki.kernel.org/index.php/Juju_Migration for

	  further information on how to switch to the new FireWire drivers.



config IEEE1394_DV1394

config IEEE1394_DV1394

	tristate "dv1394 userspace interface (deprecated)"

	tristate "dv1394 userspace interface (deprecated)"

	depends on IEEE1394 && IEEE1394_OHCI1394

	depends on IEEE1394 && IEEE1394_OHCI1394

	help

	help

	  The dv1394 driver is unsupported and may be removed from Linux in a

	  The dv1394 driver is unsupported and may be removed from Linux in a

	  future release.  Its functionality is now provided by raw1394 together

	  future release.  Its functionality is now provided by either

	  with libraries such as libiec61883.

	  raw1394 or firewire-core together with libraries such as libiec61883.





config IEEE1394_VERBOSEDEBUG

config IEEE1394_VERBOSEDEBUG

	bool "Excessive debugging output"

	bool "Excessive debugging output"
@@ -153,5 +180,3 @@ config IEEE1394_VERBOSEDEBUG 
	  will quickly result in large amounts of data sent to the system log.

	  will quickly result in large amounts of data sent to the system log.





	  Say Y if you really need the debugging output.  Everyone else says N.
 
	  Say Y if you really need the debugging output.  Everyone else says N.
 


endmenu