kernel/linux/Documentation/DocBook/mcabook.tmpl

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
   2
   3 <book id="MCAGuide">
   4  <bookinfo>
   5   <title>MCA Driver Programming Interface</title>
   6
   7   <authorgroup>
   8    <author>
   9     <firstname>Alan</firstname>
  10     <surname>Cox</surname>
  11     <affiliation>
  12      <address>
  13       <email>alan@redhat.com</email>
  14      </address>
  15     </affiliation>
  16    </author>
  17    <author>
  18     <firstname>David</firstname>
  19     <surname>Weinehall</surname>
  20    </author>
  21    <author>
  22     <firstname>Chris</firstname>
  23     <surname>Beauregard</surname>
  24    </author>
  25   </authorgroup>
  26
  27   <copyright>
  28    <year>2000</year>
  29    <holder>Alan Cox</holder>
  30    <holder>David Weinehall</holder>
  31    <holder>Chris Beauregard</holder>
  32   </copyright>
  33
  34   <legalnotice>
  35    <para>
  36      This documentation is free software; you can redistribute
  37      it and/or modify it under the terms of the GNU General Public
  38      License as published by the Free Software Foundation; either
  39      version 2 of the License, or (at your option) any later
  40      version.
  41    </para>
  42
  43    <para>
  44      This program is distributed in the hope that it will be
  45      useful, but WITHOUT ANY WARRANTY; without even the implied
  46      warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  47      See the GNU General Public License for more details.
  48    </para>
  49
  50    <para>
  51      You should have received a copy of the GNU General Public
  52      License along with this program; if not, write to the Free
  53      Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  54      MA 02111-1307 USA
  55    </para>
  56
  57    <para>
  58      For more details see the file COPYING in the source
  59      distribution of Linux.
  60    </para>
  61   </legalnotice>
  62  </bookinfo>
  63
  64 <toc></toc>
  65
  66   <chapter id="intro">
  67       <title>Introduction</title>
  68   <para>
  69         The MCA bus functions provide a generalised interface to find MCA
  70         bus cards, to claim them for a driver, and to read and manipulate POS
  71         registers without being aware of the motherboard internals or
  72         certain deep magic specific to onboard devices.
  73   </para>
  74   <para>
  75         The basic interface to the MCA bus devices is the slot. Each slot
  76         is numbered and virtual slot numbers are assigned to the internal
  77         devices. Using a pci_dev as other busses do does not really make
  78         sense in the MCA context as the MCA bus resources require card
  79         specific interpretation.
  80   </para>
  81   <para>
  82         Finally the MCA bus functions provide a parallel set of DMA
  83         functions mimicing the ISA bus DMA functions as closely as possible,
  84         although also supporting the additional DMA functionality on the
  85         MCA bus controllers.
  86   </para>
  87   </chapter>
  88   <chapter id="bugs">
  89      <title>Known Bugs And Assumptions</title>
  90   <para>
  91         None.
  92   </para>
  93   </chapter>
  94
  95   <chapter id="pubfunctions">
  96      <title>Public Functions Provided</title>
  97 !Earch/i386/kernel/mca.c
  98   </chapter>
  99
 100   <chapter id="dmafunctions">
 101      <title>DMA Functions Provided</title>
 102 !Iinclude/asm-i386/mca_dma.h
 103   </chapter>
 104
 105 </book>