Fedora kernel-2.6.17-1.2142_FC4 patched with stable patch-2.6.17.4-vs2.0.2-rc26.diff
[linux-2.6.git] / Documentation / floppy.txt
index 99d3ad3..6ccab88 100644 (file)
@@ -4,7 +4,7 @@ FAQ list:
 =========
 
  A FAQ list may be found in the fdutils package (see below), and also
 =========
 
  A FAQ list may be found in the fdutils package (see below), and also
-at http://fdutils.linux.lu/FAQ.html
+at <http://fdutils.linux.lu/faq.html>.
 
 
 LILO configuration options (Thinkpad users, read this)
 
 
 LILO configuration options (Thinkpad users, read this)
@@ -13,15 +13,20 @@ LILO configuration options (Thinkpad users, read this)
  The floppy driver is configured using the 'floppy=' option in
 lilo. This option can be typed at the boot prompt, or entered in the
 lilo configuration file.
  The floppy driver is configured using the 'floppy=' option in
 lilo. This option can be typed at the boot prompt, or entered in the
 lilo configuration file.
- Example: If your kernel is called linux-2.2.13, type the following line
+
+ Example: If your kernel is called linux-2.6.9, type the following line
 at the lilo boot prompt (if you have a thinkpad):
 at the lilo boot prompt (if you have a thinkpad):
- linux-2.2.13 floppy=thinkpad
+
+ linux-2.6.9 floppy=thinkpad
+
 You may also enter the following line in /etc/lilo.conf, in the description
 You may also enter the following line in /etc/lilo.conf, in the description
-of linux-2.2.13:
+of linux-2.6.9:
+
  append = "floppy=thinkpad"
 
  Several floppy related options may be given, example:
  append = "floppy=thinkpad"
 
  Several floppy related options may be given, example:
- linux-2.2.13 floppy=daring floppy=two_fdc
+
+ linux-2.6.9 floppy=daring floppy=two_fdc
  append = "floppy=daring floppy=two_fdc"
 
  If you give options both in the lilo config file and on the boot
  append = "floppy=daring floppy=two_fdc"
 
  If you give options both in the lilo config file and on the boot
@@ -29,17 +34,25 @@ prompt, the option strings of both places are concatenated, the boot
 prompt options coming last. That's why there are also options to
 restore the default behavior.
 
 prompt options coming last. That's why there are also options to
 restore the default behavior.
 
+
+Module configuration options
+============================
+
  If you use the floppy driver as a module, use the following syntax:
  If you use the floppy driver as a module, use the following syntax:
- insmod floppy <options>
+modprobe floppy <options>
 
 Example:
 
 Example:
- insmod floppy daring two_fdc
+ modprobe floppy omnibook messages
+
+ If you need certain options enabled every time you load the floppy driver,
+you can put:
+
+ options floppy omnibook messages
+
+in /etc/modprobe.conf.
 
 
- Some versions of insmod are buggy in one way or another. If you have
-any problems (options not being passed correctly, segfaults during
-insmod), first check whether there is a more recent version.
 
 
- The floppy related options include:
+ The floppy driver related options are:
 
  floppy=asus_pci
        Sets the bit mask to allow only units 0 and 1. (default)
 
  floppy=asus_pci
        Sets the bit mask to allow only units 0 and 1. (default)
@@ -99,7 +112,7 @@ insmod), first check whether there is a more recent version.
        master arbitration error" messages from your Ethernet card (or
        from other devices) while accessing the floppy.
 
        master arbitration error" messages from your Ethernet card (or
        from other devices) while accessing the floppy.
 
- floppy=fifo
+ floppy=usefifo
        Enables the FIFO. (default)
 
  floppy=<threshold>,fifo_depth
        Enables the FIFO. (default)
 
  floppy=<threshold>,fifo_depth
@@ -110,6 +123,7 @@ insmod), first check whether there is a more recent version.
        lower, the interrupt latency should be lower too (faster
        processor). The benefit of a lower threshold is less
        interrupts.
        lower, the interrupt latency should be lower too (faster
        processor). The benefit of a lower threshold is less
        interrupts.
+
        To tune the fifo threshold, switch on over/underrun messages
        using 'floppycontrol --messages'. Then access a floppy
        disk. If you get a huge amount of "Over/Underrun - retrying"
        To tune the fifo threshold, switch on over/underrun messages
        using 'floppycontrol --messages'. Then access a floppy
        disk. If you get a huge amount of "Over/Underrun - retrying"
@@ -120,6 +134,7 @@ insmod), first check whether there is a more recent version.
        fifo values without rebooting the machine for each test. Note
        that you need to do 'floppycontrol --messages' every time you
        re-insert the module.
        fifo values without rebooting the machine for each test. Note
        that you need to do 'floppycontrol --messages' every time you
        re-insert the module.
+
        Usually, tuning the fifo threshold should not be needed, as
        the default (0xa) is reasonable.
 
        Usually, tuning the fifo threshold should not be needed, as
        the default (0xa) is reasonable.
 
@@ -128,6 +143,7 @@ insmod), first check whether there is a more recent version.
        you have more than two floppy drives (only two can be
        described in the physical CMOS), or if your BIOS uses
        non-standard CMOS types. The CMOS types are:
        you have more than two floppy drives (only two can be
        described in the physical CMOS), or if your BIOS uses
        non-standard CMOS types. The CMOS types are:
+
                0 - Use the value of the physical CMOS
                1 - 5 1/4 DD
                2 - 5 1/4 HD
                0 - Use the value of the physical CMOS
                1 - 5 1/4 DD
                2 - 5 1/4 HD
@@ -136,6 +152,7 @@ insmod), first check whether there is a more recent version.
                5 - 3 1/2 ED
                6 - 3 1/2 ED
               16 - unknown or not installed
                5 - 3 1/2 ED
                6 - 3 1/2 ED
               16 - unknown or not installed
+
        (Note: there are two valid types for ED drives. This is because 5 was
        initially chosen to represent floppy *tapes*, and 6 for ED drives.
        AMI ignored this, and used 5 for ED drives. That's why the floppy
        (Note: there are two valid types for ED drives. This is because 5 was
        initially chosen to represent floppy *tapes*, and 6 for ED drives.
        AMI ignored this, and used 5 for ED drives. That's why the floppy
@@ -188,7 +205,6 @@ insmod), first check whether there is a more recent version.
           in some more extreme cases."
 
 
           in some more extreme cases."
 
 
-
 Supporting utilities and additional documentation:
 ==================================================
 
 Supporting utilities and additional documentation:
 ==================================================
 
@@ -201,10 +217,10 @@ It also contains additional documentation about the floppy driver.
 The latest version can be found at fdutils homepage:
  http://fdutils.linux.lu
 
 The latest version can be found at fdutils homepage:
  http://fdutils.linux.lu
 
-The fdutils-5.4 release can be found at:
- http://fdutils.linux.lu/fdutils-5.4.src.tar.gz
- http://www.tux.org/pub/knaff/fdutils/fdutils-5.4.src.tar.gz
- ftp://metalab.unc.edu/pub/Linux/utils/disk-management/fdutils-5.4.src.tar.gz
+The fdutils releases can be found at:
+ http://fdutils.linux.lu/download.html
+ http://www.tux.org/pub/knaff/fdutils/
+ ftp://metalab.unc.edu/pub/Linux/utils/disk-management/
 
 Reporting problems about the floppy driver
 ==========================================
 
 Reporting problems about the floppy driver
 ==========================================
@@ -219,3 +235,11 @@ sure to mention also the type of the filesystem in the subject line.
  Be sure to read the FAQ before mailing/posting any bug reports!
 
  Alain
  Be sure to read the FAQ before mailing/posting any bug reports!
 
  Alain
+
+Changelog
+=========
+
+10-30-2004 :   Cleanup, updating, add reference to module configuration.
+               James Nelson <james4765@gmail.com>
+
+6-3-2000 :     Original Document