sh: Add documentation and integrate into docbook build.
[linux-2.6.git] / Documentation / DocBook / sh.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="sh-drivers">
6  <bookinfo>
7   <title>SuperH Interfaces Guide</title>
8   
9   <authorgroup>
10    <author>
11     <firstname>Paul</firstname>
12     <surname>Mundt</surname>
13     <affiliation>
14      <address>
15       <email>lethal@linux-sh.org</email>
16      </address>
17     </affiliation>
18    </author>
19   </authorgroup>
20
21   <copyright>
22    <year>2008</year>
23    <holder>Paul Mundt</holder>
24   </copyright>
25   <copyright>
26    <year>2008</year>
27    <holder>Renesas Technology Corp.</holder>
28   </copyright>
29
30   <legalnotice>
31    <para>
32      This documentation is free software; you can redistribute
33      it and/or modify it under the terms of the GNU General Public
34      License version 2 as published by the Free Software Foundation.
35    </para>
36       
37    <para>
38      This program is distributed in the hope that it will be
39      useful, but WITHOUT ANY WARRANTY; without even the implied
40      warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
41      See the GNU General Public License for more details.
42    </para>
43       
44    <para>
45      You should have received a copy of the GNU General Public
46      License along with this program; if not, write to the Free
47      Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
48      MA 02111-1307 USA
49    </para>
50       
51    <para>
52      For more details see the file COPYING in the source
53      distribution of Linux.
54    </para>
55   </legalnotice>
56  </bookinfo>
57
58 <toc></toc>
59
60   <chapter id="mm">
61     <title>Memory Management</title>
62     <sect1 id="sh4">
63     <title>SH-4</title>
64       <sect2 id="sq">
65         <title>Store Queue API</title>
66 !Earch/sh/kernel/cpu/sh4/sq.c
67       </sect2>
68     </sect1>
69     <sect1 id="sh5">
70       <title>SH-5</title>
71       <sect2 id="tlb">
72         <title>TLB Interfaces</title>
73 !Iarch/sh/mm/tlb-sh5.c
74 !Iarch/sh/include/asm/tlb_64.h
75       </sect2>
76     </sect1>
77   </chapter>
78   <chapter id="clk">
79     <title>Clock Framework Extensions</title>
80 !Iarch/sh/include/asm/clock.h
81   </chapter>
82   <chapter id="mach">
83     <title>Machine Specific Interfaces</title>
84     <sect1 id="dreamcast">
85       <title>mach-dreamcast</title>
86 !Iarch/sh/boards/mach-dreamcast/rtc.c
87     </sect1>
88     <sect1 id="x3proto">
89       <title>mach-x3proto</title>
90 !Earch/sh/boards/mach-x3proto/ilsel.c
91     </sect1>
92   </chapter>
93   <chapter id="busses">
94     <title>Busses</title>
95     <sect1 id="superhyway">
96       <title>SuperHyway</title>
97 !Edrivers/sh/superhyway/superhyway.c
98     </sect1>
99
100     <sect1 id="maple">
101       <title>Maple</title>
102 !Edrivers/sh/maple/maple.c
103     </sect1>
104   </chapter>
105 </book>