[PATCH] 2.4.2-ac2 Configure.help for various MTD options.

[Steven Cole <elenstev@mesatop.com>]

[-- Attachment #1: Type: text/plain, Size: 902 bytes --]

Hi Alan,

The attached patch provides Configure.help entries for the following options:

CONFIG_MTD_DEBUG
CONFIG_MTD_DEBUG_VERBOSE
CONFIG_MTD_PMC551_DEBUG
CONFIG_MTD_PHYSMAP_BUSWIDTH
CONFIG_MTD_PNC2000
CONFIG_JFFS_FS_VERBOSE

The patch also updates Configure.help for these options:

CONFIG_MTD_DOC2000
CONFIG_MTD_DOC2001
CONFIG_MTD_PMC551
CONFIG_MTD_PMC551_BUGFIX
CONFIG_MTD_CFI
CONFIG_MTD_PHYSMAP
CONFIG_MTD_OCTAGON
CONFIG_MTD_RPXLITE
CONFIG_JFFS_FS

Authorship of these additions and updates should be credited to
David Woodhouse. The information was obtained from:
ftp://ftp.uk.linux.org/pub/people/dwmw2/mtd/cfs/mtd/patches/Configure.help

I provided the merge to the Configure.help of 2.4.2-ac2, as well as some
small formatting changes to CONFIG_MTD_PMC551_BUGFIX.

This patch applies to linux-2.4.2-ac2:
I see that 2.4.2-ac3 just came out, but this should apply cleanly against it too.

Steven

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: patch-Configure.help --]
[-- Type: text/english; name="patch-Configure.help", Size: 9101 bytes --]

--- linux/Documentation/Configure.help.orig	Fri Feb 23 11:56:31 2001
+++ linux/Documentation/Configure.help	Fri Feb 23 13:20:38 2001
@@ -10197,24 +10197,60 @@
   them. It will also allow you to select individual drivers for 
   particular hardware and users of MTD device. If unsure, say N.
 
+MTD debugging support
+CONFIG_MTD_DEBUG
+  This turns on low-level debugging for the entire MTD sub-system.
+
+MTD debugging verbosity
+CONFIG_MTD_DEBUG_VERBOSE
+  Determines the verbosity level of the MTD debugging messages.
+
 M-Systems Disk-On-Chip 1000 support
 CONFIG_MTD_DOC1000
   This provides an MTD device driver for the M-Systems DiskOnChip
   1000 devices, which are obsolete so you probably want to say 'N'.
 
-M-Systems Disk-On-Chip 2000 support
+M-Systems Disk-On-Chip 2000 and Millennium support
 CONFIG_MTD_DOC2000
   This provides an MTD device driver for the M-Systems DiskOnChip
-  2000 devices. If you use this, you probably also want the NFTL
-  'NAND Flash Translation Layer' below, which is used to emulate
-  a block device by using a kind of file system on the flash chips.
+  2000 and Millennium devices. Originally designed for the DiskOnChip
+  2000, it also now includes support for the DiskOnChip Millennium.
+  If you have problems with this driver and the DiskOnChip Millennium,
+  you may wish to try the alternative Millennium driver below. To use
+  the alternative driver, you will need to undefine DOC_SINGLE_DRIVER
+  in the drivers/mtd/docprobe.c source code.
+
+  If you use this device, you probably also want to enable the NFTL
+  'NAND Flash Translation Layer' option below, which is used to emulate
+  a block device by using a kind of filesystem on the flash chips.
 
-M-Systems Disk-On-Chip Millennium support
+Alternative Disk-On-Chip Millennium support
 CONFIG_MTD_DOC2001
