Compare commits
10 Commits
6016d2d706
...
a3d0658c5f
Author | SHA1 | Date |
---|---|---|
Joris van Rantwijk | a3d0658c5f | |
Joris van Rantwijk | ce08bd84e4 | |
Joris van Rantwijk | 2bf8b9f938 | |
Joris van Rantwijk | 4814275863 | |
Joris van Rantwijk | b445abd149 | |
Joris van Rantwijk | 6b96ab38d2 | |
Joris van Rantwijk | 0594016924 | |
Joris van Rantwijk | bdefc835b6 | |
Joris van Rantwijk | 33db3d5231 | |
Joris van Rantwijk | 6a39840821 |
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
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.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. 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.
|
||||
|
||||
1. 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.
|
||||
|
||||
2. 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.
|
||||
|
||||
3. 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.
|
||||
|
||||
4. 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.
|
||||
|
||||
5. 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:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) 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".
|
||||
|
||||
c) 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.
|
||||
|
||||
d) 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.
|
||||
|
||||
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.
|
||||
|
||||
6. 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:
|
||||
|
||||
a) 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.
|
||||
|
||||
b) 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.
|
||||
|
||||
c) 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.
|
||||
|
||||
d) 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.
|
||||
|
||||
e) 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.
|
||||
|
||||
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.
|
||||
|
||||
7. 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:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) 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
|
||||
|
||||
c) 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
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) 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.
|
||||
|
||||
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.
|
||||
|
||||
8. 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.
|
||||
|
||||
9. 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.
|
||||
|
||||
10. 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.
|
||||
|
||||
11. 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.
|
||||
|
||||
12. 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.
|
||||
|
||||
13. 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.
|
||||
|
||||
14. 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.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
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.
|
||||
|
||||
16. 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.
|
||||
|
||||
17. 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.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
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.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
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 <https://www.gnu.org/licenses/>.
|
||||
|
||||
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:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
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.
|
||||
|
||||
The hypothetical commands `show w' and `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
|
||||
<https://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
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
@ -0,0 +1,73 @@
|
|||
# PuzzleFW - Custom firmware for the Red Pitaya
|
||||
|
||||
This project provides an alternative, unofficial firmware package
|
||||
for the Red Pitaya.
|
||||
It consists of FPGA firmware and embedded software which can be installed on
|
||||
the SD card in place of the official Red Pitaya firmware.
|
||||
|
||||
Red Pitaya is a signal processing board based on the Xilinx Zynq architecture.
|
||||
See <https://redpitaya.com/> for further information.
|
||||
|
||||
PuzzleFW is very different from the official Red Pitaya firmware.
|
||||
Its functionality is quite limited.
|
||||
It is not aimed at exploration.
|
||||
It doesn't have a web interface or any graphical interface.
|
||||
Instead, it is designed to be controlled by other software via the network,
|
||||
as part of an automated measurement setup.
|
||||
|
||||
PuzzleFW has the following features:
|
||||
|
||||
- Analog input at 125 MSa/s with optional downsampling.
|
||||
- Triggered data acquisition via a digital input signal.
|
||||
- Fast re-triggering, up to 100 kHz trigger rate.
|
||||
- No analog output.
|
||||
- Digital input with event timestamping (4 channels).
|
||||
- Streaming transfer of sample data via TCP, up to 5 MSa/s.
|
||||
- Remote control by sending commands via TCP.
|
||||
|
||||
Further details about the firmware are in these documents:
|
||||
|
||||
- User manual, to be written
|
||||
- Developer manual, including the build procedure, to be written
|
||||
- [FPGA firmware description](doc/fpga_firmware.md)
|
||||
|
||||
## Supported boards
|
||||
|
||||
This firmware is currently compatible with the following boards:
|
||||
|
||||
- Red Pitaya STEMlab 125-14
|
||||
- Red Pitaya STEMlab 125-14 4-input
|
||||
|
||||
## Status
|
||||
|
||||
The firmware works and has been tested and is being used on a small scale.
|
||||
|
||||
You are very welcome to use this firmware on your own Red Pitaya.
|
||||
However, no support is available for this package.
|
||||
This is currently just a side-project for me.
|
||||
I don't have plans to develop this into a maintained product.
|
||||
|
||||
If you run into issues or discover bugs, I would like to hear about it.
|
||||
But I can not guarantee that I will fix the problem.
|
||||
|
||||
You can contact me via email to `joris@jorisvr.nl`.
|
||||
|
||||
## License
|
||||
|
||||
The FPGA firmware and software in this repository are provided as free software under the terms of the GNU General Public License.
|
||||
|
||||
Copyright (c) 2024 Joris van Rantwijk
|
||||
|
||||
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 <https://www.gnu.org/licenses/>.
|
||||
|
|
@ -119,6 +119,7 @@ In the response string, such data elements are separated by space characters.
|
|||
| `AIN:TRIGGER:STATUS?` | Trigger status. |
|
||||
| `AIN:TRIGGER:EXT:CHANNEL` | External trigger channel. |
|
||||
| `AIN:TRIGGER:EXT:EDGE` | External trigger edge. |
|
||||
| `AIN:ACQUIRE:ENABLE` | Enable analog acquisition. |
|
||||
| `TT:SAMPLE?` | Digital input state. |
|
||||
| `TT:EVENT:MASK` | Timetagger event mask. |
|
||||
| `TT:MARK` | Emit timetagger marker. |
|
||||
|
@ -382,6 +383,18 @@ This command selects rising or falling edges in the external trigger signal.
|
|||
Query: `AIN:TRIGGER:EXT:EDGE?` <br>
|
||||
Response: either `RISING` or `FALLING`.
|
||||
|
||||
### `AIN:ACQUIRE:ENABLE`
|
||||
|
||||
Command: `AIN:ACQUIRE:ENABLE en` <br>
|
||||
Parameter _en_: either `0` or `1`.
|
||||
|
||||
This command enables or disables analog acquisition.
|
||||
When enabled, analog samples are acquired according to the configured trigger mode.
|
||||
When disabled, all triggers are ignored and any ongoing analog acquisition stops immediately.
|
||||
|
||||
Query: `AIN:ACQUIRE:ENABLE?` <br>
|
||||
Response: either `0` or `1`.
|
||||
|
||||
### `TT:SAMPLE?`
|
||||
|
||||
Query: `TT:SAMPLE?` <br>
|
||||
|
|
|
@ -4,11 +4,14 @@ redpitaya_puzzlefw.xsa
|
|||
vivado/redpitaya_puzzlefw.srcs/sources_1/bd/puzzlefw/ip
|
||||
vivado/redpitaya_puzzlefw.srcs/sources_1/bd/puzzlefw/ipshared
|
||||
vivado/redpitaya_puzzlefw.srcs/sources_1/bd/puzzlefw/puzzlefw.bda
|
||||
vivado/redpitaya_puzzlefw.srcs/sources_1/bd/puzzlefw/ui
|
||||
vivado/redpitaya_puzzlefw.gen
|
||||
vivado/redpitaya_puzzlefw.cache
|
||||
vivado/redpitaya_puzzlefw.hw
|
||||
vivado/redpitaya_puzzlefw.ip_user_files
|
||||
vivado/redpitaya_puzzlefw.runs
|
||||
vivado/output
|
||||
vivado/output_4ch
|
||||
vivado/.Xil
|
||||
vivado/NONE
|
||||
vivado/*.html
|
||||
|
|
|
@ -0,0 +1,35 @@
|
|||
#!/bin/bash
|
||||
|
||||
set -e
|
||||
set -o pipefail
|
||||
|
||||
. script_env
|
||||
setup_vivado
|
||||
|
||||
rm -f puzzlefw_top_4ch.bit.bin redpitaya_puzzlefw_4ch.xsa
|
||||
|
||||
rm -rf vivado/redpitaya_puzzlefw.srcs/sources_1/bd/puzzlefw/ip
|
||||
rm -rf vivado/redpitaya_puzzlefw.srcs/sources_1/bd/puzzlefw/ipshared
|
||||
rm -rf vivado/redpitaya_puzzlefw.gen
|
||||
rm -rf vivado/output_4ch
|
||||
|
||||
mkdir -p vivado/output_4ch
|
||||
|
||||
( cd vivado
|
||||
stdbuf -oL vivado -mode batch -source nonproject_4ch.tcl | tee output_4ch/build_log.txt
|
||||
)
|
||||
|
||||
cat >vivado/output_4ch/bitstream.bif <<EOF
|
||||
all:
|
||||
{
|
||||
puzzlefw_top_4ch.bit
|
||||
}
|
||||
EOF
|
||||
|
||||
( cd vivado/output_4ch
|
||||
bootgen -image bitstream.bif -arch zynq -process_bitstream bin
|
||||
)
|
||||
|
||||
cp -a vivado/output_4ch/puzzlefw_top_4ch.bit.bin .
|
||||
cp -a vivado/output_4ch/redpitaya_puzzlefw_4ch.xsa .
|
||||
|
|
@ -171,9 +171,9 @@ set_property PACKAGE_PIN M15 [get_ports {exp_n_io[7]}]
|
|||
|
||||
# Pull down digital inputs.
|
||||
set_property PULLDOWN TRUE [get_ports {exp_p_io[0]}]
|
||||
set_property PULLDOWN TRUE [get_ports {exp_n_io[0]}]
|
||||
set_property PULLDOWN TRUE [get_ports {exp_p_io[1]}]
|
||||
set_property PULLDOWN TRUE [get_ports {exp_n_io[1]}]
|
||||
set_property PULLDOWN TRUE [get_ports {exp_p_io[2]}]
|
||||
set_property PULLDOWN TRUE [get_ports {exp_p_io[3]}]
|
||||
|
||||
#### SATA connector
|
||||
#set_property IOSTANDARD LVCMOS18 [get_ports {daisy_p_o[*]}]
|
||||
|
@ -225,10 +225,9 @@ set_input_delay -clock adc_clk -min 3.0 [get_ports {adc_dat_i[*][*]}]
|
|||
set_input_delay -clock adc_clk -max 5.6 [get_ports {adc_dat_i[*][*]}]
|
||||
set_multicycle_path 2 -from [get_ports {adc_dat_i[*][*]}]
|
||||
|
||||
# Digital inputs are asynchronous.
|
||||
# Set fairly relaxed constraints to limit delay and skew.
|
||||
set_input_delay -clock adc_clk -min 0.0 [get_ports {exp_p_io[*] exp_n_io[*]}]
|
||||
set_input_delay -clock adc_clk -max 3.0 [get_ports {exp_p_io[*] exp_n_io[*]}]
|
||||
# Digital inputs are asynchronous and captured in IOB flipflops.
|
||||
# Declare false path to avoid warning for unconstrained path.
|
||||
set_false_path -from [get_ports {exp_p_io[*]}]
|
||||
|
||||
# Delay to LEDs does not matter; just set a long max delay.
|
||||
set_max_delay -to [get_ports {led_o[*]}] 20.0
|
||||
|
|
|
@ -0,0 +1,242 @@
|
|||
#
|
||||
# $Id: red_pitaya_4adc.xdc 961 2014-01-21 11:40:39Z matej.oblak $
|
||||
#
|
||||
# @brief Red Pitaya location constraints.
|
||||
#
|
||||
# @Author Matej Oblak
|
||||
#
|
||||
# (c) Red Pitaya http://www.redpitaya.com
|
||||
#
|
||||
# Modified by Joris van Rantwijk for PuzzleFW.
|
||||
#
|
||||
|
||||
############################################################################
|
||||
# IO constraints #
|
||||
############################################################################
|
||||
|
||||
|
||||
############################################################################
|
||||
# Clock constraints #
|
||||
############################################################################
|
||||
|
||||
# ADC data
|
||||
set_property IOSTANDARD LVCMOS18 [get_ports {adc_dat_i[*][*]}]
|
||||
set_property IOB TRUE [get_ports {adc_dat_i[*][*]}]
|
||||
|
||||
# ADC 0 data
|
||||
set_property PACKAGE_PIN Y17 [get_ports {adc_dat_i[0][0]}]
|
||||
set_property PACKAGE_PIN Y16 [get_ports {adc_dat_i[0][1]}]
|
||||
set_property PACKAGE_PIN W14 [get_ports {adc_dat_i[0][2]}]
|
||||
set_property PACKAGE_PIN Y14 [get_ports {adc_dat_i[0][3]}]
|
||||
set_property PACKAGE_PIN V12 [get_ports {adc_dat_i[0][4]}]
|
||||
set_property PACKAGE_PIN W13 [get_ports {adc_dat_i[0][5]}]
|
||||
set_property PACKAGE_PIN V13 [get_ports {adc_dat_i[0][6]}]
|
||||
|
||||
# ADC 1 data
|
||||
set_property PACKAGE_PIN W15 [get_ports {adc_dat_i[1][0]}]
|
||||
set_property PACKAGE_PIN W16 [get_ports {adc_dat_i[1][1]}]
|
||||
set_property PACKAGE_PIN V15 [get_ports {adc_dat_i[1][2]}]
|
||||
set_property PACKAGE_PIN V16 [get_ports {adc_dat_i[1][3]}]
|
||||
set_property PACKAGE_PIN Y19 [get_ports {adc_dat_i[1][4]}]
|
||||
set_property PACKAGE_PIN W18 [get_ports {adc_dat_i[1][5]}]
|
||||
set_property PACKAGE_PIN Y18 [get_ports {adc_dat_i[1][6]}]
|
||||
|
||||
# ADC 2 data
|
||||
set_property PACKAGE_PIN W20 [get_ports {adc_dat_i[2][0]}]
|
||||
set_property PACKAGE_PIN W19 [get_ports {adc_dat_i[2][1]}]
|
||||
set_property PACKAGE_PIN V17 [get_ports {adc_dat_i[2][2]}]
|
||||
set_property PACKAGE_PIN V18 [get_ports {adc_dat_i[2][3]}]
|
||||
set_property PACKAGE_PIN U17 [get_ports {adc_dat_i[2][4]}]
|
||||
set_property PACKAGE_PIN T16 [get_ports {adc_dat_i[2][5]}]
|
||||
set_property PACKAGE_PIN T17 [get_ports {adc_dat_i[2][6]}]
|
||||
|
||||
# ADC 3 data
|
||||
set_property PACKAGE_PIN R19 [get_ports {adc_dat_i[3][0]}]
|
||||
set_property PACKAGE_PIN R17 [get_ports {adc_dat_i[3][1]}]
|
||||
set_property PACKAGE_PIN T15 [get_ports {adc_dat_i[3][2]}]
|
||||
set_property PACKAGE_PIN R16 [get_ports {adc_dat_i[3][3]}]
|
||||
set_property PACKAGE_PIN T20 [get_ports {adc_dat_i[3][4]}]
|
||||
set_property PACKAGE_PIN U20 [get_ports {adc_dat_i[3][5]}]
|
||||
set_property PACKAGE_PIN V20 [get_ports {adc_dat_i[3][6]}]
|
||||
|
||||
set_property IOSTANDARD DIFF_HSTL_I_18 [get_ports {adc_clk_i[*][*]}]
|
||||
|
||||
set_property PACKAGE_PIN U18 [get_ports {adc_clk_i[0][1]}]
|
||||
set_property PACKAGE_PIN U19 [get_ports {adc_clk_i[0][0]}]
|
||||
set_property PACKAGE_PIN N20 [get_ports {adc_clk_i[1][1]}]
|
||||
set_property PACKAGE_PIN P20 [get_ports {adc_clk_i[1][0]}]
|
||||
|
||||
# Output ADC clock
|
||||
# set_property IOSTANDARD LVCMOS18 [get_ports {adc_clk_o[*]}]
|
||||
# set_property SLEW FAST [get_ports {adc_clk_o[*]}]
|
||||
# set_property DRIVE 8 [get_ports {adc_clk_o[*]}]
|
||||
# #set_property IOB TRUE [get_ports {adc_clk_o[*]}]
|
||||
|
||||
# set_property PACKAGE_PIN N20 [get_ports {adc_clk_o[0]}]
|
||||
# set_property PACKAGE_PIN P20 [get_ports {adc_clk_o[1]}]
|
||||
|
||||
# SPI interface
|
||||
set_property IOSTANDARD LVCMOS18 [get_ports spi_*_o]
|
||||
set_property SLEW FAST [get_ports spi_*_o]
|
||||
set_property DRIVE 8 [get_ports spi_*_o]
|
||||
|
||||
set_property PACKAGE_PIN P15 [get_ports spi_csa_o]
|
||||
set_property PACKAGE_PIN P16 [get_ports spi_csb_o]
|
||||
set_property PACKAGE_PIN P18 [get_ports spi_clk_o]
|
||||
set_property PACKAGE_PIN N17 [get_ports spi_mosi_o]
|
||||
|
||||
### PWM DAC
|
||||
set_property IOSTANDARD LVCMOS18 [get_ports {dac_pwm_o[*]}]
|
||||
set_property SLEW FAST [get_ports {dac_pwm_o[*]}]
|
||||
set_property DRIVE 12 [get_ports {dac_pwm_o[*]}]
|
||||
set_property IOB TRUE [get_ports {dac_pwm_o[*]}]
|
||||
|
||||
set_property PACKAGE_PIN T10 [get_ports {dac_pwm_o[0]}]
|
||||
set_property PACKAGE_PIN T11 [get_ports {dac_pwm_o[1]}]
|
||||
set_property PACKAGE_PIN T19 [get_ports {dac_pwm_o[2]}]
|
||||
set_property PACKAGE_PIN T14 [get_ports {dac_pwm_o[3]}]
|
||||
|
||||
### XADC
|
||||
#set_property IOSTANDARD LVCMOS33 [get_ports {vinp_i[*]}]
|
||||
#set_property IOSTANDARD LVCMOS33 [get_ports {vinn_i[*]}]
|
||||
##AD0
|
||||
#set_property PACKAGE_PIN C20 [get_ports {vinp_i[1]}]
|
||||
#set_property PACKAGE_PIN B20 [get_ports {vinn_i[1]}]
|
||||
##AD1
|
||||
#set_property PACKAGE_PIN E17 [get_ports {vinp_i[2]}]
|
||||
#set_property PACKAGE_PIN D18 [get_ports {vinn_i[2]}]
|
||||
##AD8
|
||||
#set_property PACKAGE_PIN B19 [get_ports {vinp_i[0]}]
|
||||
#set_property PACKAGE_PIN A20 [get_ports {vinn_i[0]}]
|
||||
##AD9
|
||||
#set_property PACKAGE_PIN E18 [get_ports {vinp_i[3]}]
|
||||
#set_property PACKAGE_PIN E19 [get_ports {vinn_i[3]}]
|
||||
##V_0
|
||||
#set_property PACKAGE_PIN K9 [get_ports {vinp_i[4]}]
|
||||
#set_property PACKAGE_PIN L10 [get_ports {vinn_i[4]}]
|
||||
|
||||
### Expansion connector
|
||||
set_property IOSTANDARD LVCMOS33 [get_ports {exp_p_io[*]}]
|
||||
set_property IOSTANDARD LVCMOS33 [get_ports {exp_n_io[*]}]
|
||||
set_property SLEW FAST [get_ports {exp_p_io[*]}]
|
||||
set_property SLEW FAST [get_ports {exp_n_io[*]}]
|
||||
set_property DRIVE 8 [get_ports {exp_p_io[*]}]
|
||||
set_property DRIVE 8 [get_ports {exp_n_io[*]}]
|
||||
|
||||
set_property PACKAGE_PIN G17 [get_ports {exp_p_io[0]}]
|
||||
set_property PACKAGE_PIN G18 [get_ports {exp_n_io[0]}]
|
||||
set_property PACKAGE_PIN H16 [get_ports {exp_p_io[1]}]
|
||||
set_property PACKAGE_PIN H17 [get_ports {exp_n_io[1]}]
|
||||
set_property PACKAGE_PIN J18 [get_ports {exp_p_io[2]}]
|
||||
set_property PACKAGE_PIN H18 [get_ports {exp_n_io[2]}]
|
||||
set_property PACKAGE_PIN K17 [get_ports {exp_p_io[3]}]
|
||||
set_property PACKAGE_PIN K18 [get_ports {exp_n_io[3]}]
|
||||
set_property PACKAGE_PIN L14 [get_ports {exp_p_io[4]}]
|
||||
set_property PACKAGE_PIN L15 [get_ports {exp_n_io[4]}]
|
||||
set_property PACKAGE_PIN L16 [get_ports {exp_p_io[5]}]
|
||||
set_property PACKAGE_PIN L17 [get_ports {exp_n_io[5]}]
|
||||
set_property PACKAGE_PIN K16 [get_ports {exp_p_io[6]}]
|
||||
set_property PACKAGE_PIN J16 [get_ports {exp_n_io[6]}]
|
||||
set_property PACKAGE_PIN M14 [get_ports {exp_p_io[7]}]
|
||||
set_property PACKAGE_PIN M15 [get_ports {exp_n_io[7]}]
|
||||
set_property PACKAGE_PIN Y9 [get_ports {exp_p_io[8]}]
|
||||
set_property PACKAGE_PIN Y8 [get_ports {exp_n_io[8]}]
|
||||
set_property PACKAGE_PIN Y12 [get_ports {exp_p_io[9]}]
|
||||
set_property PACKAGE_PIN Y13 [get_ports {exp_n_io[9]}]
|
||||
set_property PACKAGE_PIN Y7 [get_ports {exp_p_io[10]}]
|
||||
set_property PACKAGE_PIN Y6 [get_ports {exp_n_io[10]}]
|
||||
|
||||
# Pull down digital inputs.
|
||||
set_property PULLDOWN TRUE [get_ports {exp_p_io[0]}]
|
||||
set_property PULLDOWN TRUE [get_ports {exp_p_io[1]}]
|
||||
set_property PULLDOWN TRUE [get_ports {exp_p_io[2]}]
|
||||
set_property PULLDOWN TRUE [get_ports {exp_p_io[3]}]
|
||||
|
||||
### PLL
|
||||
#set_property IOSTANDARD LVCMOS33 [get_ports pll_*]
|
||||
#set_property PACKAGE_PIN J15 [get_ports pll_hi_o]
|
||||
#set_property PACKAGE_PIN K14 [get_ports pll_lo_o]
|
||||
|
||||
### SATA connector
|
||||
#set_property IOSTANDARD DIFF_HSTL_I_18 [get_ports {daisy_p_o[*]}]
|
||||
#set_property IOSTANDARD DIFF_HSTL_I_18 [get_ports {daisy_n_o[*]}]
|
||||
#set_property IOSTANDARD DIFF_HSTL_I_18 [get_ports {daisy_p_i[*]}]
|
||||
#set_property IOSTANDARD DIFF_HSTL_I_18 [get_ports {daisy_n_i[*]}]
|
||||
#
|
||||
#set_property PACKAGE_PIN T12 [get_ports {daisy_p_o[0]}]
|
||||
#set_property PACKAGE_PIN U12 [get_ports {daisy_n_o[0]}]
|
||||
#set_property PACKAGE_PIN U14 [get_ports {daisy_p_o[1]}]
|
||||
#set_property PACKAGE_PIN U15 [get_ports {daisy_n_o[1]}]
|
||||
#set_property PACKAGE_PIN P14 [get_ports {daisy_p_i[0]}]
|
||||
#set_property PACKAGE_PIN R14 [get_ports {daisy_n_i[0]}]
|
||||
#set_property PACKAGE_PIN N18 [get_ports {daisy_p_i[1]}]
|
||||
#set_property PACKAGE_PIN P19 [get_ports {daisy_n_i[1]}]
|
||||
|
||||
### LED
|
||||
set_property IOSTANDARD LVCMOS33 [get_ports {led_o[*]}]
|
||||
set_property SLEW SLOW [get_ports {led_o[*]}]
|
||||
set_property DRIVE 4 [get_ports {led_o[*]}]
|
||||
|
||||
set_property PACKAGE_PIN F16 [get_ports {led_o[0]}]
|
||||
set_property PACKAGE_PIN F17 [get_ports {led_o[1]}]
|
||||
set_property PACKAGE_PIN G19 [get_ports {led_o[2]}]
|
||||
set_property PACKAGE_PIN G15 [get_ports {led_o[3]}]
|
||||
set_property PACKAGE_PIN G14 [get_ports {led_o[4]}]
|
||||
set_property PACKAGE_PIN F20 [get_ports {led_o[5]}]
|
||||
set_property PACKAGE_PIN G20 [get_ports {led_o[6]}]
|
||||
set_property PACKAGE_PIN H20 [get_ports {led_o[7]}]
|
||||
|
||||
############################################################################
|
||||
# Clock constraints #
|
||||
############################################################################
|
||||
|
||||
#NET "adc_clk" TNM_NET = "adc_clk";
|
||||
#TIMESPEC TS_adc_clk = PERIOD "adc_clk" 125 MHz;
|
||||
|
||||
|
||||
create_clock -period 8.000 -name adc_clk_01 [get_ports {adc_clk_i[0][1]}]
|
||||
create_clock -period 8.000 -name adc_clk_23 [get_ports {adc_clk_i[1][1]}]
|
||||
create_clock -period 4.000 -name rx_clk [get_ports {daisy_p_i[1]}]
|
||||
|
||||
# Add clock uncertainty for robust timing.
|
||||
set_clock_uncertainty 0.2 [get_clocks adc_clk_01]
|
||||
set_clock_uncertainty 0.2 [get_clocks adc_clk_23]
|
||||
|
||||
# ADC data input timing.
|
||||
# The LTC2145 datasheet says CLKOUT-to-DATA = minimum 0, maximum 0.6 ns.
|
||||
# We add 0.1 ns margin.
|
||||
set_input_delay -clock adc_clk_01 -min -0.1 [get_ports {adc_dat_i[0][*] adc_dat_i[1][*]}]
|
||||
set_input_delay -clock adc_clk_01 -max 0.7 [get_ports {adc_dat_i[0][*] adc_dat_i[1][*]}]
|
||||
set_input_delay -clock adc_clk_23 -min -0.1 [get_ports {adc_dat_i[2][*] adc_dat_i[3][*]}]
|
||||
set_input_delay -clock adc_clk_23 -max 0.7 [get_ports {adc_dat_i[2][*] adc_dat_i[3][*]}]
|
||||
|
||||
# The two ADC clocks may not be perfectly aligned.
|
||||
# Specify max delay on inter-clock paths to deal with this.
|
||||
set_min_delay -from [get_clocks adc_clk_23] -to [get_clocks adc_clk_01] 1.6
|
||||
set_max_delay -from [get_clocks adc_clk_23] -to [get_clocks adc_clk_01] 6.4
|
||||
|
||||
# Digital inputs are asynchronous and captured in IOB flipflops.
|
||||
# Declare false path to avoid warning for unconstrained path.
|
||||
set_false_path -from [get_ports {exp_p_io[*]}]
|
||||
|
||||
# Delay to LEDs does not matter; just set a long max delay.
|
||||
set_max_delay -to [get_ports {led_o[*]}] 20.0
|
||||
|
||||
#set_false_path -from [get_clocks par_clk] -to [get_clocks pll_adc_clk_0]
|
||||
#set_false_path -from [get_clocks pll_adc_clk_0] -to [get_clocks par_clk]
|
||||
#set_false_path -from [get_clocks clk_fpga_0] -to [get_clocks adc_clk_01]
|
||||
#set_false_path -from [get_clocks clk_fpga_0] -to [get_clocks adc_clk_23]
|
||||
#set_false_path -from [get_clocks adc_clk_01] -to [get_clocks pll_ser_clk]
|
||||
#set_false_path -from [get_clocks clk_fpga_0] -to [get_clocks par_clk]
|
||||
#set_false_path -from [get_clocks clk_fpga_0] -to [get_clocks pll_adc_clk_0]
|
||||
#set_false_path -from [get_clocks pll_adc_clk_0] -to [get_clocks clk_fpga_0]
|
||||
#set_false_path -from [get_clocks pll_adc_clk_0] -to [get_clocks pll_adc_10mhz]
|
||||
#set_false_path -from [get_clocks pll_adc_10mhz] -to [get_clocks pll_adc_clk_0]
|
||||
#set_false_path -from [get_clocks adc_clk_23] -to [get_clocks pll_adc_clk_0]
|
||||
|
||||
############################################################################
|
||||
# Bit file settings #
|
||||
############################################################################
|
||||
|
||||
set_property BITSTREAM.GENERAL.COMPRESS TRUE [current_design]
|
||||
|
|
@ -141,7 +141,7 @@ begin
|
|||
|
||||
-- Latch second sample data word.
|
||||
if (num_channels > 2) and (sample_valid = '1') then
|
||||
v.sample_pending := '1';
|
||||
v.sample_pending := ch4_mode;
|
||||
v.sample_data := sample_data(2 to num_channels - 1);
|
||||
end if;
|
||||
|
||||
|
|
|
@ -0,0 +1,118 @@
|
|||
--
|
||||
-- Capture ADC sample data from FPGA input ports.
|
||||
--
|
||||
-- The ADC sends one 14-bit sample per clock cycle.
|
||||
-- These 14 bits are transferred through 7 DDR signals.
|
||||
--
|
||||
-- Joris van Rantwijk 2024
|
||||
--
|
||||
|
||||
library ieee;
|
||||
use ieee.std_logic_1164.all;
|
||||
use ieee.numeric_std.all;
|
||||
|
||||
library unisim;
|
||||
use unisim.vcomponents.all;
|
||||
|
||||
use work.puzzlefw_pkg.all;
|
||||
|
||||
|
||||
entity adc_capture_ddr is
|
||||
|
||||
port (
|
||||
-- Source-synchronous clock for capturing data.
|
||||
clk_capture: in std_logic;
|
||||
|
||||
-- Clock for intermediate register stage.
|
||||
clk_intermediate: in std_logic;
|
||||
|
||||
-- System clock for data output.
|
||||
-- This clock is approximately phase aligned with the capture clock.
|
||||
clk_handoff: in std_logic;
|
||||
|
||||
-- Input signals, DDR.
|
||||
in_data: in std_logic_vector(6 downto 0);
|
||||
|
||||
-- Output sample stream.
|
||||
-- Produces one new ADC sample per clock cycle.
|
||||
out_data: out adc_data_type
|
||||
);
|
||||
|
||||
end entity;
|
||||
|
||||
architecture arch of adc_capture_ddr is
|
||||
|
||||
signal s_data_delayed: std_logic_vector(6 downto 0);
|
||||
signal s_data_iddr: std_logic_vector(adc_data_bits - 1 downto 0);
|
||||
signal s_data_staged: std_logic_vector(adc_data_bits - 1 downto 0);
|
||||
signal r_out_data: std_logic_vector(adc_data_bits - 1 downto 0);
|
||||
|
||||
begin
|
||||
|
||||
gen_bit_capture: for i in 0 to 6 generate
|
||||
|
||||
-- Delay input signal.
|
||||
-- Delay by 30 / (32 * 2 * 200 MHz) = 2.34 ns.
|
||||
inst_idelay: IDELAYE2
|
||||
generic map (
|
||||
DELAY_SRC => "IDATAIN",
|
||||
HIGH_PERFORMANCE_MODE => "FALSE",
|
||||
IDELAY_TYPE => "FIXED",
|
||||
IDELAY_VALUE => 30,
|
||||
REFCLK_FREQUENCY => 200.0,
|
||||
SIGNAL_PATTERN => "DATA" )
|
||||
port map (
|
||||
CNTVALUEOUT => open,
|
||||
DATAOUT => s_data_delayed(i),
|
||||
C => '0',
|
||||
CE => '0',
|
||||
CINVCTRL => '0',
|
||||
CNTVALUEIN => (others => '0'),
|
||||
DATAIN => '0',
|
||||
IDATAIN => in_data(i),
|
||||
INC => '0',
|
||||
LD => '0',
|
||||
LDPIPEEN => '0',
|
||||
REGRST => '0' );
|
||||
|
||||
-- DDR input register.
|
||||
inst_iddr: IDDR
|
||||
generic map (
|
||||
DDR_CLK_EDGE => "SAME_EDGE_PIPELINED" )
|
||||
port map (
|
||||
Q1 => s_data_iddr(2*i),
|
||||
Q2 => s_data_iddr(2*i+1),
|
||||
C => clk_capture,
|
||||
CE => '1',
|
||||
D => s_data_delayed(i),
|
||||
R => '0',
|
||||
S => '0' );
|
||||
|
||||
end generate;
|
||||
|
||||
--
|
||||
-- Re-capture samples on intermediate clock.
|
||||
--
|
||||
gen_ffpair: for i in 0 to adc_data_bits - 1 generate
|
||||
inst_ffpair: entity work.ffpair
|
||||
port map (
|
||||
clk1 => clk_capture,
|
||||
clk2 => clk_intermediate,
|
||||
di => s_data_iddr(i),
|
||||
do => s_data_staged(i) );
|
||||
end generate;
|
||||
|
||||
--
|
||||
-- Re-capture samples on system clock.
|
||||
--
|
||||
process (clk_handoff) is
|
||||
begin
|
||||
if rising_edge(clk_handoff) then
|
||||
r_out_data <= s_data_staged;
|
||||
end if;
|
||||
end process;
|
||||
|
||||
-- Drive output ports.
|
||||
out_data <= r_out_data;
|
||||
|
||||
end architecture;
|
|
@ -0,0 +1,51 @@
|
|||
--
|
||||
-- Pair of flip-flops located in adjacent slices.
|
||||
--
|
||||
|
||||
library ieee;
|
||||
use ieee.std_logic_1164.all;
|
||||
|
||||
entity ffpair is
|
||||
|
||||
port (
|
||||
-- Clocks.
|
||||
clk1: in std_logic;
|
||||
clk2: in std_logic;
|
||||
|
||||
-- Input data, synchronous to "clk1".
|
||||
di: in std_logic;
|
||||
|
||||
-- Output data, synchronous to "clk2";
|
||||
do: out std_logic
|
||||
);
|
||||
|
||||
end entity;
|
||||
|
||||
architecture rtl of ffpair is
|
||||
|
||||
signal reg1: std_logic;
|
||||
signal reg2: std_logic;
|
||||
|
||||
attribute RLOC: string;
|
||||
attribute RLOC of reg1: signal is "X0Y0";
|
||||
attribute RLOC of reg2: signal is "X1Y0";
|
||||
|
||||
begin
|
||||
|
||||
process (clk1) is
|
||||
begin
|
||||
if rising_edge(clk1) then
|
||||
reg1 <= di;
|
||||
end if;
|
||||
end process;
|
||||
|
||||
process (clk2) is
|
||||
begin
|
||||
if rising_edge(clk2) then
|
||||
reg2 <= reg1;
|
||||
end if;
|
||||
end process;
|
||||
|
||||
do <= reg2;
|
||||
|
||||
end architecture;
|
|
@ -38,6 +38,8 @@ package puzzlefw_pkg is
|
|||
|
||||
-- ADC input port type.
|
||||
type adc_data_input_type is array(0 to 1) of std_logic_vector(15 downto 0);
|
||||
type adc_data_input_type_4ch is array(0 to 3) of std_logic_vector(6 downto 0);
|
||||
type adc_clock_input_type_4ch is array(0 to 1) of std_logic_vector(1 downto 0);
|
||||
|
||||
-- Register addresses.
|
||||
constant reg_addr_mask: std_logic_vector(31 downto 0) := x"0010fffc";
|
||||
|
@ -94,7 +96,7 @@ package puzzlefw_pkg is
|
|||
-- Firmware info word.
|
||||
constant fw_api_version: natural := 1;
|
||||
constant fw_version_major: natural := 0;
|
||||
constant fw_version_minor: natural := 12;
|
||||
constant fw_version_minor: natural := 16;
|
||||
constant fw_info_word: std_logic_vector(31 downto 0) :=
|
||||
x"4a"
|
||||
& std_logic_vector(to_unsigned(fw_api_version, 8))
|
||||
|
|
|
@ -21,7 +21,6 @@ use work.puzzlefw_pkg.all;
|
|||
entity puzzlefw_top is
|
||||
|
||||
port (
|
||||
|
||||
-- Ports directly connected to ARM/PS.
|
||||
DDR_0_addr: inout std_logic_vector(14 downto 0);
|
||||
DDR_0_ba: inout std_logic_vector(2 downto 0);
|
||||
|
@ -583,19 +582,24 @@ begin
|
|||
out_data => s_acq_dma_data );
|
||||
|
||||
-- Capture digital inputs.
|
||||
s_dig_in(0) <= exp_p_io(0);
|
||||
s_dig_in(1) <= exp_n_io(0);
|
||||
s_dig_in(2) <= exp_p_io(1);
|
||||
s_dig_in(3) <= exp_n_io(1);
|
||||
s_dig_in <= exp_p_io(3 downto 0);
|
||||
|
||||
inst_dig_capture_gen: for i in 0 to 3 generate
|
||||
|
||||
-- Use a 2-flipflop synchronizer to avoid metastability.
|
||||
inst_dig_sync: entity work.syncdff
|
||||
-- Use IDDR to capture digital input.
|
||||
-- The IDDR is used in pipeline mode; this inserts a secondary flip-flop
|
||||
-- in the data path which helps to suppress metastability.
|
||||
inst_dig_iddr: IDDR
|
||||
generic map (
|
||||
DDR_CLK_EDGE => "SAME_EDGE_PIPELINED" )
|
||||
port map (
|
||||
clk => clk_adc,
|
||||
di => s_dig_in(i),
|
||||
do => s_dig_sync(i) );
|
||||
Q1 => s_dig_sync(i),
|
||||
Q2 => open,
|
||||
C => clk_adc,
|
||||
CE => '1',
|
||||
D => s_dig_in(i),
|
||||
R => '0',
|
||||
S => '0' );
|
||||
|
||||
-- Deglitch filter.
|
||||
inst_dig_deglitch: entity work.deglitch
|
||||
|
|
|
@ -0,0 +1,714 @@
|
|||
--
|
||||
-- Top-level FPGA design for Red Pitaya PuzzleFW firmware,
|
||||
-- variant for 4 input channels.
|
||||
--
|
||||
-- Joris van Rantwijk 2024
|
||||
--
|
||||
|
||||
library ieee;
|
||||
use ieee.std_logic_1164.all;
|
||||
use ieee.std_logic_misc.all;
|
||||
use ieee.numeric_std.all;
|
||||
|
||||
library unisim;
|
||||
use unisim.vcomponents.all;
|
||||
|
||||
library xpm;
|
||||
use xpm.vcomponents.all;
|
||||
|
||||
use work.puzzlefw_pkg.all;
|
||||
|
||||
|
||||
entity puzzlefw_top_4ch is
|
||||
|
||||
port (
|
||||
-- Ports directly connected to ARM/PS.
|
||||
DDR_0_addr: inout std_logic_vector(14 downto 0);
|
||||
DDR_0_ba: inout std_logic_vector(2 downto 0);
|
||||
DDR_0_cas_n: inout std_logic;
|
||||
DDR_0_ck_n: inout std_logic;
|
||||
DDR_0_ck_p: inout std_logic;
|
||||
DDR_0_cke: inout std_logic;
|
||||
DDR_0_cs_n: inout std_logic;
|
||||
DDR_0_dm: inout std_logic_vector(3 downto 0);
|
||||
DDR_0_dq: inout std_logic_vector(31 downto 0);
|
||||
DDR_0_dqs_n: inout std_logic_vector(3 downto 0);
|
||||
DDR_0_dqs_p: inout std_logic_vector(3 downto 0);
|
||||
DDR_0_odt: inout std_logic;
|
||||
DDR_0_ras_n: inout std_logic;
|
||||
DDR_0_reset_n: inout std_logic;
|
||||
DDR_0_we_n: inout std_logic;
|
||||
FIXED_IO_0_ddr_vrn: inout std_logic;
|
||||
FIXED_IO_0_ddr_vrp: inout std_logic;
|
||||
FIXED_IO_0_mio: inout std_logic_vector(53 downto 0);
|
||||
FIXED_IO_0_ps_clk: inout std_logic;
|
||||
FIXED_IO_0_ps_porb: inout std_logic;
|
||||
FIXED_IO_0_ps_srstb: inout std_logic;
|
||||
|
||||
-- Ports controlled by FPGA.
|
||||
adc_dat_i: in adc_data_input_type_4ch; -- ADC data
|
||||
adc_clk_i: in adc_clock_input_type_4ch; -- ADC clock 1=pos, 0=neg
|
||||
spi_csa_o: out std_logic; -- SPI interface to ADC
|
||||
spi_csb_o: out std_logic;
|
||||
spi_clk_o: out std_logic;
|
||||
spi_mosi_o: out std_logic;
|
||||
dac_pwm_o: out std_logic_vector(3 downto 0); -- PWM DAC
|
||||
exp_p_io: inout std_logic_vector(10 downto 0); -- extension I/O pos
|
||||
exp_n_io: inout std_logic_vector(10 downto 0); -- extension I/O neg
|
||||
led_o: out std_logic_vector(7 downto 0) -- LEDs
|
||||
);
|
||||
|
||||
end puzzlefw_top_4ch;
|
||||
|
||||
architecture arch of puzzlefw_top_4ch is
|
||||
|
||||
-- Main 125 MHz clock, derived from ADC A clock input port.
|
||||
signal clk_adc: std_logic;
|
||||
|
||||
-- Auxiliary clock from FCLK0.
|
||||
signal clk_fclk200: std_logic;
|
||||
|
||||
-- Reset signals.
|
||||
signal s_ext_reset_n: std_logic; -- reset signal from GPIO, active low
|
||||
signal s_pll_reset: std_logic; -- reset signal for PLL
|
||||
signal s_pll_locked: std_logic; -- PLL locked status
|
||||
signal s_reset: std_logic; -- main reset, synchronized to clk_adc
|
||||
signal r_reset_done: std_logic; -- reset status report via GPIO
|
||||
|
||||
-- Internal clock signals.
|
||||
signal s_adc_clk_ibuf: std_logic_vector(1 downto 0);
|
||||
signal clk_adc_capture: std_logic_vector(1 downto 0);
|
||||
signal s_pll_clkfbout: std_logic;
|
||||
signal s_pll_clkfbin: std_logic;
|
||||
signal s_pll_clkout: std_logic;
|
||||
|
||||
-- Blinking LED.
|
||||
signal r_adcclk_cnt: unsigned(25 downto 0);
|
||||
signal r_adcclk_led: std_logic;
|
||||
|
||||
-- Internal GPIO and SPI signals from PS.
|
||||
signal s_gpio_in: std_logic_vector(23 downto 0);
|
||||
signal s_gpio_out: std_logic_vector(23 downto 0);
|
||||
signal s_spi_sclk_o: std_logic;
|
||||
signal s_spi_sclk_t: std_logic;
|
||||
signal s_spi_mosi_o: std_logic;
|
||||
signal s_spi_mosi_t: std_logic;
|
||||
signal s_spi_ss_o: std_logic_vector(1 downto 0);
|
||||
signal s_spi_ss_t: std_logic;
|
||||
|
||||
-- APB bus for register access.
|
||||
signal s_apb_paddr: std_logic_vector(31 downto 0);
|
||||
signal s_apb_penable: std_logic;
|
||||
signal s_apb_prdata: std_logic_vector(31 downto 0);
|
||||
signal s_apb_pready: std_logic;
|
||||
signal s_apb_psel: std_logic;
|
||||
signal s_apb_pslverr: std_logic;
|
||||
signal s_apb_pwdata: std_logic_vector(31 downto 0);
|
||||
signal s_apb_pwrite: std_logic;
|
||||
|
||||
-- AXI bus for DMA.
|
||||
signal s_axi_awid: std_logic_vector(5 downto 0);
|
||||
signal s_axi_awaddr: std_logic_vector(31 downto 0);
|
||||
signal s_axi_awlen: std_logic_vector(3 downto 0);
|
||||
signal s_axi_awsize: std_logic_vector(2 downto 0);
|
||||
signal s_axi_awburst: std_logic_vector(1 downto 0);
|
||||
signal s_axi_awlock: std_logic_vector(1 downto 0);
|
||||
signal s_axi_awcache: std_logic_vector(3 downto 0);
|
||||
signal s_axi_awprot: std_logic_vector(2 downto 0);
|
||||
signal s_axi_awqos: std_logic_vector(3 downto 0);
|
||||
signal s_axi_awvalid: std_logic;
|
||||
signal s_axi_awready: std_logic;
|
||||
signal s_axi_wid: std_logic_vector(5 downto 0);
|
||||
signal s_axi_wdata: std_logic_vector(63 downto 0);
|
||||
signal s_axi_wstrb: std_logic_vector(7 downto 0);
|
||||
signal s_axi_wlast: std_logic;
|
||||
signal s_axi_wvalid: std_logic;
|
||||
signal s_axi_wready: std_logic;
|
||||
signal s_axi_bid: std_logic_vector(5 downto 0);
|
||||
signal s_axi_bresp: std_logic_vector(1 downto 0);
|
||||
signal s_axi_bvalid: std_logic;
|
||||
signal s_axi_bready: std_logic;
|
||||
signal s_axi_arid: std_logic_vector(5 downto 0);
|
||||
signal s_axi_araddr: std_logic_vector(31 downto 0);
|
||||
signal s_axi_arlen: std_logic_vector(3 downto 0);
|
||||
signal s_axi_arsize: std_logic_vector(2 downto 0);
|
||||
signal s_axi_arburst: std_logic_vector(1 downto 0);
|
||||
signal s_axi_arlock: std_logic_vector(1 downto 0);
|
||||
signal s_axi_arcache: std_logic_vector(3 downto 0);
|
||||
signal s_axi_arprot: std_logic_vector(2 downto 0);
|
||||
signal s_axi_arqos: std_logic_vector(3 downto 0);
|
||||
signal s_axi_arvalid: std_logic;
|
||||
signal s_axi_arready: std_logic;
|
||||
signal s_axi_rid: std_logic_vector(5 downto 0);
|
||||
signal s_axi_rdata: std_logic_vector(63 downto 0);
|
||||
signal s_axi_rresp: std_logic_vector(1 downto 0);
|
||||
signal s_axi_rlast: std_logic;
|
||||
signal s_axi_rvalid: std_logic;
|
||||
signal s_axi_rready: std_logic;
|
||||
|
||||
-- Interrupts.
|
||||
signal s_irq_pending: std_logic_vector(1 downto 0);
|
||||
signal s_irq_f2p: std_logic_vector(7 downto 0);
|
||||
|
||||
-- Registers.
|
||||
signal s_reg_control: registers_control;
|
||||
signal s_reg_status: registers_status;
|
||||
|
||||
-- DMA write channel control.
|
||||
signal s_dma_write_cmd_addr: dma_address_array(0 to 1);
|
||||
signal s_dma_write_cmd_length: dma_burst_length_array(0 to 1);
|
||||
signal s_dma_write_cmd_valid: std_logic_vector(1 downto 0);
|
||||
signal s_dma_write_cmd_ready: std_logic_vector(1 downto 0);
|
||||
signal s_dma_write_data: dma_data_array(0 to 1);
|
||||
signal s_dma_write_data_ready: std_logic_vector(1 downto 0);
|
||||
signal s_dma_write_finished: std_logic_vector(1 downto 0);
|
||||
|
||||
signal s_acq_dma_valid: std_logic;
|
||||
signal s_acq_dma_ready: std_logic;
|
||||
signal s_acq_dma_empty: std_logic;
|
||||
signal s_acq_dma_data: dma_data_type;
|
||||
|
||||
signal s_tt_dma_valid: std_logic;
|
||||
signal s_tt_dma_ready: std_logic;
|
||||
signal s_tt_dma_empty: std_logic;
|
||||
signal s_tt_dma_data: dma_data_type;
|
||||
|
||||
signal s_timestamp: std_logic_vector(timestamp_bits - 1 downto 0);
|
||||
signal s_adc_data: adc_data_array(0 to 3);
|
||||
signal s_adc_sample: adc_data_array(0 to 3);
|
||||
signal s_dig_in: std_logic_vector(3 downto 0);
|
||||
signal s_dig_sync: std_logic_vector(3 downto 0);
|
||||
signal s_dig_deglitch: std_logic_vector(3 downto 0);
|
||||
signal s_dig_sample: std_logic_vector(3 downto 0);
|
||||
|
||||
begin
|
||||
|
||||
-- Global FPGA reset.
|
||||
-- GPIO(0) = '0' to reset.
|
||||
s_ext_reset_n <= s_gpio_out(0);
|
||||
|
||||
-- GPIO inputs to the PS.
|
||||
-- GPIO(1) = '0' while in reset, '1' when reset released.
|
||||
s_gpio_in(1) <= r_reset_done;
|
||||
s_gpio_in(0) <= '0';
|
||||
s_gpio_in(23 downto 2) <= (others => '0');
|
||||
|
||||
-- Drive LEDs.
|
||||
led_o(0) <= r_adcclk_led; -- blinking LED, 1 Hz
|
||||
led_o(1) <= s_reg_control.acquisition_en; -- acquisition enabled
|
||||
led_o(2) <= s_reg_status.trig_waiting; -- waiting for trigger
|
||||
led_o(3) <= or_reduce(s_reg_control.timetagger_en); -- timetagger enabled
|
||||
led_o(7 downto 4) <= s_reg_control.led_state(7 downto 4);
|
||||
|
||||
-- Drive safe levels to unused DAC pins.
|
||||
dac_pwm_o <= (others => 'Z');
|
||||
|
||||
-- Use extension I/O pins as inputs only.
|
||||
exp_p_io <= (others => 'Z');
|
||||
exp_n_io <= (others => 'Z');
|
||||
|
||||
-- Drive SPI bus.
|
||||
inst_obuf_spi_clk: OBUFT
|
||||
port map (
|
||||
I => s_spi_sclk_o,
|
||||
T => s_spi_sclk_t,
|
||||
O => spi_clk_o );
|
||||
|
||||
inst_obuf_spi_mosi: OBUFT
|
||||
port map (
|
||||
I => s_spi_mosi_o,
|
||||
T => s_spi_mosi_t,
|
||||
O => spi_mosi_o );
|
||||
|
||||
inst_obuf_spi_csa: OBUFT
|
||||
port map (
|
||||
I => s_spi_ss_o(0),
|
||||
T => s_spi_ss_t,
|
||||
O => spi_csa_o );
|
||||
|
||||
inst_obuf_spi_csb: OBUFT
|
||||
port map (
|
||||
I => s_spi_ss_o(1),
|
||||
T => s_spi_ss_t,
|
||||
O => spi_csb_o );
|
||||
|
||||
-- Handle clock input and data input for each ADC.
|
||||
gen_adcin: for i in 0 to 1 generate
|
||||
|
||||
-- Differential clock input for ADC clock.
|
||||
inst_ibuf_adc_clk: IBUFDS
|
||||
port map (
|
||||
O => s_adc_clk_ibuf(i),
|
||||
I => adc_clk_i(i)(1),
|
||||
IB => adc_clk_i(i)(0) );
|
||||
|
||||
-- Clock buffer for ADC clock.
|
||||
-- BUFR is faster (lower propagation delay) than BUFG.
|
||||
inst_bufg_adc_clk: BUFR
|
||||
port map (
|
||||
I => s_adc_clk_ibuf(i),
|
||||
O => clk_adc_capture(i),
|
||||
CE => '1',
|
||||
CLR => '0' );
|
||||
|
||||
end generate;
|
||||
|
||||
-- PLL for 125 MHz clock.
|
||||
-- Input clock comes from ADC A.
|
||||
-- Output clock drives most of the FPGA design.
|
||||
inst_pll: PLLE2_BASE
|
||||
generic map (
|
||||
BANDWIDTH => "OPTIMIZED",
|
||||
CLKFBOUT_MULT => 8,
|
||||
CLKFBOUT_PHASE => 0.0,
|
||||
CLKIN1_PERIOD => 8.0,
|
||||
CLKOUT0_DIVIDE => 8,
|
||||
CLKOUT0_DUTY_CYCLE => 0.5,
|
||||
CLKOUT0_PHASE => 0.0,
|
||||
DIVCLK_DIVIDE => 1,
|
||||
STARTUP_WAIT => "FALSE" )
|
||||
port map (
|
||||
CLKOUT0 => s_pll_clkout,
|
||||
CLKFBOUT => s_pll_clkfbout,
|
||||
LOCKED => s_pll_locked,
|
||||
CLKIN1 => s_adc_clk_ibuf(0),
|
||||
PWRDWN => '0',
|
||||
RST => s_pll_reset,
|
||||
CLKFBIN => s_pll_clkfbin );
|
||||
|
||||
-- Reset PLL when external reset is applied.
|
||||
s_pll_reset <= not s_ext_reset_n;
|
||||
|
||||
-- Clock buffers for PLL.
|
||||
inst_bufg_pll_clkfb: BUFG
|
||||
port map (
|
||||
I => s_pll_clkfbout,
|
||||
O => s_pll_clkfbin );
|
||||
|
||||
inst_bufg_pll_clkout: BUFG
|
||||
port map (
|
||||
I => s_pll_clkout,
|
||||
O => clk_adc );
|
||||
|
||||
-- Since the design uses IDELAY, it must contain an IDELAYCTRL instance.
|
||||
inst_idelayctrl: IDELAYCTRL
|
||||
port map (
|
||||
RDY => open,
|
||||
REFCLK => clk_fclk200,
|
||||
RST => s_pll_reset );
|
||||
|
||||
-- ARM/PS block design.
|
||||
inst_blockdesign: entity work.puzzlefw_wrapper
|
||||
port map (
|
||||
sys_clk => clk_adc,
|
||||
ps_fclk => clk_fclk200,
|
||||
peripheral_reset_0(0) => s_reset,
|
||||
ext_reset_in_0 => s_ext_reset_n,
|
||||
dcm_locked_0 => s_pll_locked,
|
||||
DDR_0_addr => DDR_0_addr,
|
||||
DDR_0_ba => DDR_0_ba,
|
||||
DDR_0_cas_n => DDR_0_cas_n,
|
||||
DDR_0_ck_n => DDR_0_ck_n,
|
||||
DDR_0_ck_p => DDR_0_ck_p,
|
||||
DDR_0_cke => DDR_0_cke,
|
||||
DDR_0_cs_n => DDR_0_cs_n,
|
||||
DDR_0_dm => DDR_0_dm,
|
||||
DDR_0_dq => DDR_0_dq,
|
||||
DDR_0_dqs_n => DDR_0_dqs_n,
|
||||
DDR_0_dqs_p => DDR_0_dqs_p,
|
||||
DDR_0_odt => DDR_0_odt,
|
||||
DDR_0_ras_n => DDR_0_ras_n,
|
||||
DDR_0_reset_n => DDR_0_reset_n,
|
||||
DDR_0_we_n => DDR_0_we_n,
|
||||
FIXED_IO_0_ddr_vrn => FIXED_IO_0_ddr_vrn,
|
||||
FIXED_IO_0_ddr_vrp => FIXED_IO_0_ddr_vrp,
|
||||
FIXED_IO_0_mio => FIXED_IO_0_mio,
|
||||
FIXED_IO_0_ps_clk => FIXED_IO_0_ps_clk,
|
||||
FIXED_IO_0_ps_porb => FIXED_IO_0_ps_porb,
|
||||
FIXED_IO_0_ps_srstb => FIXED_IO_0_ps_srstb,
|
||||
GPIO_I_0 => s_gpio_in,
|
||||
GPIO_O_0 => s_gpio_out,
|
||||
SPI0_MOSI_O_0 => s_spi_mosi_o,
|
||||
SPI0_MOSI_T_0 => s_spi_mosi_t,
|
||||
SPI0_SCLK_O_0 => s_spi_sclk_o,
|
||||
SPI0_SCLK_T_0 => s_spi_sclk_t,
|
||||
SPI0_SS1_O_0 => s_spi_ss_o(1),
|
||||
SPI0_SS_O_0 => s_spi_ss_o(0),
|
||||
SPI0_SS_T_0 => s_spi_ss_t,
|
||||
IRQ_F2P => s_irq_f2p,
|
||||
APB_M_0_paddr => s_apb_paddr,
|
||||
APB_M_0_penable => s_apb_penable,
|
||||
APB_M_0_prdata => s_apb_prdata,
|
||||
APB_M_0_pready(0) => s_apb_pready,
|
||||
APB_M_0_psel(0) => s_apb_psel,
|
||||
APB_M_0_pslverr(0) => s_apb_pslverr,
|
||||
APB_M_0_pwdata => s_apb_pwdata,
|
||||
APB_M_0_pwrite => s_apb_pwrite,
|
||||
S_AXI_HP0_0_araddr => s_axi_araddr,
|
||||
S_AXI_HP0_0_arburst => s_axi_arburst,
|
||||
S_AXI_HP0_0_arcache => s_axi_arcache,
|
||||
S_AXI_HP0_0_arid => s_axi_arid,
|
||||
S_AXI_HP0_0_arlen => s_axi_arlen,
|
||||
S_AXI_HP0_0_arlock => s_axi_arlock,
|
||||
S_AXI_HP0_0_arprot => s_axi_arprot,
|
||||
S_AXI_HP0_0_arqos => s_axi_arqos,
|
||||
S_AXI_HP0_0_arready => s_axi_arready,
|
||||
S_AXI_HP0_0_arsize => s_axi_arsize,
|
||||
S_AXI_HP0_0_arvalid => s_axi_arvalid,
|
||||
S_AXI_HP0_0_awaddr => s_axi_awaddr,
|
||||
S_AXI_HP0_0_awburst => s_axi_awburst,
|
||||
S_AXI_HP0_0_awcache => s_axi_awcache,
|
||||
S_AXI_HP0_0_awid => s_axi_awid,
|
||||
S_AXI_HP0_0_awlen => s_axi_awlen,
|
||||
S_AXI_HP0_0_awlock => s_axi_awlock,
|
||||
S_AXI_HP0_0_awprot => s_axi_awprot,
|
||||
S_AXI_HP0_0_awqos => s_axi_awqos,
|
||||
S_AXI_HP0_0_awready => s_axi_awready,
|
||||
S_AXI_HP0_0_awsize => s_axi_awsize,
|
||||
S_AXI_HP0_0_awvalid => s_axi_awvalid,
|
||||
S_AXI_HP0_0_bid => s_axi_bid,
|
||||
S_AXI_HP0_0_bready => s_axi_bready,
|
||||
S_AXI_HP0_0_bresp => s_axi_bresp,
|
||||
S_AXI_HP0_0_bvalid => s_axi_bvalid,
|
||||
S_AXI_HP0_0_rdata => s_axi_rdata,
|
||||
S_AXI_HP0_0_rid => s_axi_rid,
|
||||
S_AXI_HP0_0_rlast => s_axi_rlast,
|
||||
S_AXI_HP0_0_rready => s_axi_rready,
|
||||
S_AXI_HP0_0_rresp => s_axi_rresp,
|
||||
S_AXI_HP0_0_rvalid => s_axi_rvalid,
|
||||
S_AXI_HP0_0_wdata => s_axi_wdata,
|
||||
S_AXI_HP0_0_wid => s_axi_wid,
|
||||
S_AXI_HP0_0_wlast => s_axi_wlast,
|
||||
S_AXI_HP0_0_wready => s_axi_wready,
|
||||
S_AXI_HP0_0_wstrb => s_axi_wstrb,
|
||||
S_AXI_HP0_0_wvalid => s_axi_wvalid
|
||||
);
|
||||
|
||||
-- Memory-mapped registers.
|
||||
inst_registers: entity work.registers
|
||||
generic map (
|
||||
num_acq_channels => 4 )
|
||||
port map (
|
||||
clk => clk_adc,
|
||||
reset => s_reset,
|
||||
apb_psel => s_apb_psel,
|
||||
apb_penable => s_apb_penable,
|
||||
apb_pwrite => s_apb_pwrite,
|
||||
apb_paddr => s_apb_paddr,
|
||||
apb_pwdata => s_apb_pwdata,
|
||||
apb_pready => s_apb_pready,
|
||||
apb_pslverr => s_apb_pslverr,
|
||||
apb_prdata => s_apb_prdata,
|
||||
reg_control => s_reg_control,
|
||||
reg_status => s_reg_status
|
||||
);
|
||||
|
||||
-- AXI master.
|
||||
inst_axi_master: entity work.dma_axi_master
|
||||
generic map (
|
||||
num_read_channels => 0,
|
||||
num_write_channels => 2 )
|
||||
port map (
|
||||
clk => clk_adc,
|
||||
reset => s_reset,
|
||||
dma_en => s_reg_control.dma_en,
|
||||
dma_busy => s_reg_status.dma_busy,
|
||||
window_base_addr => s_reg_control.dma_buf_addr,
|
||||
window_size => s_reg_control.dma_buf_size,
|
||||
err_read => s_reg_status.dma_err_read,
|
||||
err_write => s_reg_status.dma_err_write,
|
||||
err_address => s_reg_status.dma_err_address,
|
||||
err_any => s_reg_status.dma_err_any,
|
||||
clear_errors => s_reg_control.dma_clear,
|
||||
read_cmd_addr => (others => (others => '0')),
|
||||
read_cmd_length => (others => (others => '0')),
|
||||
read_cmd_valid => (others => '0'),
|
||||
read_cmd_ready => open,
|
||||
read_data => open,
|
||||
read_data_valid => open,
|
||||
write_cmd_addr => s_dma_write_cmd_addr,
|
||||
write_cmd_length => s_dma_write_cmd_length,
|
||||
write_cmd_valid => s_dma_write_cmd_valid,
|
||||
write_cmd_ready => s_dma_write_cmd_ready,
|
||||
write_data => s_dma_write_data,
|
||||
write_data_ready => s_dma_write_data_ready,
|
||||
write_finished => s_dma_write_finished,
|
||||
m_axi_awid => s_axi_awid,
|
||||
m_axi_awaddr => s_axi_awaddr,
|
||||
m_axi_awlen => s_axi_awlen,
|
||||
m_axi_awsize => s_axi_awsize,
|
||||
m_axi_awburst => s_axi_awburst,
|
||||
m_axi_awlock => s_axi_awlock,
|
||||
m_axi_awcache => s_axi_awcache,
|
||||
m_axi_awprot => s_axi_awprot,
|
||||
m_axi_awqos => s_axi_awqos,
|
||||
m_axi_awvalid => s_axi_awvalid,
|
||||
m_axi_awready => s_axi_awready,
|
||||
m_axi_wid => s_axi_wid,
|
||||
m_axi_wdata => s_axi_wdata,
|
||||
m_axi_wstrb => s_axi_wstrb,
|
||||
m_axi_wlast => s_axi_wlast,
|
||||
m_axi_wvalid => s_axi_wvalid,
|
||||
m_axi_wready => s_axi_wready,
|
||||
m_axi_bid => s_axi_bid,
|
||||
m_axi_bresp => s_axi_bresp,
|
||||
m_axi_bvalid => s_axi_bvalid,
|
||||
m_axi_bready => s_axi_bready,
|
||||
m_axi_arid => s_axi_arid,
|
||||
m_axi_araddr => s_axi_araddr,
|
||||
m_axi_arlen => s_axi_arlen,
|
||||
m_axi_arsize => s_axi_arsize,
|
||||
m_axi_arburst => s_axi_arburst,
|
||||
m_axi_arlock => s_axi_arlock,
|
||||
m_axi_arcache => s_axi_arcache,
|
||||
m_axi_arprot => s_axi_arprot,
|
||||
m_axi_arqos => s_axi_arqos,
|
||||
m_axi_arvalid => s_axi_arvalid,
|
||||
m_axi_arready => s_axi_arready,
|
||||
m_axi_rid => s_axi_rid,
|
||||
m_axi_rdata => s_axi_rdata,
|
||||
m_axi_rresp => s_axi_rresp,
|
||||
m_axi_rlast => s_axi_rlast,
|
||||
m_axi_rvalid => s_axi_rvalid,
|
||||
m_axi_rready => s_axi_rready
|
||||
);
|
||||
|
||||
-- DMA write channel for analog acquisition
|
||||
inst_acq_dma: entity work.dma_write_channel
|
||||
generic map (
|
||||
transfer_size_bits => 4,
|
||||
queue_size_bits => 15,
|
||||
idle_timeout => 256 )
|
||||
port map (
|
||||
clk => clk_adc,
|
||||
reset => s_reset,
|
||||
channel_en => s_reg_control.acq_dma_en,
|
||||
channel_busy => s_reg_status.acq_dma_busy,
|
||||
channel_init => s_reg_control.acq_dma_init,
|
||||
addr_start => s_reg_control.acq_addr_start,
|
||||
addr_end => s_reg_control.acq_addr_end,
|
||||
addr_limit => s_reg_control.acq_addr_limit,
|
||||
addr_interrupt => s_reg_control.acq_addr_intr,
|
||||
addr_pointer => s_reg_status.acq_addr_ptr,
|
||||
intr_en => s_reg_control.acq_intr_en,
|
||||
intr_clear => s_reg_control.acq_intr_clear,
|
||||
intr_out => s_irq_pending(0),
|
||||
in_valid => s_acq_dma_valid,
|
||||
in_ready => s_acq_dma_ready,
|
||||
in_empty => s_acq_dma_empty,
|
||||
in_data => s_acq_dma_data,
|
||||
write_cmd_addr => s_dma_write_cmd_addr(0),
|
||||
write_cmd_length => s_dma_write_cmd_length(0),
|
||||
write_cmd_valid => s_dma_write_cmd_valid(0),
|
||||
write_cmd_ready => s_dma_write_cmd_ready(0),
|
||||
write_data => s_dma_write_data(0),
|
||||
write_data_ready => s_dma_write_data_ready(0),
|
||||
write_finished => s_dma_write_finished(0) );
|
||||
|
||||
-- DMA write channel for time tagger
|
||||
inst_tt_dma: entity work.dma_write_channel
|
||||
generic map (
|
||||
transfer_size_bits => 4,
|
||||
queue_size_bits => 12,
|
||||
idle_timeout => 256 )
|
||||
port map (
|
||||
clk => clk_adc,
|
||||
reset => s_reset,
|
||||
channel_en => s_reg_control.tt_dma_en,
|
||||
channel_busy => s_reg_status.tt_dma_busy,
|
||||
channel_init => s_reg_control.tt_dma_init,
|
||||
addr_start => s_reg_control.tt_addr_start,
|
||||
addr_end => s_reg_control.tt_addr_end,
|
||||
addr_limit => s_reg_control.tt_addr_limit,
|
||||
addr_interrupt => s_reg_control.tt_addr_intr,
|
||||
addr_pointer => s_reg_status.tt_addr_ptr,
|
||||
intr_en => s_reg_control.tt_intr_en,
|
||||
intr_clear => s_reg_control.tt_intr_clear,
|
||||
intr_out => s_irq_pending(1),
|
||||
in_valid => s_tt_dma_valid,
|
||||
in_ready => s_tt_dma_ready,
|
||||
in_empty => s_tt_dma_empty,
|
||||
in_data => s_tt_dma_data,
|
||||
write_cmd_addr => s_dma_write_cmd_addr(1),
|
||||
write_cmd_length => s_dma_write_cmd_length(1),
|
||||
write_cmd_valid => s_dma_write_cmd_valid(1),
|
||||
write_cmd_ready => s_dma_write_cmd_ready(1),
|
||||
write_data => s_dma_write_data(1),
|
||||
write_data_ready => s_dma_write_data_ready(1),
|
||||
write_finished => s_dma_write_finished(1) );
|
||||
|
||||
-- Timestamp generator.
|
||||
inst_timestamp_gen: entity work.timestamp_gen
|
||||
port map (
|
||||
clk => clk_adc,
|
||||
reset => s_reset,
|
||||
clear => s_reg_control.timestamp_clear,
|
||||
timestamp => s_timestamp );
|
||||
|
||||
s_reg_status.timestamp <= s_timestamp;
|
||||
|
||||
-- Capture ADC data.
|
||||
-- ADC A handles channels 0 and 1.
|
||||
-- ADC B handles channels 2 and 3.
|
||||
-- Each channel receives one 14-bit sample per clock cycle.
|
||||
-- The 14 bits are transferred through 7 DDR signals.
|
||||
gen_adc_capture: for i in 0 to 3 generate
|
||||
inst_adc_capture: entity work.adc_capture_ddr
|
||||
port map (
|
||||
clk_capture => clk_adc_capture(i / 2),
|
||||
clk_intermediate => clk_adc_capture(0),
|
||||
clk_handoff => clk_adc,
|
||||
in_data => adc_dat_i(i),
|
||||
out_data => s_adc_data(i) );
|
||||
end generate;
|
||||
|
||||
-- Optionally generate simulated ADC samples.
|
||||
gen_adc_sample_stream: for i in 0 to 1 generate
|
||||
inst_adc_sample_stream: entity work.adc_sample_stream
|
||||
port map (
|
||||
clk => clk_adc,
|
||||
reset => s_reset,
|
||||
simulate => s_reg_control.simulate_adc,
|
||||
in_data => s_adc_data(2*i to 2*i+1),
|
||||
out_data => s_adc_sample(2*i to 2*i+1) );
|
||||
end generate;
|
||||
|
||||
-- Monitor range of ADC samples.
|
||||
inst_monitor_gen: for i in 0 to 3 generate
|
||||
inst_range_monitor: entity work.adc_range_monitor
|
||||
generic map (
|
||||
signed_data => false )
|
||||
port map (
|
||||
clk => clk_adc,
|
||||
reset => s_reset,
|
||||
clear => s_reg_control.adc_range_clear,
|
||||
in_data => s_adc_sample(i),
|
||||
min_value => s_reg_status.adc_min_value(i),
|
||||
max_value => s_reg_status.adc_max_value(i) );
|
||||
end generate;
|
||||
|
||||
-- Monitor current ADC sample value.
|
||||
s_reg_status.adc_sample <= s_adc_sample;
|
||||
|
||||
-- Analog acquisition data chain.
|
||||
inst_acquisition_chain: entity work.acquisition_chain
|
||||
generic map (
|
||||
num_channels => 4 )
|
||||
port map (
|
||||
clk => clk_adc,
|
||||
reset => s_reset,
|
||||
acquisition_en => s_reg_control.acquisition_en,
|
||||
trigger_delay => s_reg_control.trigger_delay,
|
||||
record_length => s_reg_control.record_length,
|
||||
decimation_factor => s_reg_control.decimation_factor,
|
||||
averaging => s_reg_control.averaging_en,
|
||||
shift_steps => s_reg_control.shift_steps,
|
||||
ch4_mode => s_reg_control.ch4_mode,
|
||||
trig_auto_en => s_reg_control.trig_auto_en,
|
||||
trig_ext_en => s_reg_control.trig_ext_en,
|
||||
trig_ext_once => s_reg_control.trig_ext_once,
|
||||
trig_force => s_reg_control.trig_force,
|
||||
trig_ext_select => s_reg_control.trig_ext_select,
|
||||
trig_ext_falling => s_reg_control.trig_ext_falling,
|
||||
timestamp_in => s_timestamp,
|
||||
adc_data_in => s_adc_sample,
|
||||
trig_ext_in => s_dig_sample,
|
||||
trig_waiting => s_reg_status.trig_waiting,
|
||||
trig_detected => s_reg_status.trig_detected,
|
||||
out_valid => s_acq_dma_valid,
|
||||
out_ready => s_acq_dma_ready,
|
||||
out_empty => s_acq_dma_empty,
|
||||
out_data => s_acq_dma_data );
|
||||
|
||||
-- Capture digital inputs.
|
||||
s_dig_in <= exp_p_io(3 downto 0);
|
||||
|
||||
inst_dig_capture_gen: for i in 0 to 3 generate
|
||||
|
||||
-- Use IDDR to capture digital input.
|
||||
-- The IDDR is used in pipeline mode; this inserts a secondary flip-flop
|
||||
-- in the data path which helps to suppress metastability.
|
||||
inst_dig_iddr: IDDR
|
||||
generic map (
|
||||
DDR_CLK_EDGE => "SAME_EDGE_PIPELINED" )
|
||||
port map (
|
||||
Q1 => s_dig_sync(i),
|
||||
Q2 => open,
|
||||
C => clk_adc,
|
||||
CE => '1',
|
||||
D => s_dig_in(i),
|
||||
R => '0',
|
||||
S => '0' );
|
||||
|
||||
-- Deglitch filter.
|
||||
inst_dig_deglitch: entity work.deglitch
|
||||
generic map (
|
||||
deglitch_cycles => 4 )
|
||||
port map (
|
||||
clk => clk_adc,
|
||||
din => s_dig_sync(i),
|
||||
dout => s_dig_deglitch(i) );
|
||||
|
||||
end generate;
|
||||
|
||||
-- Optionally generate simulated digital signals.
|
||||
process (clk_adc) is
|
||||
begin
|
||||
if rising_edge(clk_adc) then
|
||||
if s_reg_control.dig_simulate = '1' then
|
||||
s_dig_sample <= s_reg_control.dig_sim_state;
|
||||
else
|
||||
s_dig_sample <= s_dig_deglitch;
|
||||
end if;
|
||||
end if;
|
||||
end process;
|
||||
|
||||
-- Monitor digital signal state.
|
||||
s_reg_status.dig_sample <= s_dig_sample;
|
||||
|
||||
-- Time tagger.
|
||||
inst_timetagger: entity work.timetagger
|
||||
port map (
|
||||
clk => clk_adc,
|
||||
reset => s_reset,
|
||||
channel_en => s_reg_control.timetagger_en,
|
||||
marker => s_reg_control.timetagger_mark,
|
||||
timestamp_in => s_timestamp,
|
||||
dig_sample => s_dig_sample,
|
||||
out_valid => s_tt_dma_valid,
|
||||
out_ready => s_tt_dma_ready,
|
||||
out_empty => s_tt_dma_empty,
|
||||
out_data => s_tt_dma_data );
|
||||
|
||||
-- Collect interrupt signals from peripherals and generate interrupt to PS.
|
||||
s_reg_status.irq_pending <= s_irq_pending;
|
||||
s_irq_f2p(0) <= s_reg_control.irq_enable and or_reduce(s_irq_pending);
|
||||
s_irq_f2p(7 downto 1) <= (others => '0');
|
||||
|
||||
-- Report reset status via GPIO.
|
||||
process (clk_adc, s_ext_reset_n) is
|
||||
begin
|
||||
if s_ext_reset_n = '0' then
|
||||
r_reset_done <= '0';
|
||||
elsif rising_edge(clk_adc) then
|
||||
r_reset_done <= not s_reset;
|
||||
end if;
|
||||
end process;
|
||||
|
||||
-- Blinking LED, 1 Hz.
|
||||
process (clk_adc) is
|
||||
begin
|
||||
if rising_edge(clk_adc) then
|
||||
if s_reset = '1' then
|
||||
r_adcclk_cnt <= (others => '0');
|
||||
r_adcclk_led <= '0';
|
||||
elsif r_adcclk_cnt = 62499999 then
|
||||
r_adcclk_cnt <= (others => '0');
|
||||
r_adcclk_led <= not r_adcclk_led;
|
||||
else
|
||||
r_adcclk_cnt <= r_adcclk_cnt + 1;
|
||||
end if;
|
||||
end if;
|
||||
end process;
|
||||
|
||||
end architecture;
|
|
@ -9,12 +9,12 @@
|
|||
# This is used by "synth_design".
|
||||
set_part xc7z010clg400-1
|
||||
|
||||
# Specify path to RedPitaya board definition.
|
||||
set_param board.repoPaths [list "RedPitaya-FPGA/brd"]
|
||||
## Specify path to RedPitaya board definition.
|
||||
#set_param board.repoPaths [list "RedPitaya-FPGA/brd"]
|
||||
|
||||
# Specify board type.
|
||||
# Unclear whether this is required.
|
||||
set_property board_part redpitaya.com:redpitaya:part0:1.1 [current_project]
|
||||
## Specify board type.
|
||||
## Unclear whether this is required.
|
||||
#set_property board_part redpitaya.com:redpitaya:part0:1.1 [current_project]
|
||||
|
||||
# Specify HDL language.
|
||||
# This determines the language of the HDL wrapper for the block design.
|
||||
|
@ -34,7 +34,6 @@ read_vhdl -vhdl2008 ../rtl/dma_write_channel.vhd
|
|||
read_vhdl -vhdl2008 ../rtl/registers.vhd
|
||||
read_vhdl -vhdl2008 ../rtl/sample_decimation.vhd
|
||||
read_vhdl -vhdl2008 ../rtl/shift_engine.vhd
|
||||
read_vhdl -vhdl2008 ../rtl/syncdff.vhd
|
||||
read_vhdl -vhdl2008 ../rtl/simple_fifo.vhd
|
||||
read_vhdl -vhdl2008 ../rtl/timestamp_gen.vhd
|
||||
read_vhdl -vhdl2008 ../rtl/timetagger.vhd
|
||||
|
|
|
@ -35,5 +35,5 @@ if [ ! -f "$SDCARD_DIR/dropbear_ed25519_host_key" ]; then
|
|||
fi
|
||||
|
||||
# Copy FPGA firmware
|
||||
cp -a "$FIRMWARE_FILE" "$SDCARD_DIR"
|
||||
cp -a $FIRMWARE_FILES "$SDCARD_DIR"
|
||||
|
||||
|
|
|
@ -3,10 +3,24 @@
|
|||
# Load FPGA firmware from SD card and program FPGA.
|
||||
#
|
||||
|
||||
FIRMWARE_FILE="puzzlefw_top.bit.bin"
|
||||
. /opt/puzzlefw/lib/functions.sh
|
||||
|
||||
start() {
|
||||
|
||||
# Read hardware revision from EEPROM
|
||||
read_eeprom
|
||||
|
||||
if [ "$eeprom_hw_rev" = "STEM_125-14_v1.0" ]; then
|
||||
# Red Pitaya with XC7Z010 and 2 analog inputs
|
||||
FIRMWARE_FILE="puzzlefw_top.bit.bin"
|
||||
elif [ "$eeprom_hw_rev" = "STEM_125-14_Z7020_4IN_v1.3" ]; then
|
||||
# Red Pitaya with XC7Z020 and 4 analog inputs
|
||||
FIRMWARE_FILE="puzzlefw_top_4ch.bit.bin"
|
||||
else
|
||||
echo "ERROR: Unsupported hardware revision '$eeprom_hw_rev'" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# If firmware is not on rootfs, copy it from the SD card.
|
||||
if [ ! -f /lib/firmware/$FIRMWARE_FILE ]; then
|
||||
|
||||
|
@ -34,9 +48,6 @@ start() {
|
|||
# Note: EMIO GPIO line n is gpio (n + 54) in Linux.
|
||||
gpioset 0 54=0
|
||||
|
||||
# Drive internal GPIO line 2 high to enable ADC duty cycle stabilizer.
|
||||
gpioset 0 56=0
|
||||
|
||||
# Program FPGA.
|
||||
echo "Programming FPGA ..."
|
||||
echo 0 > /sys/class/fpga_manager/fpga0/flags
|
||||
|
@ -45,6 +56,14 @@ start() {
|
|||
# Wait until FPGA programmed.
|
||||
sleep 5
|
||||
|
||||
if [ "$eeprom_hw_rev" = "STEM_125-14_v1.0" ]; then
|
||||
# Drive internal GPIO line 2 high to enable ADC duty cycle stabilizer.
|
||||
gpioset 0 56=1
|
||||
elif [ "$eeprom_hw_rev" = "STEM_125-14_Z7020_4IN_v1.3" ]; then
|
||||
# Program ADCs for DDR data mode and enable duty cycle stabilizer.
|
||||
/opt/puzzlefw/bin/puzzle-adccfg init --force --dcs
|
||||
fi
|
||||
|
||||
# Drive internal GPIO line 0 high to release FPGA reset.
|
||||
gpioset 0 54=1
|
||||
sleep 1
|
||||
|
|
|
@ -17,8 +17,8 @@ LINUX_DIR="linux-xlnx"
|
|||
BOOTIMG_DIR="boot_img"
|
||||
SDCARD_DIR="sdcard_files"
|
||||
|
||||
XSA_FILE="../fpga/vivado/output/redpitaya_puzzlefw.xsa"
|
||||
FIRMWARE_FILE="../fpga/vivado/output/puzzlefw_top.bit.bin"
|
||||
XSA_FILE="../fpga/redpitaya_puzzlefw.xsa"
|
||||
FIRMWARE_FILES="../fpga/puzzlefw_top.bit.bin ../fpga/puzzlefw_top_4ch.bit.bin"
|
||||
|
||||
setup_toolchain () {
|
||||
if [ ! -x "$TOOLCHAIN_DIR/arm-linux-gcc" ]; then
|
||||
|
|
|
@ -543,9 +543,6 @@ public:
|
|||
m_device.set_record_length(1024);
|
||||
m_device.set_timetagger_event_mask(0);
|
||||
m_device.clear_adc_range();
|
||||
|
||||
// Enable analog acquisition.
|
||||
m_device.set_acquisition_enabled(true);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -901,6 +898,12 @@ private:
|
|||
}
|
||||
}
|
||||
|
||||
/** Handle command AIN:ACQUIRE:ENABLE? */
|
||||
std::string qry_acquire_enable(CommandEnvironment env)
|
||||
{
|
||||
return m_device.is_acquisition_enabled() ? "1" : "0";
|
||||
}
|
||||
|
||||
/** Handle command TT:SAMPLE? */
|
||||
std::string qry_tt_sample(CommandEnvironment env)
|
||||
{
|
||||
|
@ -1288,6 +1291,18 @@ private:
|
|||
return "OK";
|
||||
}
|
||||
|
||||
/** Handle command AIN:ACQUIRE:ENABLE */
|
||||
std::string cmd_acquire_enable(CommandEnvironment env,
|
||||
const std::string& arg)
|
||||
{
|
||||
unsigned int n;
|
||||
if ((! parse_uint(arg, n)) || (n > 1)) {
|
||||
return err_invalid_argument();
|
||||
}
|
||||
m_device.set_acquisition_enabled(n != 0);
|
||||
return "OK";
|
||||
}
|
||||
|
||||
/** Handle command TT:EVENT:MASK */
|
||||
std::string cmd_tt_event_mask(CommandEnvironment env,
|
||||
const std::string& arg)
|
||||
|
@ -1367,6 +1382,7 @@ private:
|
|||
{ "ain:chN:sample:raw?", &CommandHandler::qry_channel_sample },
|
||||
{ "ain:chN:minmax?", &CommandHandler::qry_channel_minmax },
|
||||
{ "ain:chN:minmax:raw?", &CommandHandler::qry_channel_minmax },
|
||||
{ "ain:acquire:enable?", &CommandHandler::qry_acquire_enable },
|
||||
{ "ain:srate?", &CommandHandler::qry_srate },
|
||||
{ "ain:srate:divisor?", &CommandHandler::qry_srate_divisor },
|
||||
{ "ain:srate:mode?", &CommandHandler::qry_srate_mode },
|
||||
|
@ -1402,6 +1418,7 @@ private:
|
|||
{ "ain:chN:offset:RR", &CommandHandler::cmd_channel_offset },
|
||||
{ "ain:chN:gain", &CommandHandler::cmd_channel_gain },
|
||||
{ "ain:chN:gain:RR", &CommandHandler::cmd_channel_gain },
|
||||
{ "ain:acquire:enable", &CommandHandler::cmd_acquire_enable },
|
||||
{ "ain:srate", &CommandHandler::cmd_srate },
|
||||
{ "ain:srate:divisor", &CommandHandler::cmd_srate_divisor },
|
||||
{ "ain:srate:mode", &CommandHandler::cmd_srate_mode },
|
||||
|
@ -1864,13 +1881,12 @@ int run_remote_control_server(
|
|||
command_handler.add_data_server(acq_server);
|
||||
command_handler.add_data_server(timetagger_server);
|
||||
|
||||
// Restore firmware status on exit from this function.
|
||||
// Disable DMA on exit from this function.
|
||||
struct ScopeGuard {
|
||||
PuzzleFwDevice& m_device;
|
||||
ScopeGuard(PuzzleFwDevice& device) : m_device(device) { }
|
||||
~ScopeGuard() {
|
||||
m_device.set_dma_enabled(false);
|
||||
m_device.set_acquisition_enabled(false);
|
||||
}
|
||||
} scope_guard(device);
|
||||
|
||||
|
|
|
@ -1,2 +1,2 @@
|
|||
#define PUZZLEFW_SW_MAJOR 0
|
||||
#define PUZZLEFW_SW_MINOR 3
|
||||
#define PUZZLEFW_SW_MINOR 4
|
||||
|
|
Loading…
Reference in New Issue