deviceiobook.tmpl
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:8k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
  2. <book id="DoingIO">
  3.  <bookinfo>
  4.   <title>Bus-Independent Device Accesses</title>
  5.   
  6.   <authorgroup>
  7.    <author>
  8.     <firstname>Matthew</firstname>
  9.     <surname>Wilcox</surname>
  10.     <affiliation>
  11.      <address>
  12.       <email>matthew@wil.cx</email>
  13.      </address>
  14.     </affiliation>
  15.    </author>
  16.   </authorgroup>
  17.   <authorgroup>
  18.    <author>
  19.     <firstname>Alan</firstname>
  20.     <surname>Cox</surname>
  21.     <affiliation>
  22.      <address>
  23.       <email>alan@redhat.com</email>
  24.      </address>
  25.     </affiliation>
  26.    </author>
  27.   </authorgroup>
  28.   <copyright>
  29.    <year>2001</year>
  30.    <holder>Matthew Wilcox</holder>
  31.   </copyright>
  32.   <legalnotice>
  33.    <para>
  34.      This documentation is free software; you can redistribute
  35.      it and/or modify it under the terms of the GNU General Public
  36.      License as published by the Free Software Foundation; either
  37.      version 2 of the License, or (at your option) any later
  38.      version.
  39.    </para>
  40.       
  41.    <para>
  42.      This program is distributed in the hope that it will be
  43.      useful, but WITHOUT ANY WARRANTY; without even the implied
  44.      warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  45.      See the GNU General Public License for more details.
  46.    </para>
  47.       
  48.    <para>
  49.      You should have received a copy of the GNU General Public
  50.      License along with this program; if not, write to the Free
  51.      Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  52.      MA 02111-1307 USA
  53.    </para>
  54.       
  55.    <para>
  56.      For more details see the file COPYING in the source
  57.      distribution of Linux.
  58.    </para>
  59.   </legalnotice>
  60.  </bookinfo>
  61. <toc></toc>
  62.   <chapter id="intro">
  63.       <title>Introduction</title>
  64.   <para>
  65. Linux provides an API which abstracts performing IO across all busses
  66. and devices, allowing device drivers to be written independently of
  67. bus type.
  68.   </para>
  69.   </chapter>
  70.   <chapter id="bugs">
  71.      <title>Known Bugs And Assumptions</title>
  72.   <para>
  73. None.
  74.   </para>
  75.   </chapter>
  76.   <chapter id="mmio">
  77.     <title>Memory Mapped IO</title>
  78.     <sect1>
  79.       <title>Getting Access to the Device</title>
  80.       <para>
  81. The most widely supported form of IO is memory mapped IO.
  82. That is, a part of the CPU's address space is interpreted
  83. not as accesses to memory, but as accesses to a device.  Some
  84. architectures define devices to be at a fixed address, but most
  85. have some method of discovering devices.  The PCI bus walk is a
  86. good example of such a scheme. This document does not cover how
  87. to receive such an address, but assumes you are starting with one.
  88. Physical addresses are of type unsigned long. 
  89.       </para>
  90.       <para>
  91. This address should not be used directly.  Instead, to get an
  92. address suitable for passing to the accessor functions described
  93. below, you should call <function>ioremap</function>.
  94. An address suitable for accessing the device will be returned to you.
  95.       </para>
  96.       <para>
  97. After you've finished using the device (say, in your module's
  98. exit routine), call <function>iounmap</function> in order to return
  99. the address space to the kernel.  Most architectures allocate new
  100. address space each time you call <function>ioremap</function>, and
  101. they can run out unless you call <function>iounmap</function>.
  102.       </para>
  103.     </sect1>
  104.     <sect1>
  105.       <title>Accessing the device</title>
  106.       <para>
  107. The part of the interface most used by drivers is reading and
  108. writing memory-mapped registers on the device. Linux provides
  109. interfaces to read and write 8-bit, 16-bit, 32-bit and 64-bit
  110. quantities.  Due to a historical accident, these are named byte,
  111. word, long and quad accesses.  Both read and write accesses are
  112. supported; there is no prefetch support at this time.
  113.       </para>
  114.       <para>
  115. The functions are named <function>readb</function>,
  116. <function>readw</function>, <function>readl</function>,
  117. <function>readq</function>, <function>writeb</function>,
  118. <function>writew</function>, <function>writel</function> and
  119. <function>writeq</function>.
  120.       </para>
  121.       <para>
  122. Some devices (such as framebuffers) would like to use larger
  123. transfers than 8 bytes at a time.  For these devices, the
  124. <function>memcpy_toio</function>, <function>memcpy_fromio</function>
  125. and <function>memset_io</function> functions are provided.
  126. Do not use memset or memcpy on IO addresses; they
  127. are not guaranteed to copy data in order.
  128.       </para>
  129.       <para>
  130. The read and write functions are defined to be ordered. That is the
  131. compiler is not permitted to reorder the I/O sequence. When the 
  132. ordering can be compiler optimised, you can use <function>
  133. __readb</function> and friends to indicate the relaxed ordering. Use 
  134. this with care. The <function>rmb</function> provides a read memory 
  135. barrier. The <function>wmb</function> provides a write memory barrier.
  136.       </para>
  137.       <para>
  138. While the basic functions are defined to be synchronous with respect
  139. to each other and ordered with respect to each other the busses the
  140. devices sit on may themselves have asynchronocity. In paticular many
  141. authors are burned by the fact that PCI bus writes are posted
  142. asynchronously. A driver author must issue a read from the same
  143. device to ensure that writes have occurred in the specific cases the
  144. author cares. This kind of property cannot be hidden from driver
  145. writers in the API.
  146.       </para>
  147.     </sect1>
  148.     <sect1>
  149.       <title>ISA legacy functions</title>
  150.       <para>
  151. On older kernels (2.2 and earlier) the ISA bus could be read or
  152. written with these functions and without ioremap being used. This is
  153. no longer true in Linux 2.4. A set of equivalent functions exist for
  154. easy legacy driver porting. The functions available are prefixed
  155. with 'isa_' and are <function>isa_readb</function>,
  156. <function>isa_writeb</function>, <function>isa_readw</function>, 
  157. <function>isa_writew</function>, <function>isa_readl</function>,
  158. <function>isa_writel</function>, <function>isa_memcpy_fromio</function>
  159. and <function>isa_memcpy_toio</function>
  160.       </para>
  161.       <para>
  162. These functions should not be used in new drivers, and will
  163. eventually be going away.
  164.       </para>
  165.     </sect1>
  166.   </chapter>
  167.   <chapter>
  168.     <title>Port Space Accesses</title>
  169.     <sect1>
  170.       <title>Port Space Explained</title>
  171.       <para>
  172. Another form of IO commonly supported is Port Space.  This is a
  173. range of addresses separate to the normal memory address space.
  174. Access to these addresses is generally not as fast as accesses
  175. to the memory mapped addresses, and it also has a potentially
  176. smaller address space.
  177.       </para>
  178.       <para>
  179. Unlike memory mapped IO, no preparation is required
  180. to access port space.
  181.       </para>
  182.     </sect1>
  183.     <sect1>
  184.       <title>Accessing Port Space</title>
  185.       <para>
  186. Accesses to this space are provided through a set of functions
  187. which allow 8-bit, 16-bit and 32-bit accesses; also
  188. known as byte, word and long.  These functions are
  189. <function>inb</function>, <function>inw</function>,
  190. <function>inl</function>, <function>outb</function>,
  191. <function>outw</function> and <function>outl</function>.
  192.       </para>
  193.       <para>
  194. Some variants are provided for these functions.  Some devices
  195. require that accesses to their ports are slowed down.  This
  196. functionality is provided by appending a <function>_p</function>
  197. to the end of the function.  There are also equivalents to memcpy.
  198. The <function>ins</function> and <function>outs</function>
  199. functions copy bytes, words or longs to the given port.
  200.       </para>
  201.     </sect1>
  202.   </chapter>
  203.   <chapter id="pubfunctions">
  204.      <title>Public Functions Provided</title>
  205. !Einclude/asm-i386/io.h
  206.   </chapter>
  207. </book>