URL
https://opencores.org/ocsvn/openarty/openarty/trunk
Subversion Repositories openarty
Compare Revisions
- This comparison shows the changes necessary to convert path
/openarty
- from Rev 1 to Rev 2
- ↔ Reverse comparison
Rev 1 → Rev 2
/trunk/doc/spec.pdf
Cannot display: file marked as a binary type.
svn:mime-type = application/octet-stream
trunk/doc/spec.pdf
Property changes :
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Index: trunk/doc/src/gpl-3.0.tex
===================================================================
--- trunk/doc/src/gpl-3.0.tex (nonexistent)
+++ trunk/doc/src/gpl-3.0.tex (revision 2)
@@ -0,0 +1,719 @@
+\documentclass[11pt]{article}
+
+\title{GNU GENERAL PUBLIC LICENSE}
+\date{Version 3, 29 June 2007}
+
+\begin{document}
+\maketitle
+
+\begin{center}
+{\parindent 0in
+
+Copyright \copyright\ 2007 Free Software Foundation, Inc. \texttt{http://fsf.org/}
+
+\bigskip
+Everyone is permitted to copy and distribute verbatim copies of this
+
+license document, but changing it is not allowed.}
+
+\end{center}
+
+\renewcommand{\abstractname}{Preamble}
+\begin{abstract}
+The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+\end{abstract}
+
+\begin{center}
+{\Large \sc Terms and Conditions}
+\end{center}
+
+
+\begin{enumerate}
+
+\addtocounter{enumi}{-1}
+
+\item Definitions.
+
+``This License'' refers to version 3 of the GNU General Public License.
+
+``Copyright'' also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+``The Program'' refers to any copyrightable work licensed under this
+License. Each licensee is addressed as ``you''. ``Licensees'' and
+``recipients'' may be individuals or organizations.
+
+To ``modify'' a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a ``modified version'' of the
+earlier work or a work ``based on'' the earlier work.
+
+A ``covered work'' means either the unmodified Program or a work based
+on the Program.
+
+To ``propagate'' a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+To ``convey'' a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+An interactive user interface displays ``Appropriate Legal Notices''
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+\item Source Code.
+
+The ``source code'' for a work means the preferred form of the work
+for making modifications to it. ``Object code'' means any non-source
+form of a work.
+
+A ``Standard Interface'' means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+The ``System Libraries'' of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+``Major Component'', in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+The ``Corresponding Source'' for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+The Corresponding Source for a work in source code form is that
+same work.
+
+\item Basic Permissions.
+
+All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+\item Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+\item Conveying Verbatim Copies.
+
+You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+\item Conveying Modified Source Versions.
+
+You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+ \begin{enumerate}
+ \item The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ \item The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ ``keep intact all notices''.
+
+ \item You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ \item If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+\end{enumerate}
+A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+``aggregate'' if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+\item Conveying Non-Source Forms.
+
+You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+ \begin{enumerate}
+ \item Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ \item Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ \item Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ \item Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ \item Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+ \end{enumerate}
+
+A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+A ``User Product'' is either (1) a ``consumer product'', which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, ``normally used'' refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+``Installation Information'' for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+\item Additional Terms.
+
+``Additional permissions'' are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+ \begin{enumerate}
+ \item Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ \item Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ \item Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ \item Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ \item Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ \item Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+ \end{enumerate}
+
+All other non-permissive additional terms are considered ``further
+restrictions'' within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+\item Termination.
+
+You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+\item Acceptance Not Required for Having Copies.
+
+You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+\item Automatic Licensing of Downstream Recipients.
+
+Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+An ``entity transaction'' is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+\item Patents.
+
+A ``contributor'' is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's ``contributor version''.
+
+A contributor's ``essential patent claims'' are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, ``control'' includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+In the following three paragraphs, a ``patent license'' is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To ``grant'' such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. ``Knowingly relying'' means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+A patent license is ``discriminatory'' if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+\item No Surrender of Others' Freedom.
+
+If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+\item Use with the GNU Affero General Public License.
+
+Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+\item Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public 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.
+
+Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License ``or any later version'' applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+\item Disclaimer of Warranty.
+
+\begin{sloppypar}
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+ APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
+ COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM ``AS IS''
+ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
+ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE
+ RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
+ SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
+ NECESSARY SERVICING, REPAIR OR CORRECTION.
+\end{sloppypar}
+
+\item Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES
+ AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR
+ DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL
+ DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM
+ (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
+ INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE
+ OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH
+ HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+ DAMAGES.
+
+\item Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+\begin{center}
+{\Large\sc End of Terms and Conditions}
+
+\bigskip
+How to Apply These Terms to Your New Programs
+\end{center}
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the ``copyright'' line and a pointer to where the full notice is found.
+
+{\footnotesize
+\begin{verbatim}
+
+
+Copyright (C)
+
+This program 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 3 of the License, or
+(at your option) any later version.
+
+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.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see .
+\end{verbatim}
+}
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+{\footnotesize
+\begin{verbatim}
+ Copyright (C)
+
+This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+This is free software, and you are welcome to redistribute it
+under certain conditions; type `show c' for details.
+\end{verbatim}
+}
+
+The hypothetical commands {\tt show w} and {\tt show c} should show
+the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an ``about box''.
+
+You should also get your employer (if you work as a programmer) or
+school, if any, to sign a ``copyright disclaimer'' for the program, if
+necessary. For more information on this, and how to apply and follow
+the GNU GPL, see \texttt{http://www.gnu.org/licenses/}.
+
+The GNU General Public License does not permit incorporating your
+program into proprietary programs. If your program is a subroutine
+library, you may consider it more useful to permit linking proprietary
+applications with the library. If this is what you want to do, use
+the GNU Lesser General Public License instead of this License. But
+first, please read \texttt{http://www.gnu.org/philosophy/why-not-lgpl.html}.
+
+\end{enumerate}
+
+\end{document}
Index: trunk/doc/src/GT.eps
===================================================================
--- trunk/doc/src/GT.eps (nonexistent)
+++ trunk/doc/src/GT.eps (revision 2)
@@ -0,0 +1,94 @@
+%!PS-Adobe-3.0 EPSF-3.0
+%%BoundingBox: 0 0 504 288
+%%Creator: Gisselquist Technology LLC
+%%Title: Gisselquist Technology Logo
+%%CreationDate: 11 Mar 2014
+%%EndComments
+%%BeginProlog
+/black { 0 setgray } def
+/white { 1 setgray } def
+/height { 288 } def
+/lw { height 8 div } def
+%%EndProlog
+% %%Page: 1
+
+false { % A bounding box
+ 0 setlinewidth
+ newpath
+ 0 0 moveto
+ 0 height lineto
+ 1.625 height mul lw add 0 rlineto
+ 0 height neg rlineto
+ closepath stroke
+} if
+
+true { % The "G"
+ newpath
+ height 2 div 1.25 mul height moveto
+ height 2 div height 4 div sub height lineto
+ 0 height 3 4 div mul lineto
+ 0 height 4 div lineto
+ height 4 div 0 lineto
+ height 3 4 div mul 0 lineto
+ height height 4 div lineto
+ height height 2 div lineto
+ %
+ height lw sub height 2 div lineto
+ height lw sub height 4 div lw 2 div add lineto
+ height 3 4 div mul lw 2 div sub lw lineto
+ height 4 div lw 2 div add lw lineto
+ lw height 4 div lw 2 div add lineto
+ lw height 3 4 div mul lw 2 div sub lineto
+ height 4 div lw 2 div add height lw sub lineto
+ height 2 div 1.25 mul height lw sub lineto
+ closepath fill
+ newpath
+ height 2 div height 2 div moveto
+ height 2 div 0 rlineto
+ 0 height 2 div neg rlineto
+ lw neg 0 rlineto
+ 0 height 2 div lw sub rlineto
+ height 2 div height 2 div lw sub lineto
+ closepath fill
+} if
+
+height 2 div 1.25 mul lw add 0 translate
+false {
+ newpath
+ 0 height moveto
+ height 0 rlineto
+ 0 lw neg rlineto
+ height lw sub 2 div neg 0 rlineto
+ 0 height lw sub neg rlineto
+ lw neg 0 rlineto
+ 0 height lw sub rlineto
+ height lw sub 2 div neg 0 rlineto
+ 0 lw rlineto
+ closepath fill
+} if
+
+true { % The "T" of "GT".
+ newpath
+ 0 height moveto
+ height lw add 2 div 0 rlineto
+ 0 height neg rlineto
+ lw neg 0 rlineto
+ 0 height lw sub rlineto
+ height lw sub 2 div neg 0 rlineto
+ closepath fill
+
+ % The right half of the top of the "T"
+ newpath
+ % (height + lw)/2 + lw
+ height lw add 2 div lw add height moveto
+ % height - (above) = height - height/2 - 3/2 lw = height/2-3/2lw
+ height 3 lw mul sub 2 div 0 rlineto
+ 0 lw neg rlineto
+ height 3 lw mul sub 2 div neg 0 rlineto
+ closepath fill
+} if
+
+
+grestore
+showpage
+%%EOF
Index: trunk/doc/src/gqtekspec.cls
===================================================================
--- trunk/doc/src/gqtekspec.cls (nonexistent)
+++ trunk/doc/src/gqtekspec.cls (revision 2)
@@ -0,0 +1,298 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%/
+%
+% Copyright (C) 2015, Gisselquist Technology, LLC
+%
+% This template 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 3 of the License, or (at your
+% option) any later version.
+%
+% This template is distributed in the hope that it will be useful, but WITHOUT
+% ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or
+% FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+% for more details.
+%
+% You should have received a copy of the GNU General Public License along
+% with this program. If not, see for a copy.
+%
+% License: GPL, v3, as defined and found on www.gnu.org,
+% http://www.gnu.org/licenses/gpl.html
+%
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% \NeedsTeXFormat{LaTeX2e}[1995/12/01]
+\ProvidesClass{gqtekspec}[2015/03/03 v0.1 -- Gisselquist Technology Specification]
+\typeout{by Dan Gisselquist}
+\LoadClassWithOptions{report}
+\usepackage{datetime}
+\usepackage{graphicx}
+\usepackage[dvips]{pstricks}
+\usepackage{hhline}
+\usepackage{colortbl}
+\definecolor{webgreen}{rgb}{0,0.5,0}
+\usepackage[dvips,colorlinks=true,linkcolor=webgreen]{hyperref}
+\newdateformat{headerdate}{\THEYEAR/\twodigit{\THEMONTH}/\twodigit{\THEDAY}}
+\setlength{\hoffset}{0.25in}
+\setlength{\voffset}{-0.5in}
+\setlength{\marginparwidth}{0in}
+\setlength{\marginparsep}{0in}
+\setlength{\textwidth}{6in}
+\setlength{\oddsidemargin}{0in}
+
+% **************************************
+% * APPENDIX *
+% **************************************
+%
+\newcommand\appfl@g{\appendixname} %used to test \@chapapp
+%
+% \renewcommand\appendix{\par\clearpage
+ % \setcounter{chapter}{0}%
+ % \setcounter{section}{0}%
+ % \renewcommand\@chapapp{\appendixname}%
+ % \renewcommand\thechapter{\Alph{chapter}}
+ % \if@nosectnum\else
+ % \renewcommand\thesection{\Alph{chapter}.\arabic{section}}
+ % \fi
+% }
+
+
+% FIGURE
+% redefine the @caption command to put a period after the figure or
+% table number in the lof and lot tables
+\long\def\@caption#1[#2]#3{\par\addcontentsline{\csname
+ ext@#1\endcsname}{#1}{\protect\numberline{\csname
+ the#1\endcsname.}{\ignorespaces #2}}\begingroup
+ \@parboxrestore
+ \normalsize
+ \@makecaption{\csname fnum@#1\endcsname}{\ignorespaces #3}\par
+ \endgroup}
+
+% ****************************************
+% * TABLE OF CONTENTS, ETC. *
+% ****************************************
+
+\renewcommand\contentsname{Contents}
+\renewcommand\listfigurename{Figures}
+\renewcommand\listtablename{Tables}
+
+\newif\if@toc \@tocfalse
+\renewcommand\tableofcontents{%
+ \begingroup% temporarily set if@toc so that \@schapter will not
+ % put Table of Contents in the table of contents.
+ \@toctrue
+ \chapter*{\contentsname}
+ \endgroup
+ \thispagestyle{gqtekspecplain}
+
+ \baselineskip=10pt plus .5pt minus .5pt
+
+ {\raggedleft Page \par\vskip-\parskip}
+ \@starttoc{toc}%
+ \baselineskip=\normalbaselineskip
+ }
+
+\def\l@appendix{\pagebreak[3]
+ \vskip 1.0em plus 1pt % space above appendix line
+ \@dottedtocline{0}{0em}{8em}}
+
+\def\l@chapter{\pagebreak[3]
+ \vskip 1.0em plus 1pt % space above appendix line
+ \@dottedtocline{0}{0em}{4em}}
+
+% \if@nosectnum\else
+ % \renewcommand\l@section{\@dottedtocline{1}{5.5em}{2.4em}}
+ % \renewcommand\l@subsection{\@dottedtocline{2}{8.5em}{3.2em}}
+ % \renewcommand\l@subsubsection{\@dottedtocline{3}{11em}{4.1em}}
+ % \renewcommand\l@paragraph{\@dottedtocline{4}{13.5em}{5em}}
+ % \renewcommand\l@subparagraph{\@dottedtocline{5}{16em}{6em}}
+% \fi
+
+% LIST OF FIGURES
+%
+\def\listoffigures{%
+ \begingroup
+ \chapter*{\listfigurename}%
+ \endgroup
+ \thispagestyle{gqtekspecplain}%
+
+ \baselineskip=10pt plus .5pt minus .5pt%
+
+ {\hbox to \hsize{Figure\hfil Page} \par\vskip-\parskip}%
+
+ \rule[2mm]{\textwidth}{0.5mm}\par
+
+ \@starttoc{lof}%
+ \baselineskip=\normalbaselineskip}%
+
+\def\l@figure{\@dottedtocline{1}{1em}{4.0em}}
+
+% LIST OF TABLES
+%
+\def\listoftables{%
+ \begingroup
+ \chapter*{\listtablename}%
+ \endgroup
+ \thispagestyle{gqtekspecplain}%
+ \baselineskip=10pt plus .5pt minus .5pt%
+ {\hbox to \hsize{Table\hfil Page} \par\vskip-\parskip}%
+
+ % Added line underneath headings, 20 Jun 01, Capt Todd Hale.
+ \rule[2mm]{\textwidth}{0.5mm}\par
+
+ \@starttoc{lot}%
+ \baselineskip=\normalbaselineskip}%
+
+\let\l@table\l@figure
+
+% ****************************************
+% * PAGE STYLES *
+% ****************************************
+%
+\def\ps@gqtekspectoc{%
+ \let\@mkboth\@gobbletwo
+ \def \@oddhead{}
+ \def \@oddfoot{\rm
+ \hfil\raisebox{-9pt}{\thepage}\hfil\thispagestyle{gqtekspectocn}}
+ \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
+\def\ps@gqtekspectocn{\let\@mkboth\@gobbletwo
+ \def \@oddhead{\rm \hfil\raisebox{10pt}{Page}}
+ \def \@oddfoot{\rm
+ \hfil\raisebox{-9pt}{\thepage}\hfil\thispagestyle{gqtekspectocn}}
+ \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
+
+\def\ps@gqtekspeclof{\let\@mkboth\@gobbletwo
+ \def \@oddhead{}
+ \def \@oddfoot{\rm
+ \hfil\raisebox{-9pt}{\thepage}\hfil\thispagestyle{gqtekspeclofn}}
+ \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
+\def\ps@gqtekspeclofn{\let\@mkboth\@gobbletwo
+ \def \@oddhead{\rm
+ \parbox{\textwidth}{\raisebox{0pt}{Figure}\hfil\raisebox{0pt}{Page} %
+ \raisebox{20pt}{\rule[10pt]{\textwidth}{0.5mm}} }}
+
+ \def \@oddfoot{\rm
+ \hfil\raisebox{-9pt}{\thepage}\hfil\thispagestyle{gqtekspeclofn}}
+ \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
+
+\def\ps@gqtekspeclot{\let\@mkboth\@gobbletwo
+ \def \@oddhead{}
+ \def \@oddfoot{\rm
+ \hfil\raisebox{-9pt}{\thepage}\hfil\thispagestyle{gqtekspeclotn}}
+ \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
+\def\ps@gqtekspeclotn{\let\@mkboth\@gobbletwo
+ \def \@oddhead{\rm
+ \parbox{\textwidth}{\raisebox{0pt}{Table}\hfil\raisebox{0pt}{Page} %
+ \raisebox{20pt}{\rule[10pt]{\textwidth}{0.5mm}} }}
+
+ \def \@oddfoot{\rm
+ \hfil\raisebox{-9pt}{\thepage}\hfil\thispagestyle{gqtekspeclotn}}
+ \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
+
+\def\ps@gqtekspecplain{\let\@mkboth\@gobbletwo
+ \def \@oddhead{\rput(0,-2pt){\psline(0,0)(\textwidth,0)}\rm \hbox to 1in{\includegraphics[height=0.8\headheight]{GT.eps} Gisselquist Technology, LLC}\hfil\hbox{\@title}\hfil\hbox to 1in{\hfil\headerdate\@date}}
+ \def \@oddfoot{\rput(0,9pt){\psline(0,0)(\textwidth,0)}\rm \hbox to 1in{www.opencores.com\hfil}\hfil\hbox{\r@vision}\hfil\hbox to 1in{\hfil{\thepage}}}
+ \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
+
+% \def\author#1{\def\auth@r{#1}}
+% \def\title#1{\def\ti@tle{#1}}
+
+\def\logo{\begin{pspicture}(0,0)(5.67in,0.75in)
+ \rput[lb](0.05in,0.10in){\includegraphics[height=0.75in]{GT.eps}}
+ \rput[lb](1.15in,0.05in){\scalebox{1.8}{\parbox{2.0in}{Gisselquist\\Technology, LLC}}}
+ \end{pspicture}}
+% TITLEPAGE
+%
+\def\titlepage{\setcounter{page}{1}
+ \typeout{^^JTitle Page.}
+ \thispagestyle{empty}
+ \leftline{\rput(0,0){\psline(0,0)(\textwidth,0)}\hfill}
+ \vskip 2\baselineskip
+ \logo\hfil % Original is 3.91 in x 1.26 in, let's match V thus
+ \vskip 2\baselineskip
+ \vspace*{10pt}\vfil
+ \begin{minipage}{\textwidth}\raggedleft
+ \ifproject{\Huge\bfseries\MakeUppercase\@project} \\\fi
+ \vspace*{15pt}
+ {\Huge\bfseries\MakeUppercase\@title} \\
+ \vskip 10\baselineskip
+ \Large \@author \\
+ \ifemail{\Large \@email}\\\fi
+ \vskip 6\baselineskip
+ \Large \usdate\@date \\
+ \end{minipage}
+ % \baselineskip 22.5pt\large\rm\MakeUppercase\ti@tle
+ \vspace*{30pt}
+ \vfil
+ \newpage\baselineskip=\normalbaselineskip}
+
+\newenvironment{license}{\clearpage\typeout{^^JLicense Page.}\ \vfill\noindent}%
+ {\vfill\newpage}
+% ****************************************
+% * CHAPTER DEFINITIONS *
+% ****************************************
+%
+\renewcommand\chapter{\if@openright\cleardoublepage\else\clearpage\fi
+ \thispagestyle{gqtekspecplain}%
+ \global\@topnum\z@
+ \@afterindentfalse
+ \secdef\@chapter\@schapter}
+\renewcommand\@makechapterhead[1]{%
+ \hbox to \textwidth{\hfil{\Huge\bfseries \thechapter.}}\vskip 10\p@
+ \hbox to \textwidth{\rput(0,0){\psline[linewidth=0.04in](0,0)(\textwidth,0)}}\vskip \p@
+ \hbox to \textwidth{\rput(0,0){\psline[linewidth=0.04in](0,0)(\textwidth,0)}}\vskip 10\p@
+ \hbox to \textwidth{\hfill{\Huge\bfseries #1}}%
+ \par\nobreak\vskip 40\p@}
+\renewcommand\@makeschapterhead[1]{%
+ \hbox to \textwidth{\hfill{\Huge\bfseries #1}}%
+ \par\nobreak\vskip 40\p@}
+% ****************************************
+% * INITIALIZATION *
+% ****************************************
+%
+% Default initializations
+
+\ps@gqtekspecplain % 'gqtekspecplain' page style with lowered page nos.
+\onecolumn % Single-column.
+\pagenumbering{roman} % the first chapter will change pagenumbering
+ % to arabic
+\setcounter{page}{1} % in case a titlepage is not requested
+ % otherwise titlepage sets page to 1 since the
+ % flyleaf is not counted as a page
+\widowpenalty 10000 % completely discourage widow lines
+\clubpenalty 10000 % completely discourage club (orphan) lines
+\raggedbottom % don't force alignment of bottom of pages
+
+\date{\today}
+\newif\ifproject\projectfalse
+\def\project#1{\projecttrue\gdef\@project{#1}}
+\def\@project{}
+\newif\ifemail\emailfalse
+\def\email#1{\emailtrue\gdef\@email{#1}}
+\def\@email{}
+\def\revision#1{\gdef\r@vision{#1}}
+\def\r@vision{}
+\def\at{\makeatletter @\makeatother}
+\newdateformat{theyear}{\THEYEAR}
+\newenvironment{revisionhistory}{\clearpage\typeout{^^JRevision History.}%
+ \hbox to \textwidth{\hfil\scalebox{1.8}{\large\bfseries Revision History}}\vskip 10\p@\noindent%
+ \begin{tabular}{|p{0.5in}|p{1in}|p{1in}|p{2.875in}|}\hline
+ \rowcolor[gray]{0.8} Rev. & Date & Author & Description\\\hline\hline}
+ {\end{tabular}\clearpage}
+\newenvironment{clocklist}{\begin{tabular}{|p{0.75in}|p{0.5in}|l|l|p{2.875in}|}\hline
+ \rowcolor[gray]{0.85} Name & Source & \multicolumn{2}{l|}{Rates (MHz)} & Description \\\hhline{~|~|-|-|~}%
+ \rowcolor[gray]{0.85} & & Max & Min & \\\hline\hline}%
+ {\end{tabular}}
+\newenvironment{reglist}{\begin{tabular}{|p{0.75in}|p{0.5in}|p{0.5in}|p{0.5in}|p{2.875in}|}\hline
+ \rowcolor[gray]{0.85} Name & Address & Width & Access & Description \\\hline\hline}%
+ {\end{tabular}}
+\newenvironment{bitlist}{\begin{tabular}{|p{0.5in}|p{0.5in}|p{3.875in}|}\hline
+ \rowcolor[gray]{0.85} Bit \# & Access & Description \\\hline\hline}%
+ {\end{tabular}}
+\newenvironment{portlist}{\begin{tabular}{|p{0.75in}|p{0.5in}|p{0.75in}|p{3.375in}|}\hline
+ \rowcolor[gray]{0.85} Port & Width & Direction & Description \\\hline\hline}%
+ {\end{tabular}}
+\newenvironment{wishboneds}{\begin{tabular}{|p{2.5in}|p{2.5in}|}\hline
+ \rowcolor[gray]{0.85} Description & Specification \\\hline\hline}%
+ {\end{tabular}}
+\newenvironment{preface}{\chapter*{Preface}}{\par\bigskip\bigskip\leftline{\hfill\@author}}
+\endinput
Index: trunk/doc/src/spec.tex
===================================================================
--- trunk/doc/src/spec.tex (nonexistent)
+++ trunk/doc/src/spec.tex (revision 2)
@@ -0,0 +1,460 @@
+\documentclass{gqtekspec}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%
+%% Filename: spec.tex
+%%
+%% Project: OpenArty, an entirely open SoC based upon the Arty platform
+%%
+%% Purpose:
+%%
+%% Creator: Dan Gisselquist, Ph.D.
+%% Gisselquist Technology, LLC
+%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%
+%% Copyright (C) 2015-2016, Gisselquist Technology, LLC
+%%
+%% This program is free software (firmware): 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 3 of the License, or (at
+%% your option) any later version.
+%%
+%% This program is distributed in the hope that it will be useful, but WITHOUT
+%% ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or
+%% FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+%% for more details.
+%%
+%% You should have received a copy of the GNU General Public License along
+%% with this program. (It's in the $(ROOT)/doc directory, run make with no
+%% target there if the PDF file isn't present.) If not, see
+%% for a copy.
+%%
+%% License: GPL, v3, as defined and found on www.gnu.org,
+%% http://www.gnu.org/licenses/gpl.html
+%%
+%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%
+%%
+\usepackage{import}
+\usepackage{bytefield}
+\project{OpenArty}
+\title{Specification}
+\author{Dan Gisselquist, Ph.D.}
+\email{dgisselq (at) opencores.org}
+\revision{Rev.~0.0}
+\begin{document}
+\pagestyle{gqtekspecplain}
+\titlepage
+\begin{license}
+Copyright (C) \theyear\today, Gisselquist Technology, LLC
+
+This project is free software (firmware): 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 3 of the License, or (at
+your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program. If not, see \texttt{http://www.gnu.org/licenses/} for a copy.
+\end{license}
+\begin{revisionhistory}
+0.0 & 6/20/2016 & Gisselquist & First Draft \\\hline
+\end{revisionhistory}
+% Revision History
+% Table of Contents, named Contents
+\tableofcontents
+\listoffigures
+\listoftables
+\begin{preface}
+\end{preface}
+
+\chapter{Introduction}
+\pagenumbering{arabic}
+\setcounter{page}{1}
+
+% What is old
+% Arty, XuLA
+% What does the old lack?
+% Arty lacks open interfaces, instead using MIG and CoreGen w/ AXI bus
+% What is new
+% OpenArty has its own memory interface controller, and runs everything
+% off of an open Wishbone bus structure.
+% What does the new have that the old lacks
+%
+% What performance gain can be expected?
+%
+
+The goals of this project include:
+\begin{enumerate}
+\item Use entirely open interfaces
+
+ This means not using the Memory Interface Generator (MIG), the
+ Xilinx CoreGen IP, etc. Further, I wish to use all of Arty's on--board
+ hardware: Flash, DDR3-SDRAM, Ethernet, and everything else at their
+ full and fastest speed(s). For example, the flash will need to be
+ clocked at 100~MHz, not the 50~MHz I've clocked it at before. The
+ memory should also be able to support pipelined 32--bit interactions
+ over the Wishbone bus at a 200~MHz clock. Finally, the Ethernet
+ controller should be supported by a DMA capable interface that can
+ drive the ethernet at its full 100Mbps rate.
+
+\item Run using a 200~MHz clock, if for no other reason than to gain the
+ experience of building logic that can run that fast.
+
+\item Modify the ZipCPU to support an MMU and a data cache, and perhaps even
+ a floating point unit.
+
+\item The default configuration will also include three Pmods: a USBUART,
+ an SDCard, and the GPS Pmod.
+\end{enumerate}
+
+I intend to demonstrate this project with a couple programs:
+\begin{enumerate}
+\item A very simple program that runs automatically upon startup that can be
+ used to select from among multiple configurations.
+\item NTP Server
+\item A ZipOS that can actually load and run programs from the SD Card
+\end{enumerate}
+
+\chapter{Architecture}
+
+
+\chapter{Software}
+\section{Directory Structure}
+\section{Zip CPU Tool Chain}
+\section{Bench Test Software}
+\section{Host Software}
+\begin{itemize}
+\item {\tt readflash}: As I am loathe to remove anything from
+ a device that came factory installed, the
+ {\tt readflash} program reads the original installed
+ configuration from the flash and dumps it to a file.
+
+\item {\tt wbregs}: This program offers a capability very similar to the
+ PEEK and POKE capability Apple user's may remember from before the
+ days of Macintosh. {\tt wbregs } will read from the
+ Wishbone bus the value at the given address. Likewise
+ {\tt wbregs } will write the given value into the
+ given address. While both address and value have the semantics of
+ numbers acceptable to {\tt strtoul()}, the address can also be a named
+ address. Supported names can be found in {\tt regdefs.cpp}, and their
+ register mapping in {\tt regdefs.h}.
+\item {\tt ziprun}:
+\item {\tt zipload}:
+\end{itemize}
+
+\section{Zip CPU Programs}
+\begin{itemize}
+\item {\tt ntpserver}:
+\item {\tt goldenstart}:
+\end{itemize}
+\section{ZipOS}
+\subsection{System Calls}
+\begin{itemize}
+\item {\tt int wait(unsigned event\_mask, int timeout)}
+\item {\tt int clear(unsigned event\_mask, int timeout)}
+\item {\tt void post(unsigned event\_mask)}
+\item {\tt void yield(void) }
+\item {\tt int read(int fid, void *buf, int len)}
+\item {\tt int write(int fid, void *buf, int len)}
+\item {\tt unsigned time(void) }
+% \item SEMGET
+% \item SEMPUT
+\item {\tt void *malloc(void)}
+\item {\tt void free(void *buf)}
+% \item FORK
+% \item opendir
+% \item EXEC
+% \item OPEN
+\end{itemize}
+\subsection{Scheduler}
+
+\chapter{Operation}
+
+\chapter{Registers}
+There are several address regions on the S6~SoC, as shown in
+Tbl.~\ref{tbl:memregions}.
+\begin{table}[htbp]
+\begin{center}\begin{tabular}{|p{2.25in}|p{0.6in}|p{0.45in}|p{2.0in}|}\hline
+\rowcolor[gray]{0.85} Binary Address & Base & Size(W) & Purpose \\\hline\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 000x xxxx} & \scalebox{0.9}{\tt 0x00000100} & \hfill 32 & Peripheral I/O Control \\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 0010 0yyx} & \scalebox{0.9}{\tt 0x00000120} & \hfill 8 & Debug scope control\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 0010 10xx} & \scalebox{0.9}{\tt 0x00000128} & \hfill 4 & RTC control\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 0010 11xx} & \scalebox{0.9}{\tt 0x0000012c} & \hfill 4 & SDCard controller\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 0011 00xx} & \scalebox{0.9}{\tt 0x00000130} & \hfill 4 & GPS Clock loop control\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 0011 01xx} & \scalebox{0.9}{\tt 0x00000134} & \hfill 4 & Network packet interface\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 0011 10xx} & \scalebox{0.9}{\tt 0x00000138} & \hfill 4 & OLEDrgb control\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 0011 11xx} & \scalebox{0.9}{\tt 0x0000013c} & \hfill 4 & {\em Unused}\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 0100 0xxx} & \scalebox{0.9}{\tt 0x00000140} & \hfill 8 & GPS Testbench\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 0100 1xxx} & \scalebox{0.9}{\tt 0x00000148} & \hfill 8 & {\em Unused}\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 0101 xxxx} & \scalebox{0.9}{\tt 0x00000150} & \hfill 16 & {\em Unused}\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 011x xxxx} & \scalebox{0.9}{\tt 0x00000160} & \hfill 32 & {\em Unused}\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 100x xxxx} & \scalebox{0.9}{\tt 0x00000180} & \hfill 32 & {\em Unused}\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 101x xxxx} & \scalebox{0.9}{\tt 0x000001a0} & \hfill 32 & Ethernet configuration registers\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 110x xxxx} & \scalebox{0.9}{\tt 0x000001c0} & \hfill 32 & Extended Flash Control Port\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 0001 111x xxxx} & \scalebox{0.9}{\tt 0x000001e0} & \hfill 32 & ICAPE2 Configuration Port\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 10xx xxxx xxxx} & \scalebox{0.9}{\tt 0x00000800} & \hfill 1k & Ethernet TX Buffer\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 0000 11xx xxxx xxxx} & \scalebox{0.9}{\tt 0x00000c00} & \hfill 1k & Ethernet RX Buffer\\\hline
+\scalebox{0.9}{\tt 0000 0000 0000 1xxx xxxx xxxx xxxx} & \scalebox{0.9}{\tt 0x00008000} & \hfill 32k & On-chip Block RAM\\\hline
+\scalebox{0.9}{\tt 0000 01xx xxxx xxxx xxxx xxxx xxxx} & \scalebox{0.9}{\tt 0x00400000} & \hfill 4M & QuadSPI Flash\\\hline
+\scalebox{0.9}{\tt 01xx xxxx xxxx xxxx xxxx xxxx xxxx} & \scalebox{0.9}{\tt 0x04000000} & \hfill 64M & DDR3 SDRAM\\\hline
+\scalebox{0.9}{\tt 1000 0000 0000 0000 0000 0000 000x} & \scalebox{0.9}{\tt 0x08000000} & \hfill 2 & ZipCPU debug control port---only visible to debug WB master\\\hline
+\end{tabular}
+\caption{Address Regions}\label{tbl:memregions}
+\end{center}\end{table}
+
+\begin{table}[htbp]
+\begin{center}\begin{tabular}{|p{0.9in}|p{0.45in}|p{3.5in}|}\hline
+\rowcolor[gray]{0.85} Base & Size(W) & Purpose \\\hline\hline
+\scalebox{0.9}{\tt 0x0c0000000} & 1 & Primary Zip PIC\\\hline
+\scalebox{0.9}{\tt 0x0c0000001} & 1 & Watchdog Timer\\\hline
+\scalebox{0.9}{\tt 0x0c0000002} & 1 & Bus Watchdog Timer\\\hline
+\scalebox{0.9}{\tt 0x0c0000003} & 1 & Alternate Zip PIC\\\hline
+\scalebox{0.9}{\tt 0x0c0000004} & 1 & ZipTimer-A\\\hline
+\scalebox{0.9}{\tt 0x0c0000005} & 1 & ZipTimer-B\\\hline
+\scalebox{0.9}{\tt 0x0c0000006} & 1 & ZipTimer-C\\\hline
+\scalebox{0.9}{\tt 0x0c0000007} & 1 & ZipJiffies\\\hline
+\scalebox{0.9}{\tt 0x0c0000008} & 1 & Master task counter\\\hline
+\scalebox{0.9}{\tt 0x0c0000009} & 1 & Master prefetch stall counter\\\hline
+\scalebox{0.9}{\tt 0x0c000000a} & 1 & Master memory stall counter\\\hline
+\scalebox{0.9}{\tt 0x0c000000b} & 1 & Master instruction counter\\\hline
+\scalebox{0.9}{\tt 0x0c000000c} & 1 & User task counter\\\hline
+\scalebox{0.9}{\tt 0x0c000000d} & 1 & User prefetch stall counter\\\hline
+\scalebox{0.9}{\tt 0x0c000000e} & 1 & User memory stall counter\\\hline
+\scalebox{0.9}{\tt 0x0c000000f} & 1 & User instruction counter\\\hline
+\scalebox{0.9}{\tt 0x0c0000010} & 1 & DMA command register\\\hline
+\scalebox{0.9}{\tt 0x0c0000011} & 1 & DMA length\\\hline
+\scalebox{0.9}{\tt 0x0c0000012} & 1 & DMA source address\\\hline
+\scalebox{0.9}{\tt 0x0c0000013} & 1 & DMA destination address\\\hline
+\scalebox{0.9}{\tt 0x0c0000040} & 1 & {\em Reserved for MMU context register}\\\hline
+\scalebox{0.9}{\tt 0x0c0000080} & 32 & {\em Reserved for MMU TLB}\\\hline
+\end{tabular}
+\caption{ZipSystem Addresses}\label{tbl:zipio}
+\end{center}\end{table}
+
+\section{Peripheral I/O Control}
+Tbl.~\ref{tbl:ioregs}
+\begin{table}[htbp]
+\begin{center}\begin{reglist}
+VERSION &\scalebox{0.8}{\tt 0x0100} & 32 & R & Build date\\\hline
+PIC &\scalebox{0.8}{\tt 0x0101} & 32 & R/W & Bus Interrupt Controller \\\hline
+BUSERR &\scalebox{0.8}{\tt 0x0102} & 32 & R & Last Bus Error Address\\\hline
+PWRCOUNT &\scalebox{0.8}{\tt 0x0103} & 32 & R & Ticks since startup\\\hline
+BTNSW &\scalebox{0.8}{\tt 0x0104} & 32 & R/W & Button/Switch controller\\\hline
+LEDCTRL &\scalebox{0.8}{\tt 0x0105} & 32 & R/W & LED Controller \\\hline
+AUXSETUP &\scalebox{0.8}{\tt 0x0106} & 29 & R/W & Auxilliary UART config\\\hline
+GPSSETUP &\scalebox{0.8}{\tt 0x0107} & 29 & R/W & GPS UART config\\\hline
+CLR-LEDx &\scalebox{0.8}{\tt 0x0108-b} & 32 & R/W & Color LED controller\\\hline
+RTCDATE &\scalebox{0.8}{\tt 0x010c} & 32 & R/W & BCD Calendar Date\\\hline
+GPIO &\scalebox{0.8}{\tt 0x010d} & 32 & R/W & GPIO controller\\\hline
+UARTRX &\scalebox{0.8}{\tt 0x010e} & 32 & R/W & Aux UART receive byte\\\hline
+UARTTX &\scalebox{0.8}{\tt 0x010f} & 32 & R/W & Aux UART transmit byte\\\hline
+GPSRX &\scalebox{0.8}{\tt 0x0110} & 32 & R/W & GPS UART receive byte\\\hline
+GPSTX &\scalebox{0.8}{\tt 0x0111} & 32 & R/W & GPS UART transmit byte\\\hline
+% 0x010c-0x010f
+\end{reglist}
+\caption{I/O Peripheral Registers}\label{tbl:ioregs}
+\end{center}\end{table}
+shows the addresses of various I/O peripherals included as part of the SoC.
+We'll walk through each of these peripherals in turn, describing how they work.
+
+\subsection{Interrupt Controller}
+The OpenArty design maintains three interrupt controllers. Two of them
+are found within the ZipSystem, and the third is located on the bus
+itself. Of these, the primary interrupt controller is located in the ZipSystem.
+This interrupt controller accepts, as interrupt inputs, the outputs of both
+the auxilliary interrupt controller as well as the bus interrupt controller.
+Hence, even though the CPU only supports a single interrupt line, by using
+these three interrupt controllers many more interrupts can be supported.
+
+The primary interrupt controller handles interrupts from the sources listed
+in Tbl.~\ref{tbl:sys-ints}. These interrupts are listed together with the
+mask that would need to be used when referencing them to the interrupt
+controller. In a similar fashion, the auxilliary interrupt controller accepts
+inputs from the sources listed in Tbl.~\ref{tbl:aux-ints}. Finally, the
+bus interrupt controller handles the interrupts from the sources listed in
+Tbl.~\ref{tbl:bus-ints}.
+
+\begin{table}[htbp]
+\begin{center}\begin{tabular}{|p{0.9in}|p{0.75in}|p{0.75in}|p{3.00in}|}\hline
+\rowcolor[gray]{0.85} Name & Bit Mask & DMAC ID &Description \\\hline\hline
+SYS\_DMAC & 0x0001 && The DMA controller is idle.\\\hline
+SYS\_JIF & 0x0002 & 1 & A Jiffies timer has expired.\\\hline
+SYS\_TMC & 0x0004 & 2 & Timer C has timed out.\\\hline
+SYS\_TMB & 0x0008 & 3 & Timer C has timed out.\\\hline
+SYS\_TMA & 0x0010 & 4 & Timer C has timed out.\\\hline
+SYS\_AUX & 0x0020 & 5 & The auxilliary interrupt controller sends an interrupt\\\hline
+SYS\_EXT & 0x0040 & 6 & A Bus interrupt has tripped. \\\hline
+SYS\_PPS & 0x0080 & 7 & An interrupt marking the top of the second\\\hline
+SYS\_GPSRX & 0x0100 & 8& A character has been received via GPS\\\hline
+SYS\_NETRX & 0x0200 & 9 & A packet has been received via the network\\\hline
+SYS\_NETTX & 0x0400 & 10 & The network controller is idle, having sent its
+ last packet\\\hline
+SYS\_UARTRX & 0x0800 & 11 & A character has been received via the UART\\\hline
+SYS\_UARTTX & 0x1000 & 12 & The transmit UART is idle, and ready for its next
+ character.\\\hline
+SYS\_SDCARD & 0x2000 & 13 & The SD-Card controller has become idle\\\hline
+SYS\_BUTTON & 0x4000 & 14 & A Button has been pressed. \\\hline
+\end{tabular}
+\caption{Primary System Interrupts}\label{tbl:sys-ints}
+\end{center}\end{table}
+%%%%%%%%%%%%%
+\begin{table}[htbp]
+\begin{center}\begin{tabular}{|p{0.9in}|p{0.75in}|p{0.75in}|p{3.00in}|}\hline
+\rowcolor[gray]{0.85} Name & Bit Mask & DMAC ID &Description \\\hline\hline
+AUX\_UIC & 0x0001 & 16 & The user instruction counter has overflowed.\\\hline
+AUX\_UPC & 0x0002 & 17 & The user prefetch stall counter has overflowed.\\\hline
+AUX\_UOC & 0x0004 & 18 & The user ops stall counter has overflowed.\\\hline
+AUX\_UTC & 0x0008 & 19 & The user clock tick counter has overflowed.\\\hline
+AUX\_MIC & 0x0010 & 20 & The supervisor instruction counter has overflowed.\\\hline
+AUX\_MPC & 0x0020 & 21 & The supervisor prefetch stall counter has overflowed.\\\hline
+AUX\_MOC & 0x0040 & 22 & The supervisor ops stall counter has overflowed.\\\hline
+AUX\_MTC & 0x0080 & 23 & The supervisor clock tick counter has overflowed.\\\hline
+AUX\_SWITCH & 0x0100 & 24 & A switch has changed state\\\hline
+AUX\_FLASH & 0x0200 & 25 & The flash controller has completed a write/erase cycle\\\hline
+AUX\_SCOPE & 0x0400 & 26 & The Scope has completed its collection\\\hline
+AUX\_RTC & 0x0800 & 27& An alarm or timer has taken place (assuming the RTC
+ is installed, and includes both alarm or timer)\\\hline
+AUX\_GPIO & 0x1000 & 28 & The GPIO input lines have changed values.\\\hline
+AUX\_OLED & 0x2000 & 29 & The OLED driver is idle\\\hline
+\end{tabular}
+\caption{Auxilliary System Interrupts}\label{tbl:aux-ints}
+\end{center}\end{table}
+
+\begin{table}[htbp]
+\begin{center}\begin{tabular}{|p{0.9in}|p{0.75in}|p{3.75in}|}\hline
+\rowcolor[gray]{0.85} Name & Bit Mask & Description \\\hline\hline
+BUS\_BUTTON & 0x0001 & A Button has been pressed. \\\hline
+BUS\_SWITCH & 0x0002 & The Scope has completed its collection\\\hline
+BUS\_PPS & 0x0004 & Top of the second\\\hline
+BUS\_RTC & 0x0008 & An alarm or timer has taken place (assuming the RTC
+ is installed, and includes both alarm or timer)\\\hline
+BUS\_NETRX & 0x0010 & A packet has been received via the network\\\hline
+BUS\_NETTX & 0x0020 & The network controller is idle, having sent its
+ last packet\\\hline
+BUS\_UARTRX & 0x0040 & A character has been received via the UART\\\hline
+BUS\_UARTTX & 0x0080 & The transmit UART is idle, and ready for its next
+ character.\\\hline
+BUS\_GPIO & 0x0100 & The GPIO input lines have changed values.\\\hline
+BUS\_FLASH & 0x0200 & The flash device has finished either its erase or
+ write cycle, and is ready for its next command. (Alternate
+ config only.)\\\hline
+BUS\_SCOPE & 0x0400 & A scope has completed collecting.\\\hline
+BUS\_GPSRX & 0x0800 & A character has been received via GPS\\\hline
+BUS\_SDCARD & 0x1000 & The SD-Card controller has become idle\\\hline
+BUS\_OLED & 0x2000 & The OLED interface has become idle\\\hline
+BUS\_ZIP & 0x4000 & True if the ZipCPU has come to a halt\\\hline
+\end{tabular}
+\caption{Bus Interrupts}\label{tbl:bus-ints}
+\end{center}\end{table}
+
+\subsection{Last Bus Error Address}
+\subsection{General Purpose I/O}
+\subsection{UART Data Register}
+\section{Debugging Scopes}
+\section{Internal Configuration Access Port}
+\section{Real--Time Clock}
+\section{On-Chip Block RAM}
+\section{Flash Memory}
+\begin{table}
+\begin{center}\begin{reglist}
+ewreg &\scalebox{0.8}{\tt 0x0180} & 32 & R & Erase/write control and status\\\hline
+status &\scalebox{0.8}{\tt 0x0181} & 8 & R/W & Bus Interrupt Controller \\\hline
+nvconf &\scalebox{0.8}{\tt 0x0182} & 16 & R & Last Bus Error Address\\\hline
+vconf &\scalebox{0.8}{\tt 0x0183} & 8 & R & Ticks since startup\\\hline
+evonc &\scalebox{0.8}{\tt 0x0184} & 8 & R/W & Button/Switch controller\\\hline
+lock &\scalebox{0.8}{\tt 0x0185} & 8 & R/W & LED Controller \\\hline
+flagstatus&\scalebox{0.8}{\tt 0x0186} & 8 & R/W & Auxilliary UART config\\\hline
+clear &\scalebox{0.8}{\tt 0x0187} & 8 & R/W & Clear status on write\\\hline
+Device ID &\scalebox{0.8}{\tt 0x0188-}\hfill & 5x32 & R & Device ID\\
+ &\scalebox{0.8}{\tt -0x018c}\hfill & & & \\\hline
+% asyncID &\scalebox{0.8}{\tt 0x018d} & 32 & R/W & Asynch Read ID. Write starts the ASynch read, 0xff returned until complete\\\hline
+asyncOTP &\scalebox{0.8}{\tt 0x18e} & 32 & W & Asynch Read OTP. Write starts the ASynch read, 0xff returned until complete\\\hline
+OTP &\scalebox{0.8}{\tt 0x0190-}\hfill &16x32 & R/W & OTP Memory\\
+ &\scalebox{0.8}{\hfill\tt -0x19f} & & & \\\hline
+% 0x010c-0x010f
+\end{reglist}
+\caption{Flash control registers}\label{tbl:flctl}
+\end{center}\end{table}
+
+\chapter{Wishbone}
+
+The master and slave interfaces have been simplified with the following
+requirement: the {\tt STB} line is not allowed to be high unless the {\tt CYC}
+line is high. In this fashion, a slave may often be able to ignore {\tt CYC}
+and only act on the presence of {\tt STB}, knowing that {\tt CYC} must be
+active at the same time.
+
+\chapter{Clocks}
+\begin{table}\begin{center}
+\begin{clocklist}
+{\tt i\_clk\_100mhz} & Ext & \multicolumn{2}{c|}{100~MHz} &
+ 100~MHz Crystal Oscillator \\\hline
+{\tt s\_clk} & PLL & 200~MHz & & Internal Logic, Wishbone Clock \\\hline
+{\tt ram\_clk} & PLL & 200~MHz & & DDR3 SDRAM Clock \\\hline
+{\tt o\_sck} & Logic & 108~MHz & 50~MHz & QSPI Flash clock \\\hline
+{\tt o\_sdclk} & Logic & 50~MHz & 100~kHz & SD--Card clock \\\hline
+\end{clocklist}
+\caption{OpenArty clocks}\label{tbl:clocks}
+\end{center}\end{table}
+
+\chapter{I/O Ports}
+
+Table.~\ref{tbl:ioports}
+\begin{table}[htbp]
+\begin{center}
+\begin{portlist}
+i\_clk\_100mhz & 1 & Input & Clock\\\hline
+o\_qspi\_cs\_n & 1 & Output & Quad SPI Flash chip select\\\hline
+o\_qspi\_sck & 1 & Output & Quad SPI Flash clock\\\hline
+io\_qspi\_dat & 4 & Input/Output & Four-wire SPI flash data bus\\\hline
+i\_btn & 4 & Input & Inputs from the two on-board push-buttons\\\hline
+i\_sw & 4 & Input & Inputs from the two on-board push-buttons\\\hline
+o\_led & 4 & Output & Outputs controlling the four on-board LED's\\\hline
+o\_clr\_led0 & 3 & Output & \\\hline
+o\_clr\_led1 & 3 & Output & \\\hline
+o\_clr\_led2 & 3 & Output & \\\hline
+o\_clr\_led3 & 3 & Output & \\\hline
+i\_uart\_rx & 1 & Input & UART receive input\\\hline
+o\_uart\_tx & 1 & Output & UART transmit output\\\hline\hline
+i\_aux\_rx & 1 & Input & Auxiliary/Pmod UART receive input\\\hline
+o\_aux\_tx & 1 & Output & Auxiliary/Pmod UART transmit output\\\hline
+i\_aux\_rts & 1 & Input & Auxiliary/Pmod UART receive input\\\hline
+o\_aux\_cts & 1 & Output & Auxiliary/Pmod UART transmit output\\\hline\hline
+i\_gps\_rx & 1 & Input & GPS/Pmod UART receive input\\\hline
+o\_gps\_tx & 1 & Output & GPS/Pmod UART transmit output\\\hline
+i\_gps\_pps & 1 & Input & GPS Part-per-second (PPS) signal\\\hline
+i\_gps\_3df & 1 & Input & GPS\\\hline\hline
+o\_oled\_cs\_n & 1 & Output & \\\hline
+o\_oled\_sck & 1 & Output & \\\hline
+o\_oled\_mosi & 1 & Output & \\\hline
+i\_oled\_miso & 1 & Input & \\\hline
+o\_oled\_reset & 1 & Output & \\\hline
+o\_oled\_dc & 1 & Output & \\\hline
+o\_oled\_en & 1 & Output & \\\hline
+o\_oled\_pmen & 1 & Output & \\\hline\hline
+o\_sd\_sck & 1 & Output & SD Clock\\\hline
+i\_sd\_cd & 1 & Input & Card Detect\\\hline
+i\_sd\_wp & 1 & Input & Write Protect\\\hline
+io\_cmd & 1 & In/Output & SD Bi-directional command wire\\\hline
+io\_sd & 4 & In/Output & SD Bi-directional data lines\\\hline\hline
+o\_cls\_cs\_n & 1 & Output & CLS Display chip select\\\hline
+o\_cls\_sck & 1 & Output & CLS Display clock\\\hline
+o\_cls\_mosi & 1 & Output & CLS Display MOSI\\\hline
+i\_cls\_miso & 1 & Input & CLS Display MISO\\\hline\hline
+\end{portlist}
+\caption{List of IO ports}\label{tbl:ioports}
+\end{center}\end{table}
+lists the various I/O ports associated with OpenArty.
+
+
+% Appendices
+% Index
+\end{document}
+
+
Index: trunk/doc/gpl-3.0.pdf
===================================================================
Cannot display: file marked as a binary type.
svn:mime-type = application/octet-stream
Index: trunk/doc/gpl-3.0.pdf
===================================================================
--- trunk/doc/gpl-3.0.pdf (nonexistent)
+++ trunk/doc/gpl-3.0.pdf (revision 2)
trunk/doc/gpl-3.0.pdf
Property changes :
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Index: trunk/doc/Makefile
===================================================================
--- trunk/doc/Makefile (nonexistent)
+++ trunk/doc/Makefile (revision 2)
@@ -0,0 +1,83 @@
+################################################################################
+##
+## Filename: Makefile
+##
+## Project: OpenArty, an entirely open SoC based upon the Arty platform
+##
+## Purpose: To coordinate the build of documentation PDFs from their
+## LaTeX sources.
+##
+## Targets include:
+## all Builds all documents
+##
+## gpl-3.0.pdf Builds the GPL license these files are released
+## under.
+##
+## spec.pdf Builds the specification for the SDSPI
+## controller.
+##
+## Creator: Dan Gisselquist, Ph.D.
+## Gisselquist Technology, LLC
+##
+################################################################################
+##
+## Copyright (C) 2015-2016, Gisselquist Technology, LLC
+##
+## This program is free software (firmware): 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 3 of the License, or (at
+## your option) any later version.
+##
+## This program is distributed in the hope that it will be useful, but WITHOUT
+## ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or
+## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+## for more details.
+##
+## You should have received a copy of the GNU General Public License along
+## with this program. (It's in the $(ROOT)/doc directory, run make with no
+## target there if the PDF file isn't present.) If not, see
+## for a copy.
+##
+## License: GPL, v3, as defined and found on www.gnu.org,
+## http://www.gnu.org/licenses/gpl.html
+##
+##
+################################################################################
+##
+##
+all: gpl spec
+pdf: gpl spec
+DSRC := src
+
+.PHONY: gpl
+gpl: gpl-3.0.pdf
+
+gpl-3.0.pdf: $(DSRC)/gpl-3.0.tex
+ latex $(DSRC)/gpl-3.0.tex
+ latex $(DSRC)/gpl-3.0.tex
+ dvips -q -z -t letter -P pdf -o gpl-3.0.ps gpl-3.0.dvi
+ ps2pdf -dAutoRotatePages=/All gpl-3.0.ps gpl-3.0.pdf
+ rm gpl-3.0.dvi gpl-3.0.log gpl-3.0.aux gpl-3.0.ps
+
+.PHONY: spec
+spec: spec.pdf
+
+spec.pdf: $(DSRC)/spec.tex $(DSRC)/gqtekspec.cls $(DSRC)/GT.eps
+ cd $(DSRC)/; latex spec.tex
+ cd $(DSRC)/; latex spec.tex
+ cd $(DSRC)/; dvips -q -z -t letter -P pdf -o ../spec.ps spec.dvi
+ ps2pdf -dAutoRotatePages=/All spec.ps spec.pdf
+ -grep -i warning $(DSRC)/spec.log
+ @rm -f $(DSRC)/spec.dvi $(DSRC)/spec.log
+ @rm -f $(DSRC)/spec.aux $(DSRC)/spec.toc
+ @rm -f $(DSRC)/spec.lot $(DSRC)/spec.lof
+ @rm -f $(DSRC)/spec.out spec.ps
+
+.PHONY: clean
+clean:
+ rm -f $(DSRC)/spec.dvi $(DSRC)/spec.log
+ rm -f $(DSRC)/spec.aux $(DSRC)/spec.toc
+ rm -f $(DSRC)/spec.lot $(DSRC)/spec.lof
+ rm -f $(DSRC)/spec.out spec.ps spec.pdf
+ rm -f gpl-3.0.pdf
+