Documentation/DocBook/mcabook.tmpl

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