Documentation/mips/AU1xxx_IDE.README

   1 README for MIPS AU1XXX IDE driver - Released 2005-07-15
   2
   3 ABOUT
   4 -----
   5 This file describes the 'drivers/ide/mips/au1xxx-ide.c', related files and the
   6 services they provide.
   7
   8 If you are short in patience and just want to know how to add your hard disc to
   9 the white or black list, go to the 'ADD NEW HARD DISC TO WHITE OR BLACK LIST'
  10 section.
  11
  12
  13 LICENSE
  14 -------
  15
  16 Copyright (c) 2003-2005 AMD, Personal Connectivity Solutions
  17
  18 This program is free software; you can redistribute it and/or modify it under
  19 the terms of the GNU General Public License as published by the Free Software
  20 Foundation; either version 2 of the License, or (at your option) any later
  21 version.
  22
  23 THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  24 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  25 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR
  26 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32 POSSIBILITY OF SUCH DAMAGE.
  33
  34 You should have received a copy of the GNU General Public License along with
  35 this program; if not, write to the Free Software Foundation, Inc.,
  36 675 Mass Ave, Cambridge, MA 02139, USA.
  37
  38 Note: for more information, please refer "AMD Alchemy Au1200/Au1550 IDE
  39       Interface and Linux Device Driver" Application Note.
  40
  41
  42 FILES, CONFIGS AND COMPATABILITY
  43 --------------------------------
  44
  45 Two files are introduced:
  46
  47   a) 'include/asm-mips/mach-au1x00/au1xxx_ide.h'
  48      containes : struct _auide_hwif
  49                  timing parameters for PIO mode 0/1/2/3/4
  50                  timing parameters for MWDMA 0/1/2
  51
  52   b) 'drivers/ide/mips/au1xxx-ide.c'
  53      contains the functionality of the AU1XXX IDE driver
  54
  55 Four configs variables are introduced:
  56
  57   CONFIG_BLK_DEV_IDE_AU1XXX_PIO_DBDMA    - enable the PIO+DBDMA mode
  58   CONFIG_BLK_DEV_IDE_AU1XXX_MDMA2_DBDMA  - enable the MWDMA mode
  59   CONFIG_BLK_DEV_IDE_AU1XXX_BURSTABLE_ON - set Burstable FIFO in DBDMA
  60                                            controller
  61   CONFIG_BLK_DEV_IDE_AU1XXX_SEQTS_PER_RQ - maximum transfer size
  62                                            per descriptor
  63
  64
  65 SUPPORTED IDE MODES
  66 -------------------
  67
  68 The AU1XXX IDE driver supported all PIO modes - PIO mode 0/1/2/3/4 - and all
  69 MWDMA modes - MWDMA 0/1/2 -. There is no support for SWDMA and UDMA mode.
  70
  71 To change the PIO mode use the program hdparm with option -p, e.g.
  72 'hdparm -p0 [device]' for PIO mode 0. To enable the MWDMA mode use the option
  73 -X, e.g. 'hdparm -X32 [device]' for MWDMA mode 0.
  74
  75
  76 PERFORMANCE CONFIGURATIONS
  77 --------------------------
  78
  79 If the used system doesn't need USB support enable the following kernel configs:
  80
  81 CONFIG_IDE=y
  82 CONFIG_BLK_DEV_IDE=y
  83 CONFIG_IDE_GENERIC=y
  84 CONFIG_BLK_DEV_IDEPCI=y
  85 CONFIG_BLK_DEV_GENERIC=y
  86 CONFIG_BLK_DEV_IDEDMA_PCI=y
  87 CONFIG_IDEDMA_PCI_AUTO=y
  88 CONFIG_BLK_DEV_IDE_AU1XXX=y
  89 CONFIG_BLK_DEV_IDE_AU1XXX_MDMA2_DBDMA=y
  90 CONFIG_BLK_DEV_IDE_AU1XXX_SEQTS_PER_RQ=128
  91 CONFIG_BLK_DEV_IDEDMA=y
  92 CONFIG_IDEDMA_AUTO=y
  93
  94 Also define 'IDE_AU1XXX_BURSTMODE' in 'drivers/ide/mips/au1xxx-ide.c' to enable
  95 the burst support on DBDMA controller.
  96
  97 If the used system need the USB support enable the following kernel configs for
  98 high IDE to USB throughput.
  99
 100 CONFIG_BLK_DEV_IDEDISK=y
 101 CONFIG_IDE_GENERIC=y
 102 CONFIG_BLK_DEV_IDEPCI=y
 103 CONFIG_BLK_DEV_GENERIC=y
 104 CONFIG_BLK_DEV_IDEDMA_PCI=y
 105 CONFIG_IDEDMA_PCI_AUTO=y
 106 CONFIG_BLK_DEV_IDE_AU1XXX=y
 107 CONFIG_BLK_DEV_IDE_AU1XXX_MDMA2_DBDMA=y
 108 CONFIG_BLK_DEV_IDE_AU1XXX_SEQTS_PER_RQ=128
 109 CONFIG_BLK_DEV_IDEDMA=y
 110 CONFIG_IDEDMA_AUTO=y
 111
 112 Also undefine 'IDE_AU1XXX_BURSTMODE' in 'drivers/ide/mips/au1xxx-ide.c' to
 113 disable the burst support on DBDMA controller.
 114
 115
 116 ACKNOWLEDGMENTS
 117 ---------------
 118
 119 These drivers wouldn't have been done without the base of kernel 2.4.x AU1XXX
 120 IDE driver from AMD.
 121
 122 Additional input also from:
 123 Matthias Lenk <matthias.lenk@amd.com>
 124
 125 Happy hacking!
 126 Enrico Walther <enrico.walther@amd.com>