From: Martin Waitz Convert template files to XML Signed-off-by: Martin Waitz Signed-off-by: Andrew Morton --- 25-akpm/Documentation/DocBook/deviceiobook.tmpl | 4 25-akpm/Documentation/DocBook/gadget.tmpl | 5 25-akpm/Documentation/DocBook/journal-api.tmpl | 5 25-akpm/Documentation/DocBook/kernel-api.tmpl | 5 25-akpm/Documentation/DocBook/kernel-hacking.tmpl | 4 25-akpm/Documentation/DocBook/kernel-locking.tmpl | 240 +++---- 25-akpm/Documentation/DocBook/libata.tmpl | 4 25-akpm/Documentation/DocBook/librs.tmpl | 4 25-akpm/Documentation/DocBook/lsm.tmpl | 11 25-akpm/Documentation/DocBook/mcabook.tmpl | 4 25-akpm/Documentation/DocBook/mtdnand.tmpl | 4 25-akpm/Documentation/DocBook/procfs-guide.tmpl | 25 25-akpm/Documentation/DocBook/scsidrivers.tmpl | 5 25-akpm/Documentation/DocBook/sis900.tmpl | 554 +++++++++--------- 25-akpm/Documentation/DocBook/tulip-user.tmpl | 8 25-akpm/Documentation/DocBook/usb.tmpl | 5 25-akpm/Documentation/DocBook/via-audio.tmpl | 4 25-akpm/Documentation/DocBook/videobook.tmpl | 200 +++--- 25-akpm/Documentation/DocBook/wanbook.tmpl | 4 25-akpm/Documentation/DocBook/writing_usb_driver.tmpl | 4 25-akpm/Documentation/DocBook/z8530book.tmpl | 4 21 files changed, 574 insertions(+), 529 deletions(-) diff -puN Documentation/DocBook/deviceiobook.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/deviceiobook.tmpl --- 25/Documentation/DocBook/deviceiobook.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/deviceiobook.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,6 @@ - + + diff -puN Documentation/DocBook/gadget.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/gadget.tmpl --- 25/Documentation/DocBook/gadget.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/gadget.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,7 @@ - + + + USB Gadget API for Linux diff -puN Documentation/DocBook/journal-api.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/journal-api.tmpl --- 25/Documentation/DocBook/journal-api.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/journal-api.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,7 @@ - + + + The Linux Journalling API diff -puN Documentation/DocBook/kernel-api.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/kernel-api.tmpl --- 25/Documentation/DocBook/kernel-api.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,7 @@ - + + + The Linux Kernel API diff -puN Documentation/DocBook/kernel-hacking.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/kernel-hacking.tmpl --- 25/Documentation/DocBook/kernel-hacking.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/kernel-hacking.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,6 @@ - + + diff -puN Documentation/DocBook/kernel-locking.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/kernel-locking.tmpl --- 25/Documentation/DocBook/kernel-locking.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/kernel-locking.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,6 @@ - + + @@ -236,12 +238,12 @@ your task will put itself on the queue, and be woken up when the semaphore is released. This means the CPU will do something else while you are waiting, but there are many cases when you - simply can't sleep (see ), and so + simply can't sleep (see ), and so have to use a spinlock instead. Neither type of lock is recursive: see - . + . @@ -326,7 +328,7 @@ Note that you can also use spin_lock_irq() or spin_lock_irqsave() here, which stop - hardware interrupts as well: see . + hardware interrupts as well: see . @@ -403,7 +405,7 @@ The same softirq can run on the other CPUs: you can use a - per-CPU array (see ) for better + per-CPU array (see ) for better performance. If you're going so far as to use a softirq, you probably care about scalable performance enough to justify the extra complexity. @@ -545,120 +547,120 @@ Table of Locking Requirements - - - - -IRQ Handler A -IRQ Handler B -Softirq A -Softirq B -Tasklet A -Tasklet B -Timer A -Timer B -User Context A -User Context B - - - -IRQ Handler A -None - - - -IRQ Handler B -spin_lock_irqsave -None - - - -Softirq A -spin_lock_irq -spin_lock_irq -spin_lock - - - -Softirq B -spin_lock_irq -spin_lock_irq -spin_lock -spin_lock - - - -Tasklet A -spin_lock_irq -spin_lock_irq -spin_lock -spin_lock -None - - - -Tasklet B -spin_lock_irq -spin_lock_irq -spin_lock -spin_lock -spin_lock -None - - - -Timer A -spin_lock_irq -spin_lock_irq -spin_lock -spin_lock -spin_lock -spin_lock -None - - - -Timer B -spin_lock_irq -spin_lock_irq -spin_lock -spin_lock -spin_lock -spin_lock -spin_lock -None - - - -User Context A -spin_lock_irq -spin_lock_irq -spin_lock_bh -spin_lock_bh -spin_lock_bh -spin_lock_bh -spin_lock_bh -spin_lock_bh -None - - - -User Context B -spin_lock_irq -spin_lock_irq -spin_lock_bh -spin_lock_bh -spin_lock_bh -spin_lock_bh -spin_lock_bh -spin_lock_bh -down_interruptible -None - - - - -
+ + + + +IRQ Handler A +IRQ Handler B +Softirq A +Softirq B +Tasklet A +Tasklet B +Timer A +Timer B +User Context A +User Context B + + + +IRQ Handler A +None + + + +IRQ Handler B +spin_lock_irqsave +None + + + +Softirq A +spin_lock_irq +spin_lock_irq +spin_lock + + + +Softirq B +spin_lock_irq +spin_lock_irq +spin_lock +spin_lock + + + +Tasklet A +spin_lock_irq +spin_lock_irq +spin_lock +spin_lock +None + + + +Tasklet B +spin_lock_irq +spin_lock_irq +spin_lock +spin_lock +spin_lock +None + + + +Timer A +spin_lock_irq +spin_lock_irq +spin_lock +spin_lock +spin_lock +spin_lock +None + + + +Timer B +spin_lock_irq +spin_lock_irq +spin_lock +spin_lock +spin_lock +spin_lock +spin_lock +None + + + +User Context A +spin_lock_irq +spin_lock_irq +spin_lock_bh +spin_lock_bh +spin_lock_bh +spin_lock_bh +spin_lock_bh +spin_lock_bh +None + + + +User Context B +spin_lock_irq +spin_lock_irq +spin_lock_bh +spin_lock_bh +spin_lock_bh +spin_lock_bh +spin_lock_bh +spin_lock_bh +down_interruptible +None + + + + + diff -puN Documentation/DocBook/libata.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/libata.tmpl --- 25/Documentation/DocBook/libata.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/libata.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,6 @@ - + + diff -puN Documentation/DocBook/librs.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/librs.tmpl --- 25/Documentation/DocBook/librs.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/librs.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,6 @@ - + + diff -puN Documentation/DocBook/lsm.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/lsm.tmpl --- 25/Documentation/DocBook/lsm.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/lsm.tmpl Thu Mar 3 16:55:27 2005 @@ -1,6 +1,9 @@ - + + +
- + Linux Security Modules: General Security Hooks for Linux @@ -28,7 +31,7 @@ - + Introduction @@ -84,7 +87,7 @@ security; it merely provides the infrast modules. The LSM kernel patch also moves most of the capabilities logic into an optional security module, with the system defaulting to the traditional superuser logic. This capabilities module -is discussed further in . +is discussed further in . diff -puN Documentation/DocBook/mcabook.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/mcabook.tmpl --- 25/Documentation/DocBook/mcabook.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/mcabook.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,6 @@ - + + diff -puN Documentation/DocBook/mtdnand.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/mtdnand.tmpl --- 25/Documentation/DocBook/mtdnand.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/mtdnand.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,6 @@ - + + diff -puN Documentation/DocBook/procfs-guide.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/procfs-guide.tmpl --- 25/Documentation/DocBook/procfs-guide.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/procfs-guide.tmpl Thu Mar 3 16:55:27 2005 @@ -1,5 +1,6 @@ - - + ]> @@ -205,7 +206,7 @@ function will return a pointer to the freshly created struct proc_dir_entry; otherwise it will return NULL. describes how to do something useful with + linkend="userland"/> describes how to do something useful with regular files. @@ -221,7 +222,7 @@ If you only want to be able to read the file, the function create_proc_read_entry described in may be used to create and initialise + linkend="convenience"/> may be used to create and initialise the procfs entry in one single call. @@ -298,7 +299,7 @@ the struct proc_dir_entry before remove_proc_entry is called (that is: if there was some data allocated, of - course). See for more information + course). See for more information on using the data entry. @@ -333,7 +334,7 @@ entry->write_proc = write_proc_foo; If you only want to use a the read_proc, the function create_proc_read_entry described in may be used to create and initialise the + linkend="convenience"/> may be used to create and initialise the procfs entry in one single call. @@ -386,7 +387,7 @@ entry->write_proc = write_proc_foo; The parameter start doesn't seem to be used anywhere in the kernel. The data parameter can be used to create a single call back function for - several files, see . + several files, see . @@ -395,7 +396,7 @@ entry->write_proc = write_proc_foo; - shows how to use a read call back + shows how to use a read call back function. @@ -429,12 +430,12 @@ entry->write_proc = write_proc_foo; kernel's memory space, so it should first be copied to kernel space with copy_from_user. The file parameter is usually - ignored. shows how to use the + ignored. shows how to use the data parameter. - Again, shows how to use this call back + Again, shows how to use this call back function. @@ -525,10 +526,10 @@ int foo_read_func(char *page, char **sta This function creates a regular file in exactly the same way as create_proc_entry from does, but also allows to set the read + linkend="regularfile"/> does, but also allows to set the read function read_proc in one call. This function can set the data as well, like - explained in . + explained in . diff -puN Documentation/DocBook/scsidrivers.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/scsidrivers.tmpl --- 25/Documentation/DocBook/scsidrivers.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/scsidrivers.tmpl Thu Mar 3 16:55:27 2005 @@ -1,5 +1,6 @@ - - + + diff -puN Documentation/DocBook/sis900.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/sis900.tmpl --- 25/Documentation/DocBook/sis900.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/sis900.tmpl Thu Mar 3 16:55:27 2005 @@ -1,25 +1,27 @@ - + + -SiS 900/7016 Fast Ethernet Device Driver +SiS 900/7016 Fast Ethernet Device Driver -Ollie +Ollie Lho -Lei Chun +Lei Chun Chang Document Revision: 0.3 for SiS900 driver v1.06 & v1.07 -November 16, 2000 +November 16, 2000 1999 @@ -48,21 +50,21 @@ - - + + This document gives some information on installation and usage of SiS 900/7016 device driver under Linux. - - + + - Introduction + Introduction - + This document describes the revision 1.06 and 1.07 of SiS 900/7016 Fast Ethernet device driver under Linux. The driver is developed by Silicon Integrated System Corp. and distributed freely under the GNU General Public License (GPL). @@ -70,265 +72,265 @@ The driver can be compiled as a loadable version 2.2.x. (rev. 1.06) With minimal changes, the driver can also be used under 2.3.x and 2.4.x kernel (rev. 1.07), please see -. If you are intended to +. If you are intended to use the driver for earlier kernels, you are on your own. - + - + The driver is tested with usual TCP/IP applications including FTP, Telnet, Netscape etc. and is used constantly by the developers. - + - + Please send all comments/fixes/questions to -Lei-Chun Chang. - +Lei-Chun Chang. + - Changes + Changes - + Changes made in Revision 1.07 - - - + + + Separation of sis900.c and sis900.h in order to move most constant definition to sis900.h (many of those constants were corrected) - - + + - - + + Clean up PCI detection, the pci-scan from Donald Becker were not used, just simple pci_find_*. - - + + - - + + MII detection is modified to support multiple mii transceiver. - - + + - - + + Bugs in read_eeprom, mdio_* were removed. - - + + - - + + Lot of sis900 irrelevant comments were removed/changed and more comments were added to reflect the real situation. - - + + - - + + Clean up of physical/virtual address space mess in buffer descriptors. - - + + - - + + Better transmit/receive error handling. - - + + - - + + The driver now uses zero-copy single buffer management scheme to improve performance. - - + + - - + + Names of variables were changed to be more consistent. - - + + - - + + Clean up of auo-negotiation and timer code. - - + + - - + + Automatic detection and change of PHY on the fly. - - + + - - + + Bug in mac probing fixed. - - + + - - + + Fix 630E equalier problem by modifying the equalizer workaround rule. - - + + - - + + Support for ICS1893 10/100 Interated PHYceiver. - - + + - - + + Support for media select by ifconfig. - - + + - - + + Added kernel-doc extratable documentation. - - + + - - + + - Tested Environment + Tested Environment - + This driver is developed on the following hardware - - + + - + Intel Celeron 500 with SiS 630 (rev 02) chipset - - - + + + - + SiS 900 (rev 01) and SiS 7016/7014 Fast Ethernet Card - - + + - + and tested with these software environments - - + + - + Red Hat Linux version 6.2 - - - + + + - + Linux kernel version 2.4.0 - - - + + + - + Netscape version 4.6 - - - + + + - + NcFTP 3.0.0 beta 18 - - - + + + - + Samba version 2.0.3 - - + + - + - + -Files in This Package +Files in This Package - + In the package you can find these files: - + - - + + - -sis900.c - - + +sis900.c + + Driver source file in C - - - - - -sis900.h - - + + + + + +sis900.h + + Header file for sis900.c - - - - - -sis900.sgml - - + + + + + +sis900.sgml + + DocBook SGML source of the document - - - - - -sis900.txt - - + + + + + +sis900.txt + + Driver document in plain text - - - + + + - - + + - Installation + Installation - + Silicon Integrated System Corp. is cooperating closely with core Linux Kernel developers. The revisions of SiS 900 driver are distributed by the usuall channels for kernel tar files and patches. Those kernel tar files for official kernel and patches for kernel pre-release can be download at -official kernel ftp site +official kernel ftp site and its mirrors. The 1.06 revision can be found in kernel version later than 2.3.15 and pre-2.2.14, and 1.07 revision can be found in kernel version 2.4.0. If you have no prior experience in networking under Linux, please read -Ethernet HOWTO and -Networking HOWTO available from +Ethernet HOWTO and +Networking HOWTO available from Linux Documentation Project (LDP). - + - + The driver is bundled in release later than 2.2.11 and 2.3.15 so this is the most easy case. Be sure you have the appropriate packages for compiling kernel source. @@ -338,63 +340,63 @@ in kernel release, you should have your sis900.c and sis900.h copied into /usr/src/linux/drivers/net/ first. There are two alternative ways to install the driver - + - -Building the driver as loadable module + +Building the driver as loadable module - + To build the driver as a loadable kernel module you have to reconfigure the kernel to activate network support by - + - + make menuconfig - + - + Choose Loadable module support --->, then select Enable loadable module support. - + - + Choose Network Device Support --->, select Ethernet (10 or 100Mbit). Then select EISA, VLB, PCI and on board controllers, and choose SiS 900/7016 PCI Fast Ethernet Adapter support to M. - + - + After reconfiguring the kernel, you can make the driver module by - + - + make modules - + - + The driver should be compiled with no errors. After compiling the driver, the driver can be installed to proper place by - + - + make modules_install - + - + Load the driver into kernel by - + - + insmod sis900 - + - + When loading the driver into memory, some information message can be view by - + - + dmesg @@ -404,103 +406,103 @@ or cat /var/log/message - + - + If the driver is loaded properly you will have messages similar to this: - + - + sis900.c: v1.07.06 11/07/2000 eth0: SiS 900 PCI Fast Ethernet at 0xd000, IRQ 10, 00:00:e8:83:7f:a4. eth0: SiS 900 Internal MII PHY transceiver found at address 1. eth0: Using SiS 900 Internal MII PHY as default - + - + showing the version of the driver and the results of probing routine. - + - + Once the driver is loaded, network can be brought up by - + - + /sbin/ifconfig eth0 IPADDR broadcast BROADCAST netmask NETMASK media TYPE - + - + where IPADDR, BROADCAST, NETMASK are your IP address, broadcast address and netmask respectively. TYPE is used to set medium type used by the device. Typical values are "10baseT"(twisted-pair 10Mbps Ethernet) or "100baseT" (twisted-pair 100Mbps Ethernet). For more information on how to configure network interface, please refer to -Networking HOWTO. - +Networking HOWTO. + - + The link status is also shown by kernel messages. For example, after the network interface is activated, you may have the message: - + - + eth0: Media Link On 100mbps full-duplex - + - + If you try to unplug the twist pair (TP) cable you will get - + - + eth0: Media Link Off - + - + indicating that the link is failed. - - + + - -Building the driver into kernel + +Building the driver into kernel - + If you want to make the driver into kernel, choose Y rather than M on SiS 900/7016 PCI Fast Ethernet Adapter support when configuring the kernel. Build the kernel image in the usual way - + - + make clean make bzlilo - + - + Next time the system reboot, you have the driver in memory. - + - + - Known Problems and Bugs + Known Problems and Bugs - + There are some known problems and bugs. If you find any other bugs please -mail to lcchang@sis.com.tw +mail to lcchang@sis.com.tw - + - - + + AM79C901 HomePNA PHY is not thoroughly tested, there may be some bugs in the on the fly change of transceiver. - - + + - - + + A bug is hidden somewhere in the receive buffer management code, the bug causes NULL pointer reference in the kernel. This fault is caught before bad things happen and reported with the message: @@ -509,70 +511,70 @@ caught before bad things happen and repo eth0: NULL pointer encountered in Rx ring, skipping -which can be viewed with dmesg or -cat /var/log/message. - - +which can be viewed with dmesg or +cat /var/log/message. + + - - + + The media type change from 10Mbps to 100Mbps twisted-pair ethernet by ifconfig causes the media link down. - - + + - - + + - Revision History + Revision History - - + + - - + + November 13, 2000, Revision 1.07, seventh release, 630E problem fixed and further clean up. - - + + - - + + November 4, 1999, Revision 1.06, Second release, lots of clean up and optimization. - - + + - - + + August 8, 1999, Revision 1.05, Initial Public Release - - + + - - + + - Acknowledgements + Acknowledgements - + This driver was originally derived form -Donald Becker's -pci-skeleton and -rtl8139 drivers. Donald also provided various suggestion +Donald Becker's +pci-skeleton and +rtl8139 drivers. Donald also provided various suggestion regarded with improvements made in revision 1.06. - + - + The 1.05 revision was created by -Jim Huang, AMD 79c901 -support was added by Chin-Shan Li. - +Jim Huang, AMD 79c901 +support was added by Chin-Shan Li. + diff -puN Documentation/DocBook/tulip-user.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/tulip-user.tmpl --- 25/Documentation/DocBook/tulip-user.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/tulip-user.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,6 @@ - + + @@ -67,7 +69,7 @@ Jeff Garzik, Takashi Manabe and a cast o For 2.4.x and later kernels, the Linux Tulip driver is available at -http://sourceforge.net/projects/tulip/ +http://sourceforge.net/projects/tulip/ @@ -85,7 +87,7 @@ For 2.4.x and later kernels, the Linux T Additional information on Donald Becker's tulip.c - is available at http://www.scyld.com/network/tulip.html + is available at http://www.scyld.com/network/tulip.html diff -puN Documentation/DocBook/usb.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/usb.tmpl --- 25/Documentation/DocBook/usb.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/usb.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,7 @@ - + + + The Linux-USB Host Side API diff -puN Documentation/DocBook/via-audio.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/via-audio.tmpl --- 25/Documentation/DocBook/via-audio.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/via-audio.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,6 @@ - + + diff -puN Documentation/DocBook/videobook.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/videobook.tmpl --- 25/Documentation/DocBook/videobook.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/videobook.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,6 @@ - + + @@ -180,23 +182,23 @@ int __init myradio_init(struct video_ini - VFL_TYPE_RADIO/dev/radio{n} + VFL_TYPE_RADIO/dev/radio{n} Radio devices are assigned in this block. As with all of these selections the actual number assignment is done by the video layer accordijng to what is free. - VFL_TYPE_GRABBER/dev/video{n} + VFL_TYPE_GRABBER/dev/video{n} Video capture devices and also -- counter-intuitively for the name -- hardware video playback devices such as MPEG2 cards. - VFL_TYPE_VBI/dev/vbi{n} + VFL_TYPE_VBI/dev/vbi{n} The VBI devices capture the hidden lines on a television picture that carry further information like closed caption data, teletext (primarily in Europe) and now Intercast and the ATVEC internet television encodings. - VFL_TYPE_VTX/dev/vtx[n} + VFL_TYPE_VTX/dev/vtx[n} VTX is 'Videotext' also known as 'Teletext'. This is a system for sending numbered, 40x25, mostly textual page images over the hidden lines. Unlike the /dev/vbi interfaces, this is for 'smart' decoder @@ -301,25 +303,25 @@ static int radio_ioctl(struct video_devi - nameThe device text name. This is intended for the user. + nameThe device text name. This is intended for the user. - channelsThe number of different channels you can tune on + channelsThe number of different channels you can tune on this card. It could even by zero for a card that has no tuning capability. For our simple FM radio it is 1. An AM/FM radio would report 2. - audiosThe number of audio inputs on this device. For our + audiosThe number of audio inputs on this device. For our radio there is only one audio input. - minwidth,minheightThe smallest size the card is capable of capturing + minwidth,minheightThe smallest size the card is capable of capturing images in. We set these to zero. Radios do not capture pictures - maxwidth,maxheightThe largest image size the card is capable of + maxwidth,maxheightThe largest image size the card is capable of capturing. For our radio we report 0. - typeThis reports the capabilities of the device, and + typeThis reports the capabilities of the device, and matches the field we filled in in the struct video_device when registering. @@ -375,26 +377,26 @@ static int radio_ioctl(struct video_devi - int tunerThe number of the tuner in question + int tunerThe number of the tuner in question - char name[32]A text description of this tuner. "FM" will do fine. + char name[32]A text description of this tuner. "FM" will do fine. This is intended for the application. - u32 flags + u32 flags Tuner capability flags - u16 modeThe current reception mode + u16 modeThe current reception mode - u16 signalThe signal strength scaled between 0 and 65535. If + u16 signalThe signal strength scaled between 0 and 65535. If a device cannot tell the signal strength it should report 65535. Many simple cards contain only a signal/no signal bit. Such cards will report either 0 or 65535. - u32 rangelow, rangehigh + u32 rangelow, rangehigh The range of frequencies supported by the radio or TV. It is scaled according to the VIDEO_TUNER_LOW flag. @@ -408,20 +410,20 @@ static int radio_ioctl(struct video_devi - VIDEO_TUNER_PALA PAL TV tuner + VIDEO_TUNER_PALA PAL TV tuner - VIDEO_TUNER_NTSCAn NTSC (US) TV tuner + VIDEO_TUNER_NTSCAn NTSC (US) TV tuner - VIDEO_TUNER_SECAMA SECAM (French) TV tuner + VIDEO_TUNER_SECAMA SECAM (French) TV tuner - VIDEO_TUNER_LOW + VIDEO_TUNER_LOW The tuner frequency is scaled in 1/16th of a KHz steps. If not it is in 1/16th of a MHz steps - VIDEO_TUNER_NORMThe tuner can set its format + VIDEO_TUNER_NORMThe tuner can set its format - VIDEO_TUNER_STEREO_ONThe tuner is currently receiving a stereo signal + VIDEO_TUNER_STEREO_ONThe tuner is currently receiving a stereo signal @@ -431,13 +433,13 @@ static int radio_ioctl(struct video_devi - VIDEO_MODE_PALPAL Format + VIDEO_MODE_PALPAL Format - VIDEO_MODE_NTSCNTSC Format (USA) + VIDEO_MODE_NTSCNTSC Format (USA) - VIDEO_MODE_SECAMFrench Format + VIDEO_MODE_SECAMFrench Format - VIDEO_MODE_AUTOA device that does not need to do + VIDEO_MODE_AUTOA device that does not need to do TV format switching @@ -582,32 +584,32 @@ static int current_volume=0; - audioThe input the user wishes to query + audioThe input the user wishes to query - volumeThe volume setting on a scale of 0-65535 + volumeThe volume setting on a scale of 0-65535 - baseThe base level on a scale of 0-65535 + baseThe base level on a scale of 0-65535 - trebleThe treble level on a scale of 0-65535 + trebleThe treble level on a scale of 0-65535 - flagsThe features this audio device supports + flagsThe features this audio device supports - nameA text name to display to the user. We picked - "Radio" as it explains things quite nicely. + nameA text name to display to the user. We picked + "Radio" as it explains things quite nicely. - modeThe current reception mode for the audio + modeThe current reception mode for the audio We report MONO because our card is too stupid to know if it is in mono or stereo. - balanceThe stereo balance on a scale of 0-65535, 32768 is - middle. + balanceThe stereo balance on a scale of 0-65535, 32768 is + middle. - stepThe step by which the volume control jumps. This is + stepThe step by which the volume control jumps. This is used to help make it easy for applications to set - slider behaviour. + slider behaviour. @@ -617,15 +619,15 @@ static int current_volume=0; - VIDEO_AUDIO_MUTEThe audio is currently muted. We + VIDEO_AUDIO_MUTEThe audio is currently muted. We could fake this in our driver but we choose not to bother. - VIDEO_AUDIO_MUTABLEThe input has a mute option + VIDEO_AUDIO_MUTABLEThe input has a mute option - VIDEO_AUDIO_TREBLEThe input has a treble control + VIDEO_AUDIO_TREBLEThe input has a treble control - VIDEO_AUDIO_BASSThe input has a base control + VIDEO_AUDIO_BASSThe input has a base control @@ -635,13 +637,13 @@ static int current_volume=0; - VIDEO_SOUND_MONOMono sound + VIDEO_SOUND_MONOMono sound - VIDEO_SOUND_STEREOStereo sound + VIDEO_SOUND_STEREOStereo sound - VIDEO_SOUND_LANG1Alternative language 1 (TV specific) + VIDEO_SOUND_LANG1Alternative language 1 (TV specific) - VIDEO_SOUND_LANG2Alternative language 2 (TV specific) + VIDEO_SOUND_LANG2Alternative language 2 (TV specific) @@ -866,37 +868,37 @@ static struct video_device my_camera -VID_TYPE_CAPTUREWe support image capture +VID_TYPE_CAPTUREWe support image capture -VID_TYPE_TELETEXTA teletext capture device (vbi{n]) +VID_TYPE_TELETEXTA teletext capture device (vbi{n]) -VID_TYPE_OVERLAYThe image can be directly overlaid onto the - frame buffer +VID_TYPE_OVERLAYThe image can be directly overlaid onto the + frame buffer -VID_TYPE_CHROMAKEYChromakey can be used to select which parts - of the image to display +VID_TYPE_CHROMAKEYChromakey can be used to select which parts + of the image to display -VID_TYPE_CLIPPINGIt is possible to give the board a list of - rectangles to draw around. +VID_TYPE_CLIPPINGIt is possible to give the board a list of + rectangles to draw around. -VID_TYPE_FRAMERAMThe video capture goes into the video memory +VID_TYPE_FRAMERAMThe video capture goes into the video memory and actually changes it. Applications need to know this so they can clean up after the - card + card -VID_TYPE_SCALESThe image can be scaled to various sizes, - rather than being a single fixed size. +VID_TYPE_SCALESThe image can be scaled to various sizes, + rather than being a single fixed size. -VID_TYPE_MONOCHROMEThe capture will be monochrome. This isn't a +VID_TYPE_MONOCHROMEThe capture will be monochrome. This isn't a complete answer to the question since a mono camera on a colour capture card will still - produce mono output. + produce mono output. -VID_TYPE_SUBCAPTUREThe card allows only part of its field of +VID_TYPE_SUBCAPTUREThe card allows only part of its field of view to be captured. This enables applications to avoid copying all of a large image into memory when only some section is - relevant. + relevant. @@ -1207,18 +1209,18 @@ static int camera_ioctl(struct video_dev - channelThe channel number we are selecting + channelThe channel number we are selecting - nameThe name for this channel. This is intended + nameThe name for this channel. This is intended to describe the port to the user. Appropriate names are therefore things like "Camera" "SCART input" - flagsChannel properties + flagsChannel properties - typeInput type + typeInput type - normThe current television encoding being used + normThe current television encoding being used if relevant for this channel. @@ -1229,9 +1231,9 @@ static int camera_ioctl(struct video_dev - VIDEO_VC_TUNERChannel has a tuner. + VIDEO_VC_TUNERChannel has a tuner. - VIDEO_VC_AUDIOChannel has audio. + VIDEO_VC_AUDIOChannel has audio. @@ -1240,11 +1242,11 @@ static int camera_ioctl(struct video_dev - VIDEO_TYPE_TVTelevision input. + VIDEO_TYPE_TVTelevision input. - VIDEO_TYPE_CAMERAFixed camera input. + VIDEO_TYPE_CAMERAFixed camera input. - 0Type is unknown. + 0Type is unknown. @@ -1253,13 +1255,13 @@ static int camera_ioctl(struct video_dev - VIDEO_MODE_PALPAL encoded Television + VIDEO_MODE_PALPAL encoded Television - VIDEO_MODE_NTSCNTSC (US) encoded Television + VIDEO_MODE_NTSCNTSC (US) encoded Television - VIDEO_MODE_SECAMSECAM (French) Television + VIDEO_MODE_SECAMSECAM (French) Television - VIDEO_MODE_AUTOAutomatic switching, or format does not + VIDEO_MODE_AUTOAutomatic switching, or format does not matter @@ -1339,14 +1341,14 @@ static int camera_ioctl(struct video_dev - GREYLinear greyscale. This is for simple cameras and the - like + GREYLinear greyscale. This is for simple cameras and the + like - RGB565The top 5 bits hold 32 red levels, the next six bits - hold green and the low 5 bits hold blue. + RGB565The top 5 bits hold 32 red levels, the next six bits + hold green and the low 5 bits hold blue. - RGB555The top bit is clear. The red green and blue levels - each occupy five bits. + RGB555The top bit is clear. The red green and blue levels + each occupy five bits. @@ -1477,32 +1479,32 @@ static struct video_buffer capture_fb; - widthThe width in pixels of the desired image. The card - may use a smaller size if this size is not available + widthThe width in pixels of the desired image. The card + may use a smaller size if this size is not available - heightThe height of the image. The card may use a smaller - size if this size is not available. + heightThe height of the image. The card may use a smaller + size if this size is not available. - x The X position of the top left of the window. This + x The X position of the top left of the window. This is in pixels relative to the left hand edge of the picture. Not all cards can display images aligned on any pixel boundary. If the position is unsuitable the card adjusts the image right and reduces the - width. + width. - y The Y position of the top left of the window. This + y The Y position of the top left of the window. This is counted in pixels relative to the top edge of the picture. As with the width if the card cannot display starting on this line it will adjust the - values. + values. - chromakeyThe colour (expressed in RGB32 format) for the - chromakey colour if chroma keying is being used. + chromakeyThe colour (expressed in RGB32 format) for the + chromakey colour if chroma keying is being used. - clipsAn array of rectangles that must not be drawn - over. + clipsAn array of rectangles that must not be drawn + over. - clipcountThe number of clips in this array. + clipcountThe number of clips in this array. @@ -1514,11 +1516,11 @@ static struct video_buffer capture_fb; - x, yCo-ordinates relative to the display + x, yCo-ordinates relative to the display - width, heightWidth and height in pixels + width, heightWidth and height in pixels - nextA spare field for the application to use + nextA spare field for the application to use diff -puN Documentation/DocBook/wanbook.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/wanbook.tmpl --- 25/Documentation/DocBook/wanbook.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/wanbook.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,6 @@ - + + diff -puN Documentation/DocBook/writing_usb_driver.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/writing_usb_driver.tmpl --- 25/Documentation/DocBook/writing_usb_driver.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/writing_usb_driver.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,6 @@ - + + diff -puN Documentation/DocBook/z8530book.tmpl~docbook-convert-template-files-to-xml Documentation/DocBook/z8530book.tmpl --- 25/Documentation/DocBook/z8530book.tmpl~docbook-convert-template-files-to-xml Thu Mar 3 16:55:27 2005 +++ 25-akpm/Documentation/DocBook/z8530book.tmpl Thu Mar 3 16:55:27 2005 @@ -1,4 +1,6 @@ - + + _