Subversion Repositories versatile_mem_ctrl

/trunk/doc/src/block-sdram-wbwb.png Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream

/trunk/doc/src/block-sdram-wbwb.png

trunk/doc/src/block-sdram-wbwb.png Property changes : Added: svn:mime-type ## -0,0 +1 ## +application/octet-stream \ No newline at end of property Index: trunk/doc/src/block-sdram.png =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Index: trunk/doc/src/block-sdram.png =================================================================== --- trunk/doc/src/block-sdram.png (nonexistent) +++ trunk/doc/src/block-sdram.png (revision 103)

trunk/doc/src/block-sdram.png Property changes : Added: svn:mime-type ## -0,0 +1 ## +application/octet-stream \ No newline at end of property Index: trunk/doc/src/block-sdram-wbwb.odg =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Index: trunk/doc/src/block-sdram-wbwb.odg =================================================================== --- trunk/doc/src/block-sdram-wbwb.odg (nonexistent) +++ trunk/doc/src/block-sdram-wbwb.odg (revision 103)

trunk/doc/src/block-sdram-wbwb.odg Property changes : Added: svn:mime-type ## -0,0 +1 ## +application/octet-stream \ No newline at end of property Index: trunk/doc/src/block-sdram-wbwb-arbiter.png =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Index: trunk/doc/src/block-sdram-wbwb-arbiter.png =================================================================== --- trunk/doc/src/block-sdram-wbwb-arbiter.png (nonexistent) +++ trunk/doc/src/block-sdram-wbwb-arbiter.png (revision 103)

trunk/doc/src/block-sdram-wbwb-arbiter.png Property changes : Added: svn:mime-type ## -0,0 +1 ## +application/octet-stream \ No newline at end of property Index: trunk/doc/src/block-sdram.odg =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Index: trunk/doc/src/block-sdram.odg =================================================================== --- trunk/doc/src/block-sdram.odg (nonexistent) +++ trunk/doc/src/block-sdram.odg (revision 103)