-  This provides an MTD device driver for the M-Systems DiskOnChip
-  Millennium devices. If you use this, you probably also want the
-  NFTL 'NAND Flash Translation Layer' below, which is used to emulate
-  a block device by using a kind of file system on the flash chips.
+  This provides an alternative MTD device driver for the M-Systems
+  DiskOnChip Millennium devices. Use this if you have problems with
+  the combined DiskOnChip 2000 and Millennium driver above. To get
+  the DiskOnChip probe code to load and use this driver instead of
+  the other one, you will need to undefine DOC_SINGLE_DRIVER near
+  the beginning of drivers/mtd/docprobe.c
+
+  If you use this device, you probably also want to enable the NFTL
+  'NAND Flash Translation Layer' option below, which is used to emulate
+  a block device by using a kind of filesystem on the flash chips.
+
+Ramix PMC551 PCI Mezzanine ram card support
+CONFIG_MTD_PMC551
+  This provides a MTD device driver for the Ramix PMC551 RAM PCI card
+  from Ramix Inc. (http://www.ramix.com/products/memory/pmc551.html).
+  These devices come in memory configurations from 32M - 1G.  If you
+  have one, you probably want to enable this.
+
+  If this driver is compiled as a module you get the ability to select the
+  size of the aperture window pointing into the devices memory.  What this
+  means is that if you have a 1G card, normally the kernel will use a 1G
+  memory map as it's view of the device.  As a module, you can select a
+  1M window into the memory and the driver will "slide" the window around
+  the PMC551's memory.  This was particularly usefull on the 2.2 kernels
+  on PPC architectures as there was limited kernel space to deal with.
 
 Use extra onboard system memory as MTD device
 CONFIG_MTD_SLRAM
@@ -10222,15 +10258,17 @@
   you can still use it for storage or swap by using this driver to
   present it to the system as a Memory Technology Device.
 
-Ramix PMC551 PCI Mezzanine ram card support
-CONFIG_MTD_PMC551
-  This provides an MTD device driver for the Ramix PMC551 RAM card.
-  If you have one, you probably want to enable this.
-
-PMC551 256M DRAM Bugfix.
+PMC551 256M DRAM Bugfix
 CONFIG_MTD_PMC551_BUGFIX
-  Some PMC551 boards hacve invalid column and row mux values. This 
-  option will fix them, but will break other memory configurations.
+  Some of Ramix's PMC551 boards with 256M configurations have invalid
+  column and row mux values. This option will fix them, but will break
+  other memory configurations.  If unsure say N.
+
+PMC551 Debugging
+CONFIG_MTD_PMC551_DEBUG
+  This option makes the PMC551 more verbose during it's operation and is
+  only really usefull if you are developing on this driver or suspect a
+  possible hardware or driver bug.  If unsure say N.
 
 Debugging RAM test driver
 CONFIG_MTD_MTDRAM
@@ -10242,10 +10280,12 @@
 
 Common Flash Interface (CFI) support
 CONFIG_MTD_CFI
-  Intel's Common Flash Interface specification provides a universal
-  method for probing the capabilities of flash devices. If you wish
-  to support any device which uses CFI-compliant devices, you need
-  to enable this option.
+  The Common Flash Interface specification was developed by Intel,
+  AMD and other flash manufactures that provides a universal method
+  for probing the capabilities of flash devices. If you wish to
+  support any device that is CFI-compliant, you need to enable this
+  option. Visit (http://www.amd.com/products/nvd/overview/cfi.html)
+  for more information on CFI.
 
 CFI support for Intel/Sharp Extended Command Set chips
 CONFIG_MTD_CFI_INTELEXT
@@ -10257,10 +10297,10 @@
 Flash chip mapping in physical memory
 CONFIG_MTD_PHYSMAP
   This provides a 'mapping' driver which allows the CFI probe and
-  command set driver code to communicate with flash chips which 
+  command set driver code to communicate with flash chips which
   are mapped physically into the CPU's memory. You will need to
   configure the physical address and size of the flash chips on
-  your particular board.
+  your particular board as well as the bus width.
 
 Physical start location of flash chip mapping
 CONFIG_MTD_PHYSMAP_START
@@ -10278,6 +10318,12 @@
   map which should hopefully be in the documentation for your
   board. 
 
+CONFIG_MTD_PHYSMAP_BUSWIDTH
+  This is the total width of the data bus of the flash devices
+  in octets. For example, if you have a data bus width of 32
+  bits, you would set the bus width octect value to 4. This is
+  used internally by the CFI drivers.
+
 Flash chip mapping on Mixcom piggyback card
 CONFIG_MTD_MIXMEM
   This supports the paging arrangement for access to flash chips
@@ -10290,19 +10336,25 @@
 CONFIG_MTD_NORA
   If you had to ask, you don't have one. Say 'N'.
 
+Flash chip mapping on PNC2000
+CONFIG_MTD_PNC2000
+  PNC-2000 is the name of Network Camera product from PHOTRON
+  Ltd. in Japan. It uses CFI-compliant flash.
+
 Flash chip mapping on Octagon 5066 SBC
 CONFIG_MTD_OCTAGON
   This provides a 'mapping' driver which supports the way in which
   the flash chips are connected in the Octagon-5066 Single Board
-  Computer. You will also need to complete and enable the driver
-  for JEDEC flash chips.
+  Computer. More information on the board is available at
+  (http://www.octagonsystems.com/Products/5066/5066.html).
 
 Flash chip mapping on RPXlite PPC board
 CONFIG_MTD_RPXLITE
-  The RPXLite PowerPC board has CFI-compliant chips mapped in 
+  The RPXLite PowerPC board has CFI-compliant chips mapped in
   a strange sparse mapping. This 'mapping' driver supports that
   arrangement, allowing the CFI probe and command set driver code
-  to communicate with the chips on the RPXLite board.
+  to communicate with the chips on the RPXLite board. More at
+  (http://www.embeddedplanet.com/rpx_lite_specification_sheet.htm).
 
 Flash chip mapping on Tempustech VMAX SBC301
 CONFIG_MTD_VMAX
@@ -11830,21 +11882,16 @@
   whenever you want), say M here and read Documentation/modules.txt.
   The module will be called efs.o. 
 
-Journalling Flash File System (JFFS) support (EXPERIMENTAL)
+Support for the Journalling Flash Filesystem
 CONFIG_JFFS_FS
-  JFFS is a new file system designed for use on flash memory devices
-  rather than on block devices. It was developed on the 2.0 kernel
-  by Axis Communications AB for use on their Linux-based products,
-  and released under GPL, then 'borrowed' and ported to work with 
-  the 2.4 kernel and the new Memory Technology Device system. 
-
-  The 2.4 port is experimental and not yet supported by Axis. Basically,
-  the good bits are probably theirs, and if it's broken in 2.4 it's 
-  probably our fault. See http://www.developer.axis.com/software/jffs/
-  for more information about JFFS.
-
-  Any potential patches or queries should be sent to Axis' mailing 
-  list for JFFS: <jffs-dev@axis.com>
+  JFFS is the Journaling Flash File System developed by Axis
+  Communications in Sweden, aimed at providing a crash/powerdown-safe
+  filesystem for disk-less embedded devices. Further information is
+  available at (http://developer.axis.com/software/jffs/).
+
+JFFS debugging verbosity
+CONFIG_JFFS_FS_VERBOSE
+  Determines the verbosity level of the JFFS debugging messages.
 
 UFS file system support (read-only)
 CONFIG_UFS_FS