[patch 5/6] DocBook: remove obsolete templates

From: Martin Waitz (tali_at_admingilde.org)
Date: 04/06/05

  • Next message: Martin Waitz: "[patch 1/6] DocBook: changes and extensions to the kernel documentation"
    Date:	Wed, 06 Apr 2005 13:46:15 +0200
    To: Andrew Morton <akpm@osdl.org>
    
    

    DocBook: remove obsolete templates

    From: Jeff Garzik <jgarzik@pobox.com>

    As the author of tulip-user and via-audio docbooks, I can say that
    they are out of date and should be deleted.

    Signed-off-by: Martin Waitz <tali@admingilde.org>

     Documentation/DocBook/tulip-user.tmpl | 327 ------------------
     Documentation/DocBook/via-audio.tmpl | 597 ----------------------------------
     Documentation/DocBook/Makefile | 7
     3 files changed, 3 insertions(+), 928 deletions(-)

    Index: linux-docbook/Documentation/DocBook/Makefile
    ===================================================================
    --- linux-docbook.orig/Documentation/DocBook/Makefile 2005-04-06 12:12:46.103850545 +0200
    +++ linux-docbook/Documentation/DocBook/Makefile 2005-04-06 12:25:19.150939983 +0200
    @@ -7,10 +7,9 @@
     # list of DOCBOOKS.
     
     DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \
    - kernel-hacking.xml kernel-locking.xml via-audio.xml \
    - deviceiobook.xml procfs-guide.xml tulip-user.xml \
    - writing_usb_driver.xml scsidrivers.xml sis900.xml \
    - kernel-api.xml journal-api.xml lsm.xml usb.xml \
    + kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
    + procfs-guide.xml writing_usb_driver.xml scsidrivers.xml \
    + sis900.xml kernel-api.xml journal-api.xml lsm.xml usb.xml \
                 gadget.xml libata.xml mtdnand.xml librs.xml
     
     ###
    Index: linux-docbook/Documentation/DocBook/via-audio.tmpl
    ===================================================================
    --- linux-docbook.orig/Documentation/DocBook/via-audio.tmpl 2005-04-06 12:12:46.103850545 +0200
    +++ /dev/null 1970-01-01 00:00:00.000000000 +0000
    @@ -1,597 +0,0 @@
    -<?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="ViaAudioGuide">
    - <bookinfo>
    - <title>Via 686 Audio Driver for Linux</title>
    -
    - <authorgroup>
    - <author>
    - <firstname>Jeff</firstname>
    - <surname>Garzik</surname>
    - </author>
    - </authorgroup>
    -
    - <copyright>
    - <year>1999-2001</year>
    - <holder>Jeff Garzik</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 as published by the Free Software Foundation; either
    - version 2 of the License, or (at your option) any later
    - version.
    - </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="intro">
    - <title>Introduction</title>
    - <para>
    - The Via VT82C686A "super southbridge" chips contain
    - AC97-compatible audio logic which features dual 16-bit stereo
    - PCM sound channels (full duplex), plus a third PCM channel intended for use
    - in hardware-assisted FM synthesis.
    - </para>
    - <para>
    - The current Linux kernel audio driver for this family of chips
    - supports audio playback and recording, but hardware-assisted
    - FM features, and hardware buffer direct-access (mmap)
    - support are not yet available.
    - </para>
    - <para>
    - This driver supports any Linux kernel version after 2.4.10.
    - </para>
    - <para>
    - Please send bug reports to the mailing list <email>linux-via@gtf.org</email>.
    - To subscribe, e-mail <email>majordomo@gtf.org</email> with
    - </para>
    - <programlisting>
    - subscribe linux-via
    - </programlisting>
    - <para>
    - in the body of the message.
    - </para>
    - </chapter>
    -
    - <chapter id="install">
    - <title>Driver Installation</title>
    - <para>
    - To use this audio driver, select the
    - CONFIG_SOUND_VIA82CXXX option in the section Sound during kernel configuration.
    - Follow the usual kernel procedures for rebuilding the kernel,
    - or building and installing driver modules.
    - </para>
    - <para>
    - To make this driver the default audio driver, you can add the
    - following to your /etc/conf.modules file:
    - </para>
    - <programlisting>
    - alias sound via82cxxx_audio
    - </programlisting>
    - <para>
    - Note that soundcore and ac97_codec support modules
    - are also required for working audio, in addition to
    - the via82cxxx_audio module itself.
    - </para>
    - </chapter>
    -
    - <chapter id="reportbug">
    - <title>Submitting a bug report</title>
    - <sect1 id="bugrepdesc"><title>Description of problem</title>
    - <para>
    - Describe the application you were using to play/record sound, and how
    - to reproduce the problem.
    - </para>
    - </sect1>
    - <sect1 id="bugrepdiag"><title>Diagnostic output</title>
    - <para>
    - Obtain the via-audio-diag diagnostics program from
    - http://sf.net/projects/gkernel/ and provide a dump of the
    - audio chip's registers while the problem is occurring. Sample command line:
    - </para>
    - <programlisting>
    - ./via-audio-diag -aps > diag-output.txt
    - </programlisting>
    - </sect1>
    - <sect1 id="bugrepdebug"><title>Driver debug output</title>
    - <para>
    - Define <constant>VIA_DEBUG</constant> at the beginning of the driver, then capture and email
    - the kernel log output. This can be viewed in the system kernel log (if
    - enabled), or via the dmesg program. Sample command line:
    - </para>
    - <programlisting>
    - dmesg > /tmp/dmesg-output.txt
    - </programlisting>
    - </sect1>
    - <sect1 id="bugrepprintk"><title>Bigger kernel message buffer</title>
    - <para>
    - If you wish to increase the size of the buffer displayed by dmesg, then
    - change the <constant>LOG_BUF_LEN</constant> macro at the top of linux/kernel/printk.c, recompile
    - your kernel, and pass the <constant>LOG_BUF_LEN</constant> value to dmesg. Sample command line with
    - <constant>LOG_BUF_LEN</constant> == 32768:
    - </para>
    - <programlisting>
    - dmesg -s 32768 > /tmp/dmesg-output.txt
    - </programlisting>
    - </sect1>
    - </chapter>
    -
    - <chapter id="bugs">
    - <title>Known Bugs And Assumptions</title>
    - <para>
    - <variablelist>
    - <varlistentry><term>Low volume</term>
    - <listitem>
    - <para>
    - Volume too low on many systems. Workaround: use mixer program
    - such as xmixer to increase volume.
    - </para>
    - </listitem></varlistentry>
    -
    - </variablelist>
    -
    - </para>
    - </chapter>
    -
    - <chapter id="thanks">
    - <title>Thanks</title>
    - <para>
    - Via for providing e-mail support, specs, and NDA'd source code.
    - </para>
    - <para>
    - MandrakeSoft for providing hacking time.
    - </para>
    - <para>
    - AC97 mixer interface fixes and debugging by Ron Cemer <email>roncemer@gte.net</email>.
    - </para>
    - <para>
    - Rui Sousa <email>rui.sousa@conexant.com</email>, for bugfixing
    - MMAP support, and several other notable fixes that resulted from
    - his hard work and testing.
    - </para>
    - <para>
    - Adrian Cox <email>adrian@humboldt.co.uk</email>, for bugfixing
    - MMAP support, and several other notable fixes that resulted from
    - his hard work and testing.
    - </para>
    - <para>
    - Thomas Sailer for further bugfixes.
    - </para>
    - </chapter>
    -
    - <chapter id="notes">
    - <title>Random Notes</title>
    - <para>
    - Two /proc pseudo-files provide diagnostic information. This is generally
    - not useful to most users. Power users can disable CONFIG_SOUND_VIA82CXXX_PROCFS,
    - and remove the /proc support code. Once
    - version 2.0.0 is released, the /proc support code will be disabled by
    - default. Available /proc pseudo-files:
    - </para>
    - <programlisting>
    - /proc/driver/via/0/info
    - /proc/driver/via/0/ac97
    - </programlisting>
    - <para>
    - This driver by default supports all PCI audio devices which report
    - a vendor id of 0x1106, and a device id of 0x3058. Subsystem vendor
    - and device ids are not examined.
    - </para>
    - <para>
    - GNU indent formatting options:
    - <programlisting>
    --kr -i8 -ts8 -br -ce -bap -sob -l80 -pcs -cs -ss -bs -di1 -nbc -lp -psl
    - </programlisting>
    - </para>
    - <para>
    - Via has graciously donated e-mail support and source code to help further
    - the development of this driver. Their assistance has been invaluable
    - in the design and coding of the next major version of this driver.
    - </para>
    - <para>
    - The Via audio chip apparently provides a second PCM scatter-gather
    - DMA channel just for FM data, but does not have a full hardware MIDI
    - processor. I haven't put much thought towards a solution here, but it
    - might involve using SoftOSS midi wave table, or simply disabling MIDI
    - support altogether and using the FM PCM channel as a second (input? output?)
    - </para>
    - </chapter>
    -
    - <chapter id="changelog">
    - <title>Driver ChangeLog</title>
    -
    -<sect1 id="version191"><title>
    -Version 1.9.1
    -</title>
    - <itemizedlist spacing="compact">
    - <listitem>
    - <para>
    - DSP read/write bugfixes from Thomas Sailer.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Add new PCI id for single-channel use of Via 8233.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Other bug fixes, tweaks, new ioctls.
    - </para>
    - </listitem>
    -
    - </itemizedlist>
    -</sect1>
    -
    -<sect1 id="version1115"><title>
    -Version 1.1.15
    -</title>
    - <itemizedlist spacing="compact">
    - <listitem>
    - <para>
    - Support for variable fragment size and variable fragment number (Rui
    - Sousa)
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Fixes for the SPEED, STEREO, CHANNELS, FMT ioctls when in read &amp;
    - write mode (Rui Sousa)
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Mmaped sound is now fully functional. (Rui Sousa)
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Make sure to enable PCI device before reading any of its PCI
    - config information. (fixes potential hotplug problems)
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Clean up code a bit and add more internal function documentation.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - AC97 codec access fixes (Adrian Cox)
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Big endian fixes (Adrian Cox)
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - MIDI support (Adrian Cox)
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Detect and report locked-rate AC97 codecs. If your hardware only
    - supports 48Khz (locked rate), then your recording/playback software
    - must upsample or downsample accordingly. The hardware cannot do it.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Use new pci_request_regions and pci_disable_device functions in
    - kernel 2.4.6.
    - </para>
    - </listitem>
    -
    - </itemizedlist>
    -</sect1>
    -
    -<sect1 id="version1114"><title>
    -Version 1.1.14
    -</title>
    - <itemizedlist spacing="compact">
    - <listitem>
    - <para>
    - Use VM_RESERVE when available, to eliminate unnecessary page faults.
    - </para>
    - </listitem>
    - </itemizedlist>
    -</sect1>
    -
    -<sect1 id="version1112"><title>
    -Version 1.1.12
    -</title>
    - <itemizedlist spacing="compact">
    - <listitem>
    - <para>
    - mmap bug fixes from Linus.
    - </para>
    - </listitem>
    - </itemizedlist>
    -</sect1>
    -
    -<sect1 id="version1111"><title>
    -Version 1.1.11
    -</title>
    - <itemizedlist spacing="compact">
    - <listitem>
    - <para>
    - Many more bug fixes. mmap enabled by default, but may still be buggy.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Uses new and spiffy method of mmap'ing the DMA buffer, based
    - on a suggestion from Linus.
    - </para>
    - </listitem>
    - </itemizedlist>
    -</sect1>
    -
    -<sect1 id="version1110"><title>
    -Version 1.1.10
    -</title>
    - <itemizedlist spacing="compact">
    - <listitem>
    - <para>
    - Many bug fixes. mmap enabled by default, but may still be buggy.
    - </para>
    - </listitem>
    - </itemizedlist>
    -</sect1>
    -
    -<sect1 id="version119"><title>
    -Version 1.1.9
    -</title>
    - <itemizedlist spacing="compact">
    - <listitem>
    - <para>
    - Redesign and rewrite audio playback implementation. (faster and smaller, hopefully)
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Implement recording and full duplex (DSP_CAP_DUPLEX) support.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Make procfs support optional.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Quick interrupt status check, to lessen overhead in interrupt
    - sharing situations.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Add mmap(2) support. Disabled for now, it is still buggy and experimental.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Surround all syscalls with a semaphore for cheap and easy SMP protection.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Fix bug in channel shutdown (hardware channel reset) code.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Remove unnecessary spinlocks (better performance).
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Eliminate "unknown AFMT" message by using a different method
    - of selecting the best AFMT_xxx sound sample format for use.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Support for realtime hardware pointer position reporting
    - (DSP_CAP_REALTIME, SNDCTL_DSP_GETxPTR ioctls)
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Support for capture/playback triggering
    - (DSP_CAP_TRIGGER, SNDCTL_DSP_SETTRIGGER ioctls)
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - SNDCTL_DSP_SETDUPLEX and SNDCTL_DSP_POST ioctls now handled.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Rewrite open(2) and close(2) logic to allow only one user at
    - a time. All other open(2) attempts will sleep until they succeed.
    - FIXME: open(O_RDONLY) and open(O_WRONLY) should be allowed to succeed.
    - </para>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Reviewed code to ensure that SMP and multiple audio devices
    - are fully supported.
    - </para>
    - </listitem>
    -
    - </itemizedlist>
    -</sect1>
    -
    -<sect1 id="version118"><title>
    -Version 1.1.8
    -</title>
    - <itemizedlist spacing="compact">
    - <listitem>
    - <para>
    - Clean up interrupt handler output. Fixes the following kernel error message:
    - </para>
    - <programlisting>
    - unhandled interrupt ...
    - </programlisting>
    - </listitem>
    -
    - <listitem>
    - <para>
    - Convert documentation to DocBook, so that PDF, HTML and PostScript (.ps) output is readily
    - available.
    - </para>
    - </listitem>
    -
    - </itemizedlist>
    -</sect1>
    -
    -<sect1 id="version117"><title>
    -Version 1.1.7
    -</title>
    - <itemizedlist spacing="compact">
    - <listitem>
    - <para>
    - Fix module unload bug where mixer device left registered
    - after driver exit
    - </para>
    - </listitem>
    - </itemizedlist>
    -</sect1>
    -
    -<sect1 id="version116"><title>
    -Version 1.1.6
    -</title>
    - <itemizedlist spacing="compact">
    - <listitem>
    - <para>
    - Rewrite via_set_rate to mimic ALSA basic AC97 rate setting
    - </para>
    - </listitem>
    - <listitem>
    - <para>
    - Remove much dead code
    - </para>
    - </listitem>
    - <listitem>
    - <para>
    - Complete spin_lock_irqsave -> spin_lock_irq conversion in via_dsp_ioctl
    - </para>
    - </listitem>
    - <listitem>
    - <para>
    - Fix build problem in via_dsp_ioctl
    - </para>
    - </listitem>
    - <listitem>
    - <para>
    - Optimize included headers to eliminate headers found in linux/sound
    - </para>
    - </listitem>
    - </itemizedlist>
    -</sect1>
    -
    -<sect1 id="version115"><title>
    -Version 1.1.5
    -</title>
    - <itemizedlist spacing="compact">
    - <listitem>
    - <para>
    - Disable some overly-verbose debugging code
    - </para>
    - </listitem>
    - <listitem>
    - <para>
    - Remove unnecessary sound locks
    - </para>
    - </listitem>
    - <listitem>
    - <para>
    - Fix some ioctls for better time resolution
    - </para>
    - </listitem>
    - <listitem>
    - <para>
    - Begin spin_lock_irqsave -> spin_lock_irq conversion in via_dsp_ioctl
    - </para>
    - </listitem>
    - </itemizedlist>
    -</sect1>
    -
    -<sect1 id="version114"><title>
    -Version 1.1.4
    -</title>
    - <itemizedlist spacing="compact">
    - <listitem>
    - <para>
    - Completed rewrite of driver. Eliminated SoundBlaster compatibility
    - completely, and now uses the much-faster scatter-gather DMA engine.
    - </para>
    - </listitem>
    - </itemizedlist>
    -</sect1>
    -
    - </chapter>
    -
    - <chapter id="intfunctions">
    - <title>Internal Functions</title>
    -!Isound/oss/via82cxxx_audio.c
    - </chapter>
    -
    -</book>
    -
    -
    Index: linux-docbook/Documentation/DocBook/tulip-user.tmpl
    ===================================================================
    --- linux-docbook.orig/Documentation/DocBook/tulip-user.tmpl 2005-04-06 12:12:46.104850394 +0200
    +++ /dev/null 1970-01-01 00:00:00.000000000 +0000
    @@ -1,327 +0,0 @@
    -<?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="TulipUserGuide">
    - <bookinfo>
    - <title>Tulip Driver User's Guide</title>
    -
    - <authorgroup>
    - <author>
    - <firstname>Jeff</firstname>
    - <surname>Garzik</surname>
    - <affiliation>
    - <address>
    - <email>jgarzik@pobox.com</email>
    - </address>
    - </affiliation>
    - </author>
    - </authorgroup>
    -
    - <copyright>
    - <year>2001</year>
    - <holder>Jeff Garzik</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 as published by the Free Software Foundation; either
    - version 2 of the License, or (at your option) any later
    - version.
    - </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="intro">
    - <title>Introduction</title>
    -<para>
    -The Tulip Ethernet Card Driver
    -is maintained by Jeff Garzik (<email>jgarzik@pobox.com</email>).
    -</para>
    -
    -<para>
    -The Tulip driver was developed by Donald Becker and changed by
    -Jeff Garzik, Takashi Manabe and a cast of thousands.
    -</para>
    -
    -<para>
    -For 2.4.x and later kernels, the Linux Tulip driver is available at
    -<ulink url="http://sourceforge.net/projects/tulip/">http://sourceforge.net/projects/tulip/>
    -</para>
    -
    -<para>
    - This driver is for the Digital "Tulip" Ethernet adapter interface.
    - It should work with most DEC 21*4*-based chips/ethercards, as well as
    - with work-alike chips from Lite-On (PNIC) and Macronix (MXIC) and ASIX.
    -</para>
    -
    -<para>
    - The original author may be reached as becker@scyld.com, or C/O
    - Scyld Computing Corporation,
    - 410 Severn Ave., Suite 210,
    - Annapolis MD 21403
    -</para>
    -
    -<para>
    - Additional information on Donald Becker's tulip.c
    - is available at <ulink url="
    http://www.scyld.com/network/tulip.html">http://www.scyld.com/network/tulip.html>
    -</para>
    -
    - </chapter>
    -
    - <chapter id="drvr-compat">
    - <title>Driver Compatibility</title>
    -
    -<para>
    -This device driver is designed for the DECchip "Tulip", Digital's
    -single-chip ethernet controllers for PCI (now owned by Intel).
    -Supported members of the family
    -are the 21040, 21041, 21140, 21140A, 21142, and 21143. Similar work-alike
    -chips from Lite-On, Macronics, ASIX, Compex and other listed below are also
    -supported.
    -</para>
    -
    -<para>
    -These chips are used on at least 140 unique PCI board designs. The great
    -number of chips and board designs supported is the reason for the
    -driver size and complexity. Almost of the increasing complexity is in the
    -board configuration and media selection code. There is very little
    -increasing in the operational critical path length.
    -</para>
    - </chapter>
    -
    - <chapter id="board-settings">
    - <title>Board-specific Settings</title>
    -
    -<para>
    -PCI bus devices are configured by the system at boot time, so no jumpers
    -need to be set on the board. The system BIOS preferably should assign the
    -PCI INTA signal to an otherwise unused system IRQ line.
    -</para>
    -
    -<para>
    -Some boards have EEPROMs tables with default media entry. The factory default
    -is usually "autoselect". This should only be overridden when using
    -transceiver connections without link beat e.g. 10base2 or AUI, or (rarely!)
    -for forcing full-duplex when used with old link partners that do not do
    -autonegotiation.
    -</para>
    - </chapter>
    -
    - <chapter id="driver-operation">
    - <title>Driver Operation</title>
    -
    -<sect1><title>Ring buffers</title>
    -
    -<para>
    -The Tulip can use either ring buffers or lists of Tx and Rx descriptors.
    -This driver uses statically allocated rings of Rx and Tx descriptors, set at
    -compile time by RX/TX_RING_SIZE. This version of the driver allocates skbuffs
    -for the Rx ring buffers at open() time and passes the skb->data field to the
    -Tulip as receive data buffers. When an incoming frame is less than
    -RX_COPYBREAK bytes long, a fresh skbuff is allocated and the frame is
    -copied to the new skbuff. When the incoming frame is larger, the skbuff is
    -passed directly up the protocol stack and replaced by a newly allocated
    -skbuff.
    -</para>
    -
    -<para>
    -The RX_COPYBREAK value is chosen to trade-off the memory wasted by
    -using a full-sized skbuff for small frames vs. the copying costs of larger
    -frames. For small frames the copying cost is negligible (esp. considering
    -that we are pre-loading the cache with immediately useful header
    -information). For large frames the copying cost is non-trivial, and the
    -larger copy might flush the cache of useful data. A subtle aspect of this
    -choice is that the Tulip only receives into longword aligned buffers, thus
    -the IP header at offset 14 isn't longword aligned for further processing.
    -Copied frames are put into the new skbuff at an offset of "+2", thus copying
    -has the beneficial effect of aligning the IP header and preloading the
    -cache.
    -</para>
    -
    -</sect1>
    -
    -<sect1><title>Synchronization</title>
    -<para>
    -The driver runs as two independent, single-threaded flows of control. One
    -is the send-packet routine, which enforces single-threaded use by the
    -dev->tbusy flag. The other thread is the interrupt handler, which is single
    -threaded by the hardware and other software.
    -</para>
    -
    -<para>
    -The send packet thread has partial control over the Tx ring and 'dev->tbusy'
    -flag. It sets the tbusy flag whenever it's queuing a Tx packet. If the next
    -queue slot is empty, it clears the tbusy flag when finished otherwise it sets
    -the 'tp->tx_full' flag.
    -</para>
    -
    -<para>
    -The interrupt handler has exclusive control over the Rx ring and records stats
    -from the Tx ring. (The Tx-done interrupt can't be selectively turned off, so
    -we can't avoid the interrupt overhead by having the Tx routine reap the Tx
    -stats.) After reaping the stats, it marks the queue entry as empty by setting
    -the 'base' to zero. Iff the 'tp->tx_full' flag is set, it clears both the
    -tx_full and tbusy flags.
    -</para>
    -
    -</sect1>
    -
    - </chapter>
    -
    - <chapter id="errata">
    - <title>Errata</title>
    -
    -<para>
    -The old DEC databooks were light on details.
    -The 21040 databook claims that CSR13, CSR14, and CSR15 should each be the last
    -register of the set CSR12-15 written. Hmmm, now how is that possible?
    -</para>
    -
    -<para>
    -The DEC SROM format is very badly designed not precisely defined, leading to
    -part of the media selection junkheap below. Some boards do not have EEPROM
    -media tables and need to be patched up. Worse, other boards use the DEC
    -design kit media table when it isn't correct for their board.
    -</para>
    -
    -<para>
    -We cannot use MII interrupts because there is no defined GPIO pin to attach
    -them. The MII transceiver status is polled using an kernel timer.
    -</para>
    - </chapter>
    -
    - <chapter id="changelog">
    - <title>Driver Change History</title>
    -
    - <sect1><title>Version 0.9.14 (February 20, 2001)</title>
    - <itemizedlist>
    - <listitem><para>Fix PNIC problems (Manfred Spraul)</para></listitem>
    - <listitem><para>Add new PCI id for Accton comet</para></listitem>
    - <listitem><para>Support Davicom tulips</para></listitem>
    - <listitem><para>Fix oops in eeprom parsing</para></listitem>
    - <listitem><para>Enable workarounds for early PCI chipsets</para></listitem>
    - <listitem><para>IA64, hppa csr0 support</para></listitem>
    - <listitem><para>Support media types 5, 6</para></listitem>
    - <listitem><para>Interpret a bit more of the 21142 SROM extended media type 3</para></listitem>
    - <listitem><para>Add missing delay in eeprom reading</para></listitem>
    - </itemizedlist>
    - </sect1>
    -
    - <sect1><title>Version 0.9.11 (November 3, 2000)</title>
    - <itemizedlist>
    - <listitem><para>Eliminate extra bus accesses when sharing interrupts (prumpf)</para></listitem>
    - <listitem><para>Barrier following ownership descriptor bit flip (prumpf)</para></listitem>
    - <listitem><para>Endianness fixes for >14 addresses in setup frames (prumpf)</para></listitem>
    - <listitem><para>Report link beat to kernel/userspace via netif_carrier_*. (kuznet)</para></listitem>
    - <listitem><para>Better spinlocking in set_rx_mode.</para></listitem>
    - <listitem><para>Fix I/O resource request failure error messages (DaveM catch)</para></listitem>
    - <listitem><para>Handle DMA allocation failure.</para></listitem>
    - </itemizedlist>
    - </sect1>
    -
    - <sect1><title>Version 0.9.10 (September 6, 2000)</title>
    - <itemizedlist>
    - <listitem><para>Simple interrupt mitigation (via jamal)</para></listitem>
    - <listitem><para>More PCI ids</para></listitem>
    - </itemizedlist>
    - </sect1>
    -
    - <sect1><title>Version 0.9.9 (August 11, 2000)</title>
    - <itemizedlist>
    - <listitem><para>More PCI ids</para></listitem>
    - </itemizedlist>
    - </sect1>
    -
    - <sect1><title>Version 0.9.8 (July 13, 2000)</title>
    - <itemizedlist>
    - <listitem><para>Correct signed/unsigned comparison for dummy frame index</para></listitem>
    - <listitem><para>Remove outdated references to struct enet_statistics</para></listitem>
    - </itemizedlist>
    - </sect1>
    -
    - <sect1><title>Version 0.9.7 (June 17, 2000)</title>
    - <itemizedlist>
    - <listitem><para>Timer cleanups (Andrew Morton)</para></listitem>
    - <listitem><para>Alpha compile fix (somebody?)</para></listitem>
    - </itemizedlist>
    - </sect1>
    -
    - <sect1><title>Version 0.9.6 (May 31, 2000)</title>
    - <itemizedlist>
    - <listitem><para>Revert 21143-related support flag patch</para></listitem>
    - <listitem><para>Add HPPA/media-table debugging printk</para></listitem>
    - </itemizedlist>
    - </sect1>
    -
    - <sect1><title>Version 0.9.5 (May 30, 2000)</title>
    - <itemizedlist>
    - <listitem><para>HPPA support (willy@puffingroup)</para></listitem>
    - <listitem><para>CSR6 bits and tulip.h cleanup (Chris Smith)</para></listitem>
    - <listitem><para>Improve debugging messages a bit</para></listitem>
    - <listitem><para>Add delay after CSR13 write in t21142_start_nway</para></listitem>
    - <listitem><para>Remove unused ETHER_STATS code</para></listitem>
    - <listitem><para>Convert 'extern inline' to 'static inline' in tulip.h (Chris Smith)</para></listitem>
    - <listitem><para>Update DS21143 support flags in tulip_chip_info[]</para></listitem>
    - <listitem><para>Use spin_lock_irq, not _irqsave/restore, in tulip_start_xmit()</para></listitem>
    - <listitem><para>Add locking to set_rx_mode()</para></listitem>
    - <listitem><para>Fix race with chip setting DescOwned bit (Hal Murray)</para></listitem>
    - <listitem><para>Request 100% of PIO and MMIO resource space assigned to card</para></listitem>
    - <listitem><para>Remove error message from pci_enable_device failure</para></listitem>
    - </itemizedlist>
    - </sect1>
    -
    - <sect1><title>Version 0.9.4.3 (April 14, 2000)</title>
    - <itemizedlist>
    - <listitem><para>mod_timer fix (Hal Murray)</para></listitem>
    - <listitem><para>PNIC2 resuscitation (Chris Smith)</para></listitem>
    - </itemizedlist>
    - </sect1>
    -
    - <sect1><title>Version 0.9.4.2 (March 21, 2000)</title>
    - <itemizedlist>
    - <listitem><para>Fix 21041 CSR7, CSR13/14/15 handling</para></listitem>
    - <listitem><para>Merge some PCI ids from tulip 0.91x</para></listitem>
    - <listitem><para>Merge some HAS_xxx flags and flag settings from tulip 0.91x</para></listitem>
    - <listitem><para>asm/io.h fix (submitted by many) and cleanup</para></listitem>
    - <listitem><para>s/HAS_NWAY143/HAS_NWAY/</para></listitem>
    - <listitem><para>Cleanup 21041 mode reporting</para></listitem>
    - <listitem><para>Small code cleanups</para></listitem>
    - </itemizedlist>
    - </sect1>
    -
    - <sect1><title>Version 0.9.4.1 (March 18, 2000)</title>
    - <itemizedlist>
    - <listitem><para>Finish PCI DMA conversion (davem)</para></listitem>
    - <listitem><para>Do not netif_start_queue() at end of tulip_tx_timeout() (kuznet)</para></listitem>
    - <listitem><para>PCI DMA fix (kuznet)</para></listitem>
    - <listitem><para>eeprom.c code cleanup</para></listitem>
    - <listitem><para>Remove Xircom Tulip crud</para></listitem>
    - </itemizedlist>
    - </sect1>
    - </chapter>
    -
    -</book>

    --
    Martin Waitz
    -
    To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
    the body of a message to majordomo@vger.kernel.org
    More majordomo info at  http://vger.kernel.org/majordomo-info.html
    Please read the FAQ at  http://www.tux.org/lkml/
    

  • Next message: Martin Waitz: "[patch 1/6] DocBook: changes and extensions to the kernel documentation"

    Relevant Pages

    • Re: RFC: Capability addition for IEEE 1588
      ... to add interface capability support: ... The driver will then enable/disable the feature. ... the FreeBSD foundation got such a license, ... and my driver is just turning on a hardware ...
      (freebsd-current)
    • Re: RFC: Capability addition for IEEE 1588
      ... to add interface capability support: ... The driver will then enable/disable the feature. ... the FreeBSD foundation got such a license, ... and my driver is just turning on a hardware ...
      (freebsd-net)
    • Re: [RFC v5]update broken web addresses in the kernel.
      ... Based in part on the ITE vendor provided SCSI driver. ... + * Documentation available from IT8212F_V04.pdf ... 460GX support by Chris Ahna ... the GNU General Public License, ...
      (Linux-Kernel)
    • s390 patches for -bk.
      ... The first 7 are bug fixes and small improvements. ... The remaining 5 pathces are new features. ... add module parameter for dcss block driver ... layer 2 support for osa-express cards ...
      (Linux-Kernel)
    • Re: FreeBSD has serious problems with focus, longevity, and lifecycle
      ... Support each release longer, or develop a better way to MFS (Merge ... from Stable) bug fixes, and driver updates to RELEASE. ...
      (freebsd-hackers)