trunk/doc/src/block-sdram.odg Property changes : Added: svn:mime-type ## -0,0 +1 ## +application/octet-stream \ No newline at end of property Index: trunk/doc/src/versatile_mem_ctrl.texi =================================================================== --- trunk/doc/src/versatile_mem_ctrl.texi (nonexistent) +++ trunk/doc/src/versatile_mem_ctrl.texi (revision 103) @@ -0,0 +1,337 @@ +\input texinfo +@c -*-texinfo-*- +@c %**start of header +@setfilename versatile_mem_ctrl +@include version.texi +@settitle Versatile memory controller @value{VERSION} + +@c %**end of header + +@set DESIGN Versatile memory controller +@copying +This file documents the @value{DESIGN}. + +Copyright @copyright{} 2011 ORSoC + +@quotation +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.2 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts, and with no Back-Cover +Texts. A copy of the license is included in the section entitled ``GNU +Free Documentation License''. +@end quotation +@end copying + +@afourpaper + +@titlepage +@title @value{DESIGN} User Guide +@c @subtitle subtitle-if-any +@c @subtitle second-subtitle +@author Michael Unneback +@author ORSoC + +@c The following two commands +@c start the copyright page. +@page +@vskip 0pt plus 1filll +@insertcopying + +Published by ORSoC +@end titlepage + +@c So the toc is printed at the start. +@contents + +@ifnottex +@node Top +@top Scope of this Document + +This document is the user guide for @value{DESIGN}. + +@end ifnottex + +@node Document Introduction +@chapter Introduction + +@cindex Introduction to this @value{DESIGN} + +This design implements a versatile memory controller. If used in combination with the versitale library, available from OpenCores, +different types of system can easily be designed, including use cases where the system bus is in one clock domain and the memory + controller in an other. +@node Block diagram +@chapter Block Diagram +@cindex Block diagram + +@section Clock domains +@value{DESIGN} contains the following clock domains +@itemize +@item Wishbone slave clock domain +@item Wishbone master clock domain +@item RX GMII clock domain +@item TX GMII clock domain +@end itemize + +@node Configuration registers +@chapter Configuration registers + +@section Register memory map +@multitable @columnfractions .2 .1 .1 .1 .5 +@headitem Name @tab Address @tab Width @tab Access @tab Description +@item MODER @tab @value{MODER} @tab 32 @tab RW @tab Mode register +@item INT_SOURCE @tab @value{INT_SOURCE} @tab 32 @tab RW @tab Interrupt source register +@item INT_MASK @tab @value{INT_MASK} @tab 32 @tab RW @tab Interrupt mask register +@item TX_BD_NUM @tab @value{TX_BD_NUM} @tab 32 @tab RW @tab Transmit Buffer Descriptor number +@item MIIMODER @tab @value{MIIMODER} @tab 32 @tab RW @tab MII Mode Register +@item MIICOMMAND @tab @value{MIICOMMAND} @tab 32 @tab RW @tab MII Command Register +@item MIIADDRESS @tab @value{MIIADDRESS} @tab 32 @tab RW @tab MII Address Register +@item MIITX_DATA @tab @value{MIITX_DATA} @tab 32 @tab RW @tab MII Transmit Data +@item MIIRX_DATA @tab @value{MIIRX_DATA} @tab 32 @tab RW @tab MII Receive Data +@item MIISTATUS @tab @value{MIISTATUS} @tab 32 @tab RW @tab MII Status Register +@item MAC_ADDR0 @tab @value{MAC_ADDR0} @tab 32 @tab RW @tab MAC address, LSB four bytes +@item MAC_ADDR1 @tab @value{MAC_ADDR1} @tab 32 @tab RW @tab MAC address, MSB two bytes +@end multitable + +@page + +@subsection MODER +@multitable @columnfractions .1 .1 .2 .6 +@headitem Bit @tab Access @tab Description @tab +@item 31-17 @tab @tab Reserved +@item 16 @tab RW @tab RECSMALL @tab Receive small packets +@item 15 @tab RW @tab PAD @tab Padding enabled +@item 14 @tab RW @tab HUGEN @tab Huge Packets Enable +@item 13 @tab RW @tab CRCEN @tab CRC enable +@item 12-8 @tab @tab Reserved +@item 7 @tab RW @tab LOOPBCK @tab Loopback +@item 6 @tab RW @tab Resrved +@item 5 @tab RW @tab PRO @tab Promiscuous +@item 4 @tab @tab Reserved +@item 3 @tab RW @tab BRO @tab Broadcast Address +@item 2 @tab @tab Reserved +@item 1 @tab RW @tab TXEN @tab Transmit Enable +@item 0 @tab RW @tab RXEN @tab Receive Enable +@end multitable +@example +Reset value: +MODER: 0x0000A000 +@end example + +@page + +@subsection INT_SOURCE +@multitable @columnfractions .1 .1 .2 .6 +@headitem Bit @tab Access @tab Description @tab +@item 31-7 @tab @tab Reserved +@item 4 @tab RW @tab BUSY @tab Busy@* This bit indicates that a buffer was received and discarded due to a lack of buffers. It is cleared by writing 1 to it. This bit appears regardless to the IRQ bits in the Receive or Transmit Buffer Descriptors. +@item 3 @tab RW @tab RXE @tab Receive error@* This bit indicates that an error occurred while receiving data. It is cleared by writing 1 to it. This bit appears only when IRQ bit is set in the Receive Buffer Descriptor. +@item 2 @tab RW @tab RXB @tab Receive buffer@* This bit indicates that a frame was received. It is cleared by writing 1 to it. This bit appears only when IRQ bit is set in the Receive Buffer Descriptor. If a control frame is received, then RXC bit is set instead of the RXB bit. +@item 1 @tab RW @tab TXE @tab Transmit error@* This bit indicates that a buffer was not transmitted due to a transmit error. It is cleared by writing 1 to it. This bit appears only when IRQ bit is set in the Receive Buffer Descriptor. This bit appears only when IRQ bit is set in the Transmit Buffer Descriptor. +@item 0 @tab RW @tab TXB @tab Transmit buffer@* This bit indicates that a buffer has been transmitted. It is cleared by writing 1 to it. This bit appears only when IRQ bit is set in the Transmit Buffer Descriptor. +@end multitable +@example +Reset value: +INT_SOURCE: 0x00000000 +@end example + +@page +@subsection INT_MASK +@multitable @columnfractions .1 .1 .2 .6 +@headitem Bit @tab Access @tab Description @tab +@item 31-7 @tab @tab Reserved +@item 4 @tab RW @tab BUSY_M @tab Busy mask@* +@item 3 @tab RW @tab RXE_M @tab Receive error@* Receive error mask +@item 2 @tab RW @tab RXB_M @tab Receive buffer@* Receive buffer mask +@item 1 @tab RW @tab TXE_M @tab Transmit error@* Transmit error mask +@item 0 @tab RW @tab TXB_M @tab Transmit buffer@* Transmit buffer mask +@end multitable +@example +Reset value: +INT_MASK: 0x00000000 +@*@* +0 -> event masked +1 -> event causes an interrupt +@end example + +@page +@subsection TX_BD_NUM +@multitable @columnfractions .1 .1 .2 .6 +@headitem Bit @tab Access @tab Description @tab +@item 31-8 @tab @tab Reserved +@item 7-0 @tab RW @tab TX_BD_NUM @tab Transmit Buffer Descriptor Number@* Number of the Tx BD. Number of the Rx BD equals to the (0x80 – Tx BD number). Maximum number of the Tx BD is 0x80. Values greater then 0x80 cannot be written to this register (ignored). +@end multitable +@example +Reset value: +TX_BD_NUM: 0x00000040 +@end example + +@page +@subsection MIIMODER +@multitable @columnfractions .1 .1 .2 .6 +@headitem Bit @tab Access @tab Description @tab +@item 31-9 @tab @tab Reserved +@item 8 @tab RW @tab MIINOPRE @tab No Preamble@* 0 = 32 bit preamble sent@* 1 = No preamble sent +@item 7-0 @tab RW @tab CLKDIV @tab Clock divider The field is a host clock divider factor. The host clock can be divided by an even number, greater then 1. The default value is 0x64 (100). +@end multitable +@example +Reset value: +MIIMODER: 0x00000064 +@end example + +@subsection MIICOMMAND +@multitable @columnfractions .1 .1 .2 .6 +@headitem Bit @tab Access @tab Description @tab +@item 31-3 @tab @tab Reserved +@item 2 @tab RW @tab WCTRLDATA @tab Write control data +@item 1 @tab RW @tab RSTAT @tab Read status +@item 0 @tab RW @tab SCANSTAT @tab Scan status +@end multitable +@example +Reset value: +MIICOMMAND: 0x00000000 +@end example + +@subsection MIIADDRESS +@multitable @columnfractions .1 .1 .2 .6 +@headitem Bit @tab Access @tab Description @tab +@item 31-13 @tab @tab Reserved +@item 12-8 @tab RW @tab RGAD @tab Register address +@item 7-5 @tab RW @tab Reserved @tab +@item 4-0 @tab RW @tab FIAD @tab PHY address +@end multitable +@example +Reset value: +MIIADDRESS: 0x00000000 +@end example + +@subsection MIITX_DATA +@multitable @columnfractions .1 .1 .2 .6 +@headitem Bit @tab Access @tab Description @tab +@item 31-16 @tab @tab Reserved +@item 15-0 @tab RW @tab CTRLDATA @tab Data to be written to the PHY +@end multitable +@example +Reset value: +MIITX_DATA: 0x00000000 +@end example + +@subsection MIIRX_DATA +@multitable @columnfractions .1 .1 .2 .6 +@headitem Bit @tab Access @tab Description @tab +@item 31-16 @tab @tab Reserved +@item 15-0 @tab R @tab PRSD @tab Data read from the PHY +@end multitable +@example +Reset value: +MIIRX_DATA: 0x00000000 +@end example + +@subsection MIISTATUS +@multitable @columnfractions .1 .1 .2 .6 +@headitem Bit @tab Access @tab Description @tab +@item 31-3 @tab @tab Reserved +@item 2 @tab R @tab NVALID @tab Invalid@* 0 = The data in the MSTATUS register is valid.@* 1 = The data in the MSTATUS register is invalid.@* This bit is only valid when the scan status operation is active. +@item 1 @tab R @tab BUSY @tab 0 = The MII is ready.@* 1 = The MII is busy (operation in progress). +@item 0 @tab R @tab LINKFAIL @tab 0 = The link is OK.@*1 = The link failed.@*The Link fail condition occurred (now the link might be OK). Another status read gets a new status. +@end multitable +@example +Reset value: +MIISTATUS: 0x00000000 +@end example + +@page +@subsection MAC_ADDR0 +@multitable @columnfractions .1 .1 .8 +@headitem Bit @tab Access @tab Description @tab +@item 31-24 @tab RW @tab Byte 2 of the Ethernet MAC address +@item 23-16 @tab RW @tab Byte 3 of the Ethernet MAC address +@item 15-8 @tab RW @tab Byte 4 of the Ethernet MAC address +@item 7-0 @tab RW @tab Byte 5 of the Ethernet MAC address +@end multitable +@example +Reset value: +MAC_ADDR0: 0x00000000 +@end example + +@subsection MAC_ADDR1 +@multitable @columnfractions .1 .1 .8 +@headitem Bit @tab Access @tab Description @tab +@item 31-16 @tab @tab Reserved +@item 15-8 @tab RW @tab Byte 0 of the Ethernet MAC address +@item 7-0 @tab RW @tab Byte 1 of the Ethernet MAC address +@end multitable +@example +Reset value: +MAC_ADDR1: 0x00000000 +@end example + +@node MDIO +@chapter Management Data Input/Output + +The MDIO interface is implemented by two lines: +@itemize +@item a MDC clock line +@item an MDIO data line +@end itemize + +The clock line is driven by the MAC device. The data line is bidirectional: the PHY drives it to provide register data at the end of a read operation. +@*@* +The bus has a single MAC master, but can have up to 32 PHY slaves. +@*@* +The MDC clock can be aperiodic, with a minimum period of 400 ns, which corresponds to a maximal frequency of 2.5 MHz. Newer chips, however, allow faster acesses. +@*@* +The MDIO data line has a pull-up of 1.5 kOhm in the PHY, allowing the MAC to determine if one or more PHYs are attached. The MAC should have a 2 kOhm pull-down on that same line. + +@section Bus timing +@subsection Read operation +A read operation has the following phases +@itemize +@item Preamble with 32 ones +@item Start sequence, 01 +@item Opcode read, 10 +@item PHY adress +@item REG adress +@item Bus turnaround +@item Register data +@end itemize +@image{MDIO_rd,15cm,2.54cm} + +@subsection Write operation +A write operation has the following phases +@itemize +@item Preamble with 32 ones +@item Start sequence, 01 +@item Opcode read, 01 +@item PHY adress +@item REG adress +@item Bus turnaround +@item Register data +@end itemize +@image{MDIO_wr,15cm,2.54cm} + +@node Ingress and Egress FIFO +@chapter Ingress and Egress FIFO + +@section FIFO implementation +Both ingress and egress FIFO implementation uses a generic asynchronous FIFO design +available from OpenCores.@*@* +@uref{http://opencores.org/project,versatile_library} + +@c **************************************************************************** +@c End bits +@c **************************************************************************** + +@node GNU Free Documentation License +@chapter GNU Free Documentation License +@cindex license for @value{DESIGN} + +@include fdl.texi + +@node Index + +@unnumbered Index + +@printindex cp + +@bye Index: trunk/doc/src/block-sdram-wbwb-arbiter.odg =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Index: trunk/doc/src/block-sdram-wbwb-arbiter.odg =================================================================== --- trunk/doc/src/block-sdram-wbwb-arbiter.odg (nonexistent) +++ trunk/doc/src/block-sdram-wbwb-arbiter.odg (revision 103)

trunk/doc/src/block-sdram-wbwb-arbiter.odg Property changes : Added: svn:mime-type ## -0,0 +1 ## +application/octet-stream \ No newline at end of property Index: trunk/doc/src/Makefile =================================================================== --- trunk/doc/src/Makefile (nonexistent) +++ trunk/doc/src/Makefile (revision 103) @@ -0,0 +1,8 @@ +MDIO-timing: + drawtiming --output MDIO_rd.png MDIO_rd.dt + drawtiming --output MDIO_wr.png MDIO_wr.dt + +texinfo: + texi2pdf versatile_mem_ctrl.texi + +all: texinfo Index: trunk/doc/src/fdl.texi =================================================================== --- trunk/doc/src/fdl.texi (nonexistent) +++ trunk/doc/src/fdl.texi (revision 103) @@ -0,0 +1,451 @@ +@c The GNU Free Documentation License. +@center Version 1.2, November 2002 + +@c This file is intended to be included within another document, +@c hence no sectioning command or @node. + +@display +Copyright @copyright{} 2000,2001,2002 Free Software Foundation, Inc. +51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +@end display + +@enumerate 0 +@item +PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +functional and useful document @dfn{free} in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. + +This License is a kind of ``copyleft'', which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + +@item +APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The ``Document'', below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as ``you''. You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. + +A ``Modified Version'' of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A ``Secondary Section'' is a named appendix or a front-matter section +of the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The ``Invariant Sections'' are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. + +The ``Cover Texts'' are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. + +A ``Transparent'' copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not ``Transparent'' is called ``Opaque''. + +Examples of suitable formats for Transparent copies include plain +@sc{ascii} without markup, Texinfo input format, La@TeX{} input +format, @acronym{SGML} or @acronym{XML} using a publicly available +@acronym{DTD}, and standard-conforming simple @acronym{HTML}, +PostScript or @acronym{PDF} designed for human modification. Examples +of transparent image formats include @acronym{PNG}, @acronym{XCF} and +@acronym{JPG}. Opaque formats include proprietary formats that can be +read and edited only by proprietary word processors, @acronym{SGML} or +@acronym{XML} for which the @acronym{DTD} and/or processing tools are +not generally available, and the machine-generated @acronym{HTML}, +PostScript or @acronym{PDF} produced by some word processors for +output purposes only. + +The ``Title Page'' means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, ``Title Page'' means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +A section ``Entitled XYZ'' means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as ``Acknowledgements'', +``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' +of such a section when you modify the Document means that it remains a +section ``Entitled XYZ'' according to this definition. + +The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. + +@item +VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + +@item +COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document's license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. + +@item +MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +@enumerate A +@item +Use in the Title Page (and on the covers, if any) a title distinct +from that of the Document, and from those of previous versions +(which should, if there were any, be listed in the History section +of the Document). You may use the same title as a previous version +if the original publisher of that version gives permission. + +@item +List on the Title Page, as authors, one or more persons or entities +responsible for authorship of the modifications in the Modified +Version, together with at least five of the principal authors of the +Document (all of its principal authors, if it has fewer than five), +unless they release you from this requirement. + +@item +State on the Title page the name of the publisher of the +Modified Version, as the publisher. + +@item +Preserve all the copyright notices of the Document. + +@item +Add an appropriate copyright notice for your modifications +adjacent to the other copyright notices. + +@item +Include, immediately after the copyright notices, a license notice +giving the public permission to use the Modified Version under the +terms of this License, in the form shown in the Addendum below. + +@item +Preserve in that license notice the full lists of Invariant Sections +and required Cover Texts given in the Document's license notice. + +@item +Include an unaltered copy of this License. + +@item +Preserve the section Entitled ``History'', Preserve its Title, and add +to it an item stating at least the title, year, new authors, and +publisher of the Modified Version as given on the Title Page. If +there is no section Entitled ``History'' in the Document, create one +stating the title, year, authors, and publisher of the Document as +given on its Title Page, then add an item describing the Modified +Version as stated in the previous sentence. + +@item +Preserve the network location, if any, given in the Document for +public access to a Transparent copy of the Document, and likewise +the network locations given in the Document for previous versions +it was based on. These may be placed in the ``History'' section. +You may omit a network location for a work that was published at +least four years before the Document itself, or if the original +publisher of the version it refers to gives permission. + +@item +For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve +the Title of the section, and preserve in the section all the +substance and tone of each of the contributor acknowledgements and/or +dedications given therein. + +@item +Preserve all the Invariant Sections of the Document, +unaltered in their text and in their titles. Section numbers +or the equivalent are not considered part of the section titles. + +@item +Delete any section Entitled ``Endorsements''. Such a section +may not be included in the Modified Version. + +@item +Do not retitle any existing section to be Entitled ``Endorsements'' or +to conflict in title with any Invariant Section. + +@item +Preserve any Warranty Disclaimers. +@end enumerate + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section Entitled ``Endorsements'', provided it contains +nothing but endorsements of your Modified Version by various +parties---for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + +@item +COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections Entitled ``History'' +in the various original documents, forming one section Entitled +``History''; likewise combine any sections Entitled ``Acknowledgements'', +and any sections Entitled ``Dedications''. You must delete all +sections Entitled ``Endorsements.'' + +@item +COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. + +You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. + +@item +AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an ``aggregate'' if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. + +@item +TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. + +If a section in the Document is Entitled ``Acknowledgements'', +``Dedications'', or ``History'', the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. + +@item +TERMINATION + +You may not copy, modify, sublicense, or distribute the Document except +as expressly provided for under this License. Any other attempt to +copy, modify, sublicense or distribute the Document is void, and will +automatically terminate your rights under this License. However, +parties who have received copies, or rights, from you under this +License will not have their licenses terminated so long as such +parties remain in full compliance. + +@item +FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +@uref{http://www.gnu.org/copyleft/}. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License ``or any later version'' applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. +@end enumerate + +@page +@heading ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + +@smallexample +@group + Copyright (C) @var{year} @var{your name}. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.2 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. A copy of the license is included in the section entitled ``GNU + Free Documentation License''. +@end group +@end smallexample + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the ``with@dots{}Texts.'' line with this: + +@smallexample +@group + with the Invariant Sections being @var{list their titles}, with + the Front-Cover Texts being @var{list}, and with the Back-Cover Texts + being @var{list}. +@end group +@end smallexample + +If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. + +@c Local Variables: +@c ispell-local-pdict: "ispell-dict" +@c End: + Index: trunk/doc/src/version.texi =================================================================== --- trunk/doc/src/version.texi (nonexistent) +++ trunk/doc/src/version.texi (revision 103) @@ -0,0 +1,4 @@ +@set UPDATED 27 December 2010 +@set UPDATED-MONTH December 2010 +@set EDITION 1 +@set VERSION 1.0