Documentation/mips/au1xxx_ide.rst

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