-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
sh: Add documentation and integrate into docbook build.
This adds some preliminary docbook bits for SH, tying in to the few interfaces that are exposed and that have adequate kerneldoc comments. Signed-off-by: Paul Mundt <lethal@linux-sh.org>
- Loading branch information
Paul Mundt
committed
Aug 4, 2008
1 parent
6a9545b
commit b5ed042
Showing
2 changed files
with
106 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" | ||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> | ||
|
||
<book id="sh-drivers"> | ||
<bookinfo> | ||
<title>SuperH Interfaces Guide</title> | ||
|
||
<authorgroup> | ||
<author> | ||
<firstname>Paul</firstname> | ||
<surname>Mundt</surname> | ||
<affiliation> | ||
<address> | ||
<email>lethal@linux-sh.org</email> | ||
</address> | ||
</affiliation> | ||
</author> | ||
</authorgroup> | ||
|
||
<copyright> | ||
<year>2008</year> | ||
<holder>Paul Mundt</holder> | ||
</copyright> | ||
<copyright> | ||
<year>2008</year> | ||
<holder>Renesas Technology Corp.</holder> | ||
</copyright> | ||
|
||
<legalnotice> | ||
<para> | ||
This documentation is free software; you can redistribute | ||
it and/or modify it under the terms of the GNU General Public | ||
License version 2 as published by the Free Software Foundation. | ||
</para> | ||
|
||
<para> | ||
This program is distributed in the hope that it will be | ||
useful, but WITHOUT ANY WARRANTY; without even the implied | ||
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | ||
See the GNU General Public License for more details. | ||
</para> | ||
|
||
<para> | ||
You should have received a copy of the GNU General Public | ||
License along with this program; if not, write to the Free | ||
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, | ||
MA 02111-1307 USA | ||
</para> | ||
|
||
<para> | ||
For more details see the file COPYING in the source | ||
distribution of Linux. | ||
</para> | ||
</legalnotice> | ||
</bookinfo> | ||
|
||
<toc></toc> | ||
|
||
<chapter id="mm"> | ||
<title>Memory Management</title> | ||
<sect1 id="sh4"> | ||
<title>SH-4</title> | ||
<sect2 id="sq"> | ||
<title>Store Queue API</title> | ||
!Earch/sh/kernel/cpu/sh4/sq.c | ||
</sect2> | ||
</sect1> | ||
<sect1 id="sh5"> | ||
<title>SH-5</title> | ||
<sect2 id="tlb"> | ||
<title>TLB Interfaces</title> | ||
!Iarch/sh/mm/tlb-sh5.c | ||
!Iarch/sh/include/asm/tlb_64.h | ||
</sect2> | ||
</sect1> | ||
</chapter> | ||
<chapter id="clk"> | ||
<title>Clock Framework Extensions</title> | ||
!Iarch/sh/include/asm/clock.h | ||
</chapter> | ||
<chapter id="mach"> | ||
<title>Machine Specific Interfaces</title> | ||
<sect1 id="dreamcast"> | ||
<title>mach-dreamcast</title> | ||
!Iarch/sh/boards/mach-dreamcast/rtc.c | ||
</sect1> | ||
<sect1 id="x3proto"> | ||
<title>mach-x3proto</title> | ||
!Earch/sh/boards/mach-x3proto/ilsel.c | ||
</sect1> | ||
</chapter> | ||
<chapter id="busses"> | ||
<title>Busses</title> | ||
<sect1 id="superhyway"> | ||
<title>SuperHyway</title> | ||
!Edrivers/sh/superhyway/superhyway.c | ||
</sect1> | ||
|
||
<sect1 id="maple"> | ||
<title>Maple</title> | ||
!Edrivers/sh/maple/maple.c | ||
</sect1> | ||
</chapter> | ||
</book> |