diff options
| author | James Morris <jmorris@namei.org> | 2008-08-27 20:47:34 -0400 |
|---|---|---|
| committer | James Morris <jmorris@namei.org> | 2008-08-27 20:47:34 -0400 |
| commit | 86d688984deefa3ae5a802880c11f2b408b5d6cf (patch) | |
| tree | 7ea5e8189b0a774626d3ed7c3c87df2495a4c4a0 /Documentation/DocBook | |
| parent | 93c06cbbf9fea5d5be1778febb7fa9ab1a74e5f5 (diff) | |
| parent | 4c246edd2550304df5b766cc841584b2bb058843 (diff) | |
Merge branch 'master' into next
Diffstat (limited to 'Documentation/DocBook')
| -rw-r--r-- | Documentation/DocBook/Makefile | 9 | ||||
| -rw-r--r-- | Documentation/DocBook/procfs_example.c | 4 | ||||
| -rw-r--r-- | Documentation/DocBook/s390-drivers.tmpl | 8 | ||||
| -rw-r--r-- | Documentation/DocBook/sh.tmpl | 105 | ||||
| -rw-r--r-- | Documentation/DocBook/videobook.tmpl | 2 | ||||
| -rw-r--r-- | Documentation/DocBook/z8530book.tmpl | 38 |
6 files changed, 131 insertions, 35 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index 0eb0d027eb32..1615350b7b53 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile | |||
| @@ -12,7 +12,7 @@ DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \ | |||
| 12 | kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \ | 12 | kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \ |
| 13 | gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \ | 13 | gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \ |
| 14 | genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \ | 14 | genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \ |
| 15 | mac80211.xml debugobjects.xml | 15 | mac80211.xml debugobjects.xml sh.xml |
| 16 | 16 | ||
| 17 | ### | 17 | ### |
| 18 | # The build process is as follows (targets): | 18 | # The build process is as follows (targets): |
| @@ -102,6 +102,13 @@ C-procfs-example = procfs_example.xml | |||
| 102 | C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example)) | 102 | C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example)) |
| 103 | $(obj)/procfs-guide.xml: $(C-procfs-example2) | 103 | $(obj)/procfs-guide.xml: $(C-procfs-example2) |
| 104 | 104 | ||
| 105 | # List of programs to build | ||
| 106 | ##oops, this is a kernel module::hostprogs-y := procfs_example | ||
| 107 | obj-m += procfs_example.o | ||
| 108 | |||
| 109 | # Tell kbuild to always build the programs | ||
| 110 | always := $(hostprogs-y) | ||
| 111 | |||
| 105 | notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \ | 112 | notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \ |
| 106 | exit 1 | 113 | exit 1 |
| 107 | db2xtemplate = db2TYPE -o $(dir $@) $< | 114 | db2xtemplate = db2TYPE -o $(dir $@) $< |
diff --git a/Documentation/DocBook/procfs_example.c b/Documentation/DocBook/procfs_example.c index 7064084c1c5e..2f3de0fb8365 100644 --- a/Documentation/DocBook/procfs_example.c +++ b/Documentation/DocBook/procfs_example.c | |||
| @@ -189,8 +189,6 @@ static int __init init_procfs_example(void) | |||
| 189 | return 0; | 189 | return 0; |
| 190 | 190 | ||
| 191 | no_symlink: | 191 | no_symlink: |
| 192 | remove_proc_entry("tty", example_dir); | ||
| 193 | no_tty: | ||
| 194 | remove_proc_entry("bar", example_dir); | 192 | remove_proc_entry("bar", example_dir); |
| 195 | no_bar: | 193 | no_bar: |
| 196 | remove_proc_entry("foo", example_dir); | 194 | remove_proc_entry("foo", example_dir); |
| @@ -206,7 +204,6 @@ out: | |||
| 206 | static void __exit cleanup_procfs_example(void) | 204 | static void __exit cleanup_procfs_example(void) |
| 207 | { | 205 | { |
| 208 | remove_proc_entry("jiffies_too", example_dir); | 206 | remove_proc_entry("jiffies_too", example_dir); |
| 209 | remove_proc_entry("tty", example_dir); | ||
| 210 | remove_proc_entry("bar", example_dir); | 207 | remove_proc_entry("bar", example_dir); |
| 211 | remove_proc_entry("foo", example_dir); | 208 | remove_proc_entry("foo", example_dir); |
| 212 | remove_proc_entry("jiffies", example_dir); | 209 | remove_proc_entry("jiffies", example_dir); |
| @@ -222,3 +219,4 @@ module_exit(cleanup_procfs_example); | |||
| 222 | 219 | ||
| 223 | MODULE_AUTHOR("Erik Mouw"); | 220 | MODULE_AUTHOR("Erik Mouw"); |
| 224 | MODULE_DESCRIPTION("procfs examples"); | 221 | MODULE_DESCRIPTION("procfs examples"); |
| 222 | MODULE_LICENSE("GPL"); | ||
diff --git a/Documentation/DocBook/s390-drivers.tmpl b/Documentation/DocBook/s390-drivers.tmpl index 4acc73240a6d..95bfc12e5439 100644 --- a/Documentation/DocBook/s390-drivers.tmpl +++ b/Documentation/DocBook/s390-drivers.tmpl | |||
| @@ -100,7 +100,7 @@ | |||
| 100 | the hardware structures represented here, please consult the Principles | 100 | the hardware structures represented here, please consult the Principles |
| 101 | of Operation. | 101 | of Operation. |
| 102 | </para> | 102 | </para> |
| 103 | !Iinclude/asm-s390/cio.h | 103 | !Iarch/s390/include/asm/cio.h |
| 104 | </sect1> | 104 | </sect1> |
| 105 | <sect1 id="ccwdev"> | 105 | <sect1 id="ccwdev"> |
| 106 | <title>ccw devices</title> | 106 | <title>ccw devices</title> |
| @@ -114,7 +114,7 @@ | |||
| 114 | ccw device structure. Device drivers must not bypass those functions | 114 | ccw device structure. Device drivers must not bypass those functions |
| 115 | or strange side effects may happen. | 115 | or strange side effects may happen. |
| 116 | </para> | 116 | </para> |
| 117 | !Iinclude/asm-s390/ccwdev.h | 117 | !Iarch/s390/include/asm/ccwdev.h |
| 118 | !Edrivers/s390/cio/device.c | 118 | !Edrivers/s390/cio/device.c |
| 119 | !Edrivers/s390/cio/device_ops.c | 119 | !Edrivers/s390/cio/device_ops.c |
| 120 | </sect1> | 120 | </sect1> |
| @@ -125,7 +125,7 @@ | |||
| 125 | measurement data which is made available by the channel subsystem | 125 | measurement data which is made available by the channel subsystem |
| 126 | for each channel attached device. | 126 | for each channel attached device. |
| 127 | </para> | 127 | </para> |
| 128 | !Iinclude/asm-s390/cmb.h | 128 | !Iarch/s390/include/asm/cmb.h |
| 129 | !Edrivers/s390/cio/cmf.c | 129 | !Edrivers/s390/cio/cmf.c |
| 130 | </sect1> | 130 | </sect1> |
| 131 | </chapter> | 131 | </chapter> |
| @@ -142,7 +142,7 @@ | |||
| 142 | </para> | 142 | </para> |
| 143 | <sect1 id="ccwgroupdevices"> | 143 | <sect1 id="ccwgroupdevices"> |
| 144 | <title>ccw group devices</title> | 144 | <title>ccw group devices</title> |
| 145 | !Iinclude/asm-s390/ccwgroup.h | 145 | !Iarch/s390/include/asm/ccwgroup.h |
| 146 | !Edrivers/s390/cio/ccwgroup.c | 146 | !Edrivers/s390/cio/ccwgroup.c |
| 147 | </sect1> | 147 | </sect1> |
| 148 | </chapter> | 148 | </chapter> |
diff --git a/Documentation/DocBook/sh.tmpl b/Documentation/DocBook/sh.tmpl new file mode 100644 index 000000000000..0c3dc4c69dd1 --- /dev/null +++ b/Documentation/DocBook/sh.tmpl | |||
| @@ -0,0 +1,105 @@ | |||
| 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> | ||
diff --git a/Documentation/DocBook/videobook.tmpl b/Documentation/DocBook/videobook.tmpl index 89817795e668..0bc25949b668 100644 --- a/Documentation/DocBook/videobook.tmpl +++ b/Documentation/DocBook/videobook.tmpl | |||
| @@ -1648,7 +1648,7 @@ static struct video_buffer capture_fb; | |||
| 1648 | 1648 | ||
| 1649 | <chapter id="pubfunctions"> | 1649 | <chapter id="pubfunctions"> |
| 1650 | <title>Public Functions Provided</title> | 1650 | <title>Public Functions Provided</title> |
| 1651 | !Edrivers/media/video/videodev.c | 1651 | !Edrivers/media/video/v4l2-dev.c |
| 1652 | </chapter> | 1652 | </chapter> |
| 1653 | 1653 | ||
| 1654 | </book> | 1654 | </book> |
diff --git a/Documentation/DocBook/z8530book.tmpl b/Documentation/DocBook/z8530book.tmpl index 42c75ba71ba2..a42a8a4c7689 100644 --- a/Documentation/DocBook/z8530book.tmpl +++ b/Documentation/DocBook/z8530book.tmpl | |||
| @@ -69,12 +69,6 @@ | |||
| 69 | device to be used as both a tty interface and as a synchronous | 69 | device to be used as both a tty interface and as a synchronous |
| 70 | controller is a project for Linux post the 2.4 release | 70 | controller is a project for Linux post the 2.4 release |
| 71 | </para> | 71 | </para> |
| 72 | <para> | ||
| 73 | The support code handles most common card configurations and | ||
| 74 | supports running both Cisco HDLC and Synchronous PPP. With extra | ||
| 75 | glue the frame relay and X.25 protocols can also be used with this | ||
| 76 | driver. | ||
| 77 | </para> | ||
| 78 | </chapter> | 72 | </chapter> |
| 79 | 73 | ||
| 80 | <chapter id="Driver_Modes"> | 74 | <chapter id="Driver_Modes"> |
| @@ -179,35 +173,27 @@ | |||
| 179 | <para> | 173 | <para> |
| 180 | If you wish to use the network interface facilities of the driver, | 174 | If you wish to use the network interface facilities of the driver, |
| 181 | then you need to attach a network device to each channel that is | 175 | then you need to attach a network device to each channel that is |
| 182 | present and in use. In addition to use the SyncPPP and Cisco HDLC | 176 | present and in use. In addition to use the generic HDLC |
| 183 | you need to follow some additional plumbing rules. They may seem | 177 | you need to follow some additional plumbing rules. They may seem |
| 184 | complex but a look at the example hostess_sv11 driver should | 178 | complex but a look at the example hostess_sv11 driver should |
| 185 | reassure you. | 179 | reassure you. |
| 186 | </para> | 180 | </para> |
| 187 | <para> | 181 | <para> |
| 188 | The network device used for each channel should be pointed to by | 182 | The network device used for each channel should be pointed to by |
| 189 | the netdevice field of each channel. The dev-> priv field of the | 183 | the netdevice field of each channel. The hdlc-> priv field of the |
| 190 | network device points to your private data - you will need to be | 184 | network device points to your private data - you will need to be |
| 191 | able to find your ppp device from this. In addition to use the | 185 | able to find your private data from this. |
| 192 | sync ppp layer the private data must start with a void * pointer | ||
| 193 | to the syncppp structures. | ||
| 194 | </para> | 186 | </para> |
| 195 | <para> | 187 | <para> |
| 196 | The way most drivers approach this particular problem is to | 188 | The way most drivers approach this particular problem is to |
| 197 | create a structure holding the Z8530 device definition and | 189 | create a structure holding the Z8530 device definition and |
| 198 | put that and the syncppp pointer into the private field of | 190 | put that into the private field of the network device. The |
| 199 | the network device. The network device fields of the channels | 191 | network device fields of the channels then point back to the |
| 200 | then point back to the network devices. The ppp_device can also | 192 | network devices. |
| 201 | be put in the private structure conveniently. | ||
| 202 | </para> | 193 | </para> |
| 203 | <para> | 194 | <para> |
| 204 | If you wish to use the synchronous ppp then you need to attach | 195 | If you wish to use the generic HDLC then you need to register |
| 205 | the syncppp layer to the network device. You should do this before | 196 | the HDLC device. |
| 206 | you register the network device. The | ||
| 207 | <function>sppp_attach</function> requires that the first void * | ||
| 208 | pointer in your private data is pointing to an empty struct | ||
| 209 | ppp_device. The function fills in the initial data for the | ||
| 210 | ppp/hdlc layer. | ||
| 211 | </para> | 197 | </para> |
| 212 | <para> | 198 | <para> |
| 213 | Before you register your network device you will also need to | 199 | Before you register your network device you will also need to |
| @@ -314,10 +300,10 @@ | |||
| 314 | buffer in sk_buff format and queues it for transmission. The | 300 | buffer in sk_buff format and queues it for transmission. The |
| 315 | caller must provide the entire packet with the exception of the | 301 | caller must provide the entire packet with the exception of the |
| 316 | bitstuffing and CRC. This is normally done by the caller via | 302 | bitstuffing and CRC. This is normally done by the caller via |
| 317 | the syncppp interface layer. It returns 0 if the buffer has been | 303 | the generic HDLC interface layer. It returns 0 if the buffer has been |
| 318 | queued and non zero values for queue full. If the function accepts | 304 | queued and non zero values for queue full. If the function accepts |
| 319 | the buffer it becomes property of the Z8530 layer and the caller | 305 | the buffer it becomes property of the Z8530 layer and the caller |
| 320 | should not free it. | 306 | should not free it. |
| 321 | </para> | 307 | </para> |
| 322 | <para> | 308 | <para> |
| 323 | The function <function>z8530_get_stats</function> returns a pointer | 309 | The function <function>z8530_get_stats</function> returns a pointer |
