patch-2.1.66 linux/Documentation/Configure.help

Next file: linux/Documentation/devices.tex
Previous file: linux/Documentation/00-INDEX
Back to the patch index
Back to the overall index

diff -u --recursive --new-file v2.1.65/linux/Documentation/Configure.help linux/Documentation/Configure.help
@@ -5009,22 +5009,278 @@
   support package.
   If you want to use the qic02conf program, say Y.
 
-Ftape (QIC-80/Travan) support
+Floppy tape drive (QIC-80/40/3010/3020/TR-1/TR-2/TR-3) support
 CONFIG_FTAPE
-  If you have a tape drive that is connected to your floppy
-  controller, say Y here. Some tape drives (like the Iomega Ditto
-  3200) come with a high speed controller of its own.  These drives
-  (and their companion controller) are also supported by this driver,
-  so say Y if you have one. If you have a special controller (such as
-  the CMS FC-10, FC-20, Iomega Mach-II, or Ditto Dash), you must say Y
-  here and configure it by editing the file
-  drivers/char/ftape/Makefile. If you want to use such a tape drive on
-  a PCI-bus based system, please read the file
-  drivers/char/ftape/README.PCI. This driver is also available as a
-  runtime loadable module ( = code which can be inserted in and
-  removed from the running kernel whenever you want). If you want to
-  compile it as a module, say M here and read
-  Documentation/modules.txt. The module will be called ftape.o.
+    If you have a tape drive that is connected to your floppy
+  controller, say `Y' here. Some tape drives (like the Seagate "Tape
+  Store 3200" or the Iomega "Ditto 3200" or the Exabyte "Eagle TR-3")
+  come with a "high speed" controller of their own. These drives (and
+  their companion controllers) are also supported.
+    If you have a special controller (such as the CMS FC-10, FC-20,
+  Mountain Mach-II, or any controller that is based on the Intel 82078
+  FDC like the high speed controllers by Seagate and Exabyte and
+  Iomega's "Ditto Dash") you must configure it by selecting the
+  appropriate entries from the "Floppy tape controllers" sub-menu and
+  possibly modify the default values for the IRQ and DMA channel and
+  the IO base in ftape's configuration menu. If you want to use your
+  floppy tape drive on a PCI-bus based system, please read the file
+  `./drivers/char/ftape/README.PCI'.
+    The ftape kernel driver is also available as a runtime loadable
+  module ( = code which can be inserted in and removed from the
+  running kernel whenever you want). If you want to compile it as a
+  module, say `M' here and read `./Documentation/modules.txt'.
+    Note that the `Ftape-HOWTO' is out of date (sorry), but there is a
+  web page with more recent documentation at
+  `http://www-math.math.rwth-aachen.de/~LBFM/claus/ftape/'. This page
+  always contains the latest release of the ftape driver and useful
+  information (backup software, ftape related patches and
+  documentation, FAQ). The Ftape-HOWTO still contains useful
+  information, though, but documents the older 2.08 version of ftape,
+  whereas this version of ftape is 3.04.
+    Note that the file system interface has changed quite a lot
+  compared to previous versions of ftape. Please read
+  `./Documentation/ftape.txt'
+
+The file system interface for ftape
+CONFIG_ZFTAPE
+    Normally, you want to say `Y' or `M'. DON'T say `N' here or you
+  WON'T BE ABLE TO USE YOUR FLOPPY TAPE DRIVE.
+    The ftape module itself no longer contains the routines necessary
+  to interface with the kernel VFS layer (i.e. to actually write data
+  to and read data from the tape drive). Instead the file system
+  interface (i.e. the hardware independent part of the driver) has
+  been moved to a separate module.
+    If you say `M' zftape will be compiled as as a runtime loadable
+  module ( = code which can be inserted in and removed from the
+  running kernel whenever you want). In this case you should read
+  `./Documentation/modules.txt'.
+    There will also be another module called `zft-compressor.o' which
+  contains code to support user transparent on-the-fly compression
+  based on Ross William's lzrw3 algorithm. `zft-compressor.o' will be
+  compiled as a runtime loadable module only. If you have enabled
+  auto-loading of kernel modules via `kerneld' (i.e. have said `Y' to
+  CONFIG_KERNELD) then `zft-compressor.o' will be loaded automatically
+  by zftape when needed.
+    Despite of its name zftape does NOT use compression by
+  default. The file `./Documentation/ftape.txt' contains a short
+  description of the most important changes in the file system
+  interface compared to previous versions of ftape. The ftape home
+  page `http://www-math.math.rwth-aachen.de/~LBFM/claus/ftape/'
+  contains further information. IMPORTANT NOTE: zftape can read
+  archives created by previous versions of ftape and provide file mark
+  support (i.e. fast skipping between tape archives) but previous
+  version of ftape will lack file mark support when reading archives
+  produced by zftape.
+
+Builtin on-the-fly compression for zftape, based on lzrw3
+CONFIG_ZFT_COMPRESSOR
+    This module implements builtin on-the-fly compression for ftape's
+  file system interface zftape. `zft-compressor.o' is compiled as a
+  runtime loadable module only and will be loaded by zftape on demand
+  if support for auto-loading of modules via `kerneld' has been
+  enabled (CONFIG_KERNELD).
+
+Default block size for zftape
+CONFIG_ZFT_DFLT_BLK_SZ
+    If unsure leave this at its default value, i.e. 10240.  Note that
+  you specify only the default block size here. The block size can be
+  changed at run time using the MTSETBLK tape operation with the
+  MTIOCTOP ioctl (i.e. with "mt -f /dev/qft0 setblk #BLKSZ" from the
+  shell command line).
+    The probably most striking difference between zftape and previous
+  versions of ftape is the fact that all data must be written or read
+  in multiples of a fixed block size. The block size defaults to
+  10240 which is what GNU tar uses. The values for the block size
+  should be either 1 or multiples of 1024 up to a maximum value of
+  63488 (i.e. 62k). If you specify `1' then zftape's builtin
+  compression will be disabled.
+    Reasonable values are `10240' (GNU tar's default block size),
+  `5120' (afio's default block size), `32768' (default block size some
+  backup programs assume for SCSI tape drives) or `1' (no restriction
+  on block size, but disables builtin compression).
+
+Number of DMA buffers
+CONFIG_FT_NR_BUFFERS
+    Please leave this at `3"' unless you REALLY know what you are
+  doing. It is not necessary to change this value. Values below 3 make
+  the proper use of ftape impossible, values greater than 3 are waste
+  of memory. You can change the amount of DMA memory used by ftape at
+  runtime with "mt -f /dev/qft0 setdrvbuffer #NUMBUFFERS". Each buffer
+  wastes 32kb of memory. Please note that this memory cannot be
+  swapped out.
+
+Procfs entry for ftape
+CONFIG_FT_PROC_FS
+    Optional. Saying `Y' will result in creation of a file
+  `/proc/ftape' under the proc file system. This files can be viewed
+  with your favorite pager (i.e. use "more /proc/ftape/history" or
+  "less /proc/ftape/history" or simply "cat /proc/ftape/history"). The
+  file will contain some status information about the inserted
+  cartridge, the kernel driver, your tape drive, the floppy disk
+  controller and the error history for the most recent use of the
+  kernel driver. Saying `Y' will enlarge the size of the ftape driver
+  by approximately 2k.
+  WARNING: When compiling ftape as a module (i.e. saying `M' to
+  `CONFIG_FTAPE') it is dangerous to use ftape's proc file system
+  interface. Accessing `/proc/ftape' while the module is unloaded will
+  result in a kernel Oops. This cannot be fixed from inside ftape.
+
+Controlling the amount of debugging output of ftape
+CONFIG_FT_NORMAL_DEBUG
+    This option controls the amount of debugging output the ftape driver
+  is ABLE to produce; it does not increase or diminish the debugging
+  level itself. If unsure, leave this at its default setting,
+  i.e. choose "Normal".
+    Ftape can print lots of debugging messages to the system console
+  resp. kernel log files. Reducing the amount of possible debugging
+  output reduces the size of the kernel module by some kb, so it might
+  be a good idea to use "None" for emergency boot floppies.
+    If you want to save memory then the following strategy is
+  recommended: leave this option at its default setting "Normal" until
+  you know that the driver works as expected, afterwards reconfigure
+  the kernel, this time specifying "Reduced" or "None" and recompile
+  and install the kernel as usual. Note that choosing "Excessive"
+  debugging output does not increase the amount of debugging output
+  printed to the console but only makes it possible to produce
+  "Excessive" debugging output.
+    Please read `./Documentation/ftape.txt' for a short description
+  how to control the amount of debugging output.
+
+The floppy drive controller for ftape
+CONFIG_FT_STD_FDC
+    Only change this setting if you have a special controller. If you
+  didn't plug any add-on card into your computer system but just
+  plugged the floppy tape cable into the already existing floppy drive
+  controller then you don't want to change the default setting,
+  i.e. choose "Standard".
+  Choose "MACH-2" if you have a Mountain Mach-2 controller.
+  Choose "FC-10/FC-20" if you have a Colorado FC-10 or FC-20
+  controller.
+  Choose "Alt/82078" if you have another controller that is located at
+  an IO base address different from the standard floppy drive
+  controller's base address of `0x3f0', or uses an IRQ (interrupt)
+  channel different from `6', or a DMA channel different from
+  `2'. This is necessary for any controller card that is based on
+  Intel's 82078 FDC such as Seagate's, Exabyte's and Iomega's "high
+  speed" controllers.
+    If you choose something other than "Standard" then please make
+  sure that the settings for the IO base address and the IRQ and DMA
+  channel in the configuration menus below are correct. Use the manual
+  of your tape drive to determine the correct settings!
+    If you are already successfully using your tape drive with another
+  operating system then you definitely should use the same settings
+  for the IO base, the IRQ and DMA channel that have proven to work
+  with that other OS.
+    Note that this menu lets you specify only the default setting for
+  the hardware setup. The hardware configuration can be changed at
+  boot time (when ftape is compiled into the kernel, i.e. if you
+  have said `Y' to `CONFIG_FTAPE') or module load time (i.e. if you
+  have said `M' to `CONFIG_FTAPE').
+    Please read also the file `./Documentation/ftape.txt' which
+  contains a short description of the parameters that can be set at
+  boot or load time. If you want to use your floppy tape drive on a
+  PCI-bus based system, please read the file
+  `./drivers/char/ftape/README.PCI'.
+
+IO base of the floppy disk controller used with Ftape
+CONFIG_FT_FDC_BASE
+    You don't need to specify a value if the following default
+  settings for the base IO address are correct:
+  <<< MACH-2     : 0x1E0 >>>
+  <<< FC-10/FC-20: 0x180 >>>
+  <<< Secondary  : 0x370 >>>
+  Secondary refers to a secondary FDC controller like the "high speed"
+  controllers delivered by Seagate or Exabyte or Iomega's Ditto Dash.
+    Please make sure that the setting for the IO base address
+  specified here is correct. USE THE MANUAL OF YOUR TAPE DRIVE OR
+  CONTROLLER CARD TO DETERMINE THE CORRECT SETTING. If you are already
+  successfully using the tape drive with another operating system then
+  you definitely should use the same settings for the IO base that has
+  proven to work with that other OS.
+    Note that this menu lets you specify only the default setting for
+  the IO base. The hardware configuration can be changed at boot time
+  (when ftape is compiled into the kernel, i.e. if you specify `Y' to
+  `CONFIG_FTAPE') or module load time (i.e. if you have say `M' to
+  `CONFIG_FTAPE').
+    Please read also the file `./Documentation/ftape.txt' which
+  contains a short description of the parameters that can be set at
+  boot or load time.
+  
+IRQ channel for the floppy disk controller used with Ftape
+CONFIG_FT_FDC_IRQ
+    You don't need to specify a value if the following default
+  settings for the interrupt channel are correct:
+  <<< MACH-2     : 6 >>>
+  <<< FC-10/FC-20: 9 >>>
+  <<< Secondary  : 6 >>>
+  Secondary refers to secondary a FDC controller like the "high speed"
+  controllers delivered by Seagate or Exabyte or Iomega's Ditto Dash.
+    Please make sure that the setting for the IO base address
+  specified here is correct. USE THE MANUAL OF YOUR TAPE DRIVE OR
+  CONTROLLER CARD TO DETERMINE THE CORRECT SETTING. If you are already
+  successfully using the tape drive with another operating system then
+  you definitely should use the same settings for the IO base that has
+  proven to work with that other OS.
+    Note that this menu lets you specify only the default setting for
+  the IRQ channel. The hardware configuration can be changed at boot
+  time (when ftape is compiled into the kernel, i.e. if you specify
+  `Y' to `CONFIG_FTAPE') or module load time (i.e. if you have say `M'
+  to `CONFIG_FTAPE').
+    Please read also the file `./Documentation/ftape.txt' which
+  contains a short description of the parameters that can be set at
+  boot or load time.
+  
+DMA channel for the floppy disk controller used with Ftape
+CONFIG_FT_FDC_DMA
+    You don't need to specify a value if the following default
+  settings for the DMA channel are correct:
+  <<< MACH-2     : 2 >>>
+  <<< FC-10/FC-20: 3 >>>
+  <<< Secondary  : 2 >>>
+  Secondary refers to a secondary FDC controller like the "high speed"
+  controllers delivered by Seagate or Exabyte or Iomega's Ditto Dash.
+    Please make sure that the setting for the IO base address
+  specified here is correct. USE THE MANUAL OF YOUR TAPE DRIVE OR
+  CONTROLLER CARD TO DETERMINE THE CORRECT SETTING. If you are already
+  successfully using the tape drive with another operating system then
+  you definitely should use the same settings for the IO base that has
+  proven to work with that other OS.
+    Note that this menu lets you specify only the default setting for
+  the DMA channel. The hardware configuration can be changed at boot
+  time (when ftape is compiled into the kernel, i.e. if you specify
+  `Y' to `CONFIG_FTAPE') or module load time (i.e. if you have say `M'
+  to `CONFIG_FTAPE').
+    Please read also the file `./Documentation/ftape.txt' which
+  contains a short description of the parameters that can be set at
+  boot or load time.
+
+FDC FIFO Threshold before requesting DMA service
+CONFIG_FT_FDC_THR
+    Set the FIFO threshold of the FDC. If this is higher the DMA
+  controller may serve the FCD after a higher latency time. If this is
+  lower, less DMA transfers occur leading to less bus contention.
+    You may try to tune this if ftape annoys you with "reduced data
+  rate because of excessive overrun errors" messages. However, this
+  doesn't seem to have too much an effect.
+  If unsure, don't touch the initial value, i.e. leave it at "8".
+
+FDC maximum data rate
+CONFIG_FT_FDC_MAX_RATE
+    With some mother board/FDC combinations ftape will not be able to
+  run your FDC/tape drive combination at the highest available
+  speed. If this is the case you'll encounter "reduced data rate
+  because of excessive overrun errors" messages and lots of retries
+  before ftape finally decides to reduce the data rate.
+    In this case it might be desirable to tell ftape beforehand that
+  it need not try to run the tape drive at the highest available
+  speed. If unsure, leave this disabled, i.e. leave it at 2000
+  bits/sec.
+
+Main CPU frequency, only for DEC alpha machine
+CONFIG_FT_ALPHA_CLOCK
+  On some DEC Alpha machines the CPU clock frequency cannot be
+  determined automatically, so you need to specify it here ONLY if
+  running a DEC Alpha, otherwise this setting has no effect.
 
 Zilog serial support
 CONFIG_SUN_ZS
@@ -6342,3 +6598,10 @@
 # LocalWords:  dataless kerneltype SYSNAME Netbeui Comtrol Rocketport palmtop
 # LocalWords:  nvram SYSRQ SysRq PrintScreen sysrq NVRAMs NvRAM Shortwave RTTY
 # LocalWords:  HFMODEM shortwave Sitor Amtor Pactor GTOR hfmodem hayes TX TMOUT
+# LocalWords:  QIC TR CONFIG FTAPE Iomega CMS FC FDC Exabyte Iomega's DFLT
+# LocalWords:  tapedrive THR FCD IRQ DMA SZ PCI ftape README txt HOWTO
+# LocalWords:  http www rwth aachen LBFM claus FAQ mt ZFTAPE VFS
+# LocalWords:  zftape zft William's lzrw kerneld BLK zftape's tar's
+# LocalWords:  afio's MTSETBLK MTIOCTOP dev qft setblk BLKSZ NR
+# LocalWords:  setdrvbuffer kb NUMBUFFERS Procfs PROC FS proc resp STD
+# LocalWords:  Alt LocalWords
FUNET's LINUX-ADM group, linux-adm@nic.funet.fi
TCL-scripts by Sam Shen, slshen@lbl.gov