URL
https://opencores.org/ocsvn/soc_maker/soc_maker/trunk
Subversion Repositories soc_maker
Compare Revisions
- This comparison shows the changes necessary to convert path
/
- from Rev 8 to Rev 9
- ↔ Reverse comparison
Rev 8 → Rev 9
/soc_maker/trunk/LICENSE
1,674 → 1,678
GNU GENERAL PUBLIC LICENSE |
Version 3, 29 June 2007 |
= License |
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> |
Everyone is permitted to copy and distribute verbatim copies |
of this license document, but changing it is not allowed. |
== GNU GENERAL PUBLIC LICENSE |
|
Preamble |
|
The GNU General Public License is a free, copyleft license for |
software and other kinds of works. |
Version 3, 29 June 2007 |
|
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. |
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> |
Everyone is permitted to copy and distribute verbatim copies |
of this license document, but changing it is not allowed. |
|
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. |
Preamble |
|
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. |
The GNU General Public License is a free, copyleft license for |
software and other kinds of works. |
|
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. |
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. |
|
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. |
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. |
|
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. |
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. |
|
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. |
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. |
|
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. |
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. |
|
The precise terms and conditions for copying, distribution and |
modification follow. |
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. |
|
TERMS AND CONDITIONS |
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. |
|
0. Definitions. |
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. |
|
"This License" refers to version 3 of the GNU General Public License. |
The precise terms and conditions for copying, distribution and |
modification follow. |
|
"Copyright" also means copyright-like laws that apply to other kinds of |
works, such as semiconductor masks. |
TERMS AND CONDITIONS |
|
"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. |
0. Definitions. |
|
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. |
"This License" refers to version 3 of the GNU General Public License. |
|
A "covered work" means either the unmodified Program or a work based |
on the Program. |
"Copyright" also means copyright-like laws that apply to other kinds of |
works, such as semiconductor masks. |
|
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. |
"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 "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. |
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. |
|
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. |
A "covered work" means either the unmodified Program or a work based |
on the Program. |
|
1. Source Code. |
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. |
|
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. |
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. |
|
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. |
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. |
|
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. |
1. Source Code. |
|
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 "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. |
|
The Corresponding Source need not include anything that users |
can regenerate automatically from other parts of the Corresponding |
Source. |
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 Corresponding Source for a work in source code form is that |
same work. |
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. |
|
2. Basic Permissions. |
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. |
|
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. |
The Corresponding Source need not include anything that users |
can regenerate automatically from other parts of the Corresponding |
Source. |
|
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. |
The Corresponding Source for a work in source code form is that |
same work. |
|
Conveying under any other circumstances is permitted solely under |
the conditions stated below. Sublicensing is not allowed; section 10 |
makes it unnecessary. |
2. Basic Permissions. |
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law. |
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. |
|
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. |
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. |
|
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. |
Conveying under any other circumstances is permitted solely under |
the conditions stated below. Sublicensing is not allowed; section 10 |
makes it unnecessary. |
|
4. Conveying Verbatim Copies. |
3. Protecting Users' Legal Rights From Anti-Circumvention Law. |
|
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. |
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. |
|
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. |
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. |
|
5. Conveying Modified Source Versions. |
4. Conveying Verbatim Copies. |
|
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: |
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. |
|
a) The work must carry prominent notices stating that you modified |
it, and giving a relevant date. |
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. |
|
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". |
5. Conveying Modified Source Versions. |
|
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. |
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: |
|
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) The work must carry prominent notices stating that you modified |
it, and giving a relevant date. |
|
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. |
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". |
|
6. Conveying Non-Source Forms. |
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. |
|
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: |
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) 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. |
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. |
|
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. |
6. Conveying Non-Source Forms. |
|
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. |
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: |
|
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. |
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. |
|
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. |
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. |
|
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. |
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. |
|
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. |
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. |
|
"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. |
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. |
|
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). |
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. |
|
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. |
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. |
|
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. |
"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. |
|
7. Additional Terms. |
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). |
|
"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. |
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. |
|
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. |
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. |
|
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: |
7. Additional Terms. |
|
a) Disclaiming warranty or limiting liability differently from the |
terms of sections 15 and 16 of this License; or |
"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. |
|
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 |
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. |
|
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 |
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: |
|
d) Limiting the use for publicity purposes of names of licensors or |
authors of the material; or |
a) Disclaiming warranty or limiting liability differently from the |
terms of sections 15 and 16 of this License; or |
|
e) Declining to grant rights under trademark law for use of some |
trade names, trademarks, or service marks; 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 |
|
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. |
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 |
|
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. |
d) Limiting the use for publicity purposes of names of licensors or |
authors of the material; or |
|
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. |
e) Declining to grant rights under trademark law for use of some |
trade names, trademarks, or service marks; or |
|
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. |
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. |
|
8. Termination. |
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. |
|
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). |
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. |
|
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. |
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. |
|
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. |
8. Termination. |
|
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. |
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). |
|
9. Acceptance Not Required for Having Copies. |
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. |
|
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. |
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. |
|
10. Automatic Licensing of Downstream Recipients. |
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. |
|
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. |
9. Acceptance Not Required for Having Copies. |
|
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 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. |
|
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. |
10. Automatic Licensing of Downstream Recipients. |
|
11. Patents. |
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. |
|
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". |
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. |
|
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. |
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. |
|
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. |
11. Patents. |
|
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. |
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". |
|
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. |
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. |
|
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. |
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. |
|
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. |
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. |
|
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. |
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. |
|
12. No Surrender of Others' Freedom. |
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. |
|
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. |
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. |
|
13. Use with the GNU Affero General Public License. |
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. |
|
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. |
12. No Surrender of Others' Freedom. |
|
14. Revised Versions of this License. |
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. |
|
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. |
13. Use with the GNU Affero General Public License. |
|
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. |
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. |
|
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. |
14. Revised Versions of this License. |
|
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. |
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. |
|
15. Disclaimer of Warranty. |
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. |
|
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. |
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. |
|
16. Limitation of Liability. |
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. |
|
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. |
15. Disclaimer of Warranty. |
|
17. Interpretation of Sections 15 and 16. |
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. |
|
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. |
16. Limitation of Liability. |
|
END OF TERMS AND CONDITIONS |
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. |
|
How to Apply These Terms to Your New Programs |
17. Interpretation of Sections 15 and 16. |
|
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. |
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. |
|
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. |
END OF TERMS AND CONDITIONS |
|
{one line to give the program's name and a brief idea of what it does.} |
Copyright (C) {year} {name of author} |
How to Apply These Terms to Your New Programs |
|
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. |
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. |
|
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. |
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. |
|
You should have received a copy of the GNU General Public License |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
{one line to give the program's name and a brief idea of what it does.} |
Copyright (C) {year} {name of author} |
|
Also add information on how to contact you by electronic and paper mail. |
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. |
|
If the program does terminal interaction, make it output a short |
notice like this when it starts in an interactive mode: |
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. |
|
{project} Copyright (C) {year} {fullname} |
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. |
You should have received a copy of the GNU General Public License |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
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". |
Also add information on how to contact you by electronic and paper mail. |
|
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 |
<http://www.gnu.org/licenses/>. |
If the program does terminal interaction, make it output a short |
notice like this when it starts in an interactive mode: |
|
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 |
<http://www.gnu.org/philosophy/why-not-lgpl.html>. |
{project} Copyright (C) {year} {fullname} |
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 |
<http://www.gnu.org/licenses/>. |
|
The GNU General Public License does not permit incorporating your program |
into proprietary programs. If your program is a subroutine library, you |
may consider it more useful to permit linking proprietary applications with |
the library. If this is what you want to do, use the GNU Lesser General |
Public License instead of this License. But first, please read |
<http://www.gnu.org/philosophy/why-not-lgpl.html>. |
/soc_maker/trunk/Rakefile
1,4 → 1,5
require 'rspec/core/rake_task' |
require 'rake/task' |
|
begin |
require 'bones' |
21,4 → 22,17
c.ruby_opts="-w" |
end |
|
|
|
desc 'generate API documentation to doc/rdocs/index.html' |
|
Rake::RDocTask.new do |rd| |
rd.rdoc_dir = 'doc/rdocs' |
rd.main = 'README.md' |
rd.rdoc_files.include 'README.md', 'LICENSE', "bin", "lib" |
|
rd.options << '--inline-source' |
rd.options << '--line-numbers' |
rd.options << '--all' |
rd.options << '--fileboxes' |
rd.options << '--diagram' |
end |
/soc_maker/trunk/lib/soc_maker/parameter.rb
63,8 → 63,8
attr_accessor :description |
attr_accessor :choice |
|
def initialize( type, options = {} ) |
init_with( { 'type' => type }.merge( options ) ) |
def initialize( type, optional = {} ) |
init_with( { 'type' => type }.merge( optional ) ) |
end |
|
def encode_with( coder ) |
/soc_maker/trunk/lib/soc_maker/hdl_coder.rb
267,7 → 267,7
tmp = "#{port_tmp_name} <= " |
# loop over instances |
src_inst_sel.each_with_index do |(inst_name, inst), i| |
( tmp_name, port) = inst.get_port( src_ifc_sel[ inst_name ], port_name ) |
( tmp_name, port) = inst.port( src_ifc_sel[ inst_name ], port_name ) |
if port != nil |
if port[ :len ] < length[ port_name ] |
tmp << "\"" + "0" * ( length[ port_name ] - port[ :len ] ) + "\" & " |
291,7 → 291,7
# assign to destination |
dst_inst_sel.each_with_index do |(inst_name, inst), i| |
if not inst == nil #TODO |
( tmp_name, port) = inst.get_port( dst_ifc_sel[ inst_name ], port_name ) |
( tmp_name, port) = inst.port( dst_ifc_sel[ inst_name ], port_name ) |
if port != nil |
tmp << "#{inst_name}_#{tmp_name} <= #{port_tmp_name}" |
tmp << "( #{port[ :len ]}-1 downto 0 )" if port[ :len ] > 1 |
310,7 → 310,7
# dst_inst_sel.each_with_index do |(inst_name, inst), i| |
# p inst_name |
# p port_name |
# ( tmp_name, port) = inst.get_port( dst_ifc_sel[ inst_name ], port_name ) |
# ( tmp_name, port) = inst.port( dst_ifc_sel[ inst_name ], port_name ) |
# tmp << "#{inst_name}_#{tmp_name} <= ( others => 'X' );\n" |
# end |
# @asgn_part << tmp; |
/soc_maker/trunk/lib/soc_maker/conf.rb
62,10 → 62,10
return @@inst |
end |
|
def initialize( options = {} ) |
def initialize( optional = {} ) |
|
|
init_with( options.merge( { 'data' => { |
init_with( optional.merge( { 'data' => { |
# the name of this application/tool |
:app_name => 'SOC-Maker', |
|
122,7 → 122,12
|
@data_ro = { |
|
:yaml_classes => [ SOCMaker::CoreDef, SOCMaker::SOCDef, SOCMaker::IfcSpc, SOCMaker::LibInc, SOCMaker::Conf ], |
:yaml_classes => [ SOCMaker::CoreDef, |
SOCMaker::SOCDef, |
SOCMaker::IfcSpc, |
SOCMaker::LibInc, |
SOCMaker::Conf, |
SOCMaker::CoreInst ], |
|
# Regular expression, which is evaluatted to detect values like |
# eval function_name |
/soc_maker/trunk/lib/soc_maker/core_inst.rb
31,20 → 31,18
# |
# |
############################################################### |
# |
# Description: |
# This class represents a core instantiation within |
# a SOC. It contains a params (parameters) hash, |
# which defines, which parameters are set to which values. |
# The type field is used to identify the SOCMaker::CoreDef |
# and the field @defn is initialized as reference to |
# the corresponding CoreDef instance. |
# |
# |
############################################################### |
|
|
module SOCMaker |
|
###### |
# |
# This class represents a core instantiation within |
# a SOC. It contains a parameter-hash (@params), |
# which is used to define, which parameters are set to which values. |
# The type field is used to identify the SOCMaker::CoreDef |
# and the field @defn is initialized as reference to |
# the corresponding CoreDef instance. |
class CoreInst |
include ERR |
|
59,11 → 57,23
'params' => params ) |
|
end |
|
# |
# Encoder function (to yaml) |
# |
# +coder+:: An instance of the Psych::Coder to encode this class to a YAML file |
# |
def encode_with( coder ) |
%w[ type params ]. |
each { |v| coder[ v ] = instance_variable_get "@#{v}" } |
end |
|
# |
# Initialization function (from yaml) |
# |
# +coder+:: An instance of the Psych::Coder to init this class from a YAML file |
# |
# |
def init_with( coder ) |
|
serr_if( coder[ 'type' ] == nil, |
78,55 → 88,17
|
end |
|
def ports( *args ) |
if args.size == 0 |
@ports.each_with_index do |(name, port_def), i| |
yield( name.to_s, port_def[ :dir ], port_def[ :len ], port_def[ :default ], i==@ports.size-1 ) |
end |
elsif args.size == 1 |
@ifcs[ args.first.to_sym ].each do |name, port_def, i| |
yield( name.to_s, port_def[ :dir ], port_def[ :len ], port_def[ :default ], i==@ports.size-1 ) |
end |
end |
end |
|
|
def generics |
@defn.generics do |name, type, default_value, is_last| |
value = @params[ name.to_sym ]; |
value = value |
value = default_value if value == nil |
yield( name.to_s, type, value, is_last ) |
end |
end |
|
|
|
|
|
|
# |
# Get a port, identified by the interface and port name |
# |
# +ifc_name+:: name of the interface |
# +port_spec_name+:: name of the port |
# |
def get_port( ifc_name, port_spec_name ) |
tmp = @defn.interfaces[ ifc_name.to_sym ]. |
ports.select{ |key,hash| hash.defn == port_spec_name.to_s }. |
keys.first.to_s |
return [ tmp, @ports[ tmp.to_sym ] ] |
end |
|
|
# TODO do we need this? |
# Runs a consistency check and creates an internal |
# hash, which contains all evaluated ports. |
# Because the core-definition may contain variable port sizes, |
# which depend on the instance, these sizes need to be evaluated. |
# This is also done here and the result is stored in @_ifcs_evaluated. |
# |
# |
# def implements_port?( ifc_name, port_spec_name ) |
# @defn.implements_port?( ifc_name, port_spec_name ) |
# end |
|
|
def consistency_check |
|
@defn = SOCMaker::lib.get_core( @type ) |
146,58 → 118,10
@params[ param_name ] ||= param.default |
end |
|
|
# @_params ||= {} |
# if @params != nil |
# @params.each do |name, val| |
# |
# param_type = defn.inst_parameters[ name ].type |
# |
# if val.is_a? String |
# eval_match = SOCMaker::conf[ :eval_regex ].match( val ) |
# #TODO error handling |
# if eval_match |
# #eval_func = eval_match.captures[0] |
# @_params[ name ] = { value: eval( eval_str ).to_s, type: param_type } |
# else |
# @_params[ name ] = { value: val, type: param_type } |
# end |
# else |
# @_params[ name ] = { value: val, type: param_type } |
# end |
# end |
# end |
|
|
# |
# TODO merge these two loops and create one hash |
### |
# |
# create our own ports hash |
# |
@ports ||= {} |
@defn.ports do |port_name, port_dir, port_len, default, is_last | |
if port_len.is_a?( String ) |
param_match = SOCMaker::conf[ :length_regex ].match( port_len ) |
|
if param_match and @params[ port_len.to_sym ] != nil |
tmp =@params[ port_len.to_sym ] |
tmp = tmp.to_i if tmp.is_a?( String ) |
@ports[ port_name.to_sym ] = { len: tmp, dir: port_dir, default: default } |
else |
SOCMaker::logger.error( "Failed to evaluate #{port_len} for port #{port_name}" ) |
end |
else |
@ports[ port_name.to_sym ] = { len: port_len, dir: port_dir, default: default } |
end |
end |
|
|
@ifcs ||= {} |
@_ifcs_evaluated ||= {} |
@defn.interfaces.keys.each do |ifc_name| |
@ifcs[ ifc_name ] = {} |
@defn.ports( ifc_name ) do |port_name, port_dir, port_len, default, is_last | |
|
@_ifcs_evaluated[ ifc_name ] = {} |
@defn.ports( ifc_name.to_s ) do |port_name, port_dir, port_len, default, is_last | |
if port_len.is_a?( String ) |
param_match = SOCMaker::conf[ :length_regex ].match( port_len ) |
|
204,97 → 128,31
if param_match and @params[ port_len.to_sym ] != nil |
tmp =@params[ port_len.to_sym ] |
tmp = tmp.to_i if tmp.is_a?( String ) |
@ifcs[ ifc_name ][ port_name.to_sym ] = { len: tmp, dir: port_dir, default: default } |
@_ifcs_evaluated[ ifc_name ][ port_name.to_sym ] = { len: tmp, dir: port_dir, default: default } |
else |
SOCMaker::logger.error( "Failed to evaluate #{port_len} for port #{port_name}" ) |
end |
else |
@ifcs[ ifc_name ][ port_name.to_sym ] = { len: port_len, dir: port_dir, default: default } |
@_ifcs_evaluated[ ifc_name ][ port_name.to_sym ] = { len: port_len, dir: port_dir, default: default } |
end |
# |
#puts "#{port_def_ref}, #{port_name}, #{port_dir}, #{port_default}" |
end |
end |
|
# lerr_if( @defn == nil, 'Core not found in lib', |
# field: 'cores' ) |
|
|
|
@defn.consistency_check |
|
|
end |
|
|
|
# |
# Returns the length of a port within an interface. |
# If no instance is given, we know that it is |
# a toplevel interface. |
# Otherwise we check for this and we do a recursive call. |
# If this port is within a interface of a core, we |
# pass the call to the core-definition of this instance, which |
# knows all cores. |
# |
# +ifc_name+:: name of the interface |
# +port_spec_name+:: name of the port |
# +inst+:: name of the instance (optional), default is nil |
# |
def get_port_len( ifc_name, port_spec_name, inst = nil ) |
if inst == nil |
tmp = @defn.interfaces[ ifc_name.to_sym ]. |
ports.select{ |key,hash| hash.defn == port_spec_name.to_s }. |
keys.first.to_s |
return tmp.size == 0 ? 0 : @ports[ tmp.to_sym ][ :len ] |
else |
if inst == @defn.name.to_sym |
return get_port_len( ifc_name, port_spec_name ) |
else |
return @defn.get_port_len( ifc_name, port_spec_name, inst ) |
end |
end |
end |
|
|
# |
# Returns the core definition for an instance (identified by its name) |
# |
# +inst+:: name of the instance |
# |
def get_core_def( inst ) |
if inst == @defn.name |
return @defn |
else |
tmp = @defn.get_core_def( inst ) |
perr_if( tmp == nil, "#Processing error: {inst} not found by get_core_def" ) |
return tmp |
end |
end |
|
|
# |
# Returns a core instance, identified by its name. |
# If it is not a sub-core, we return our self |
# |
# +inst+:: name of the instance |
# |
def get_core_inst( inst ) |
if @defn.cores[ inst ] != nil |
return @defn.cores[ inst ] |
else |
return self |
end |
end |
|
|
# |
# Generate toplevel hdl file for this instance. |
# This assumes, that this instance represents a SOC with |
# further instances. |
# |
# |
# +coder+:: A HDL coder, which is used to create the auto-generated HDL (optional). |
# If no coder is given, a VHDLCoder is used. |
# +coder+:: An instance of the SOCMaker::HDLCoder, which is used to |
# create the auto-generated HDL (optional). |
# If no coder is given, a SOCMaker::VHDLCoder is used. |
# |
# |
def gen_toplevel( coder = VHDLCoder.new ) |
345,7 → 203,6
end |
|
assign_unused_to_default( coder ) |
|
|
# |
# Write content to the file |
363,8 → 220,159
|
|
|
# |
# Iterate over all ports and call the block with |
# - port-name |
# - port length |
# - default value |
# - is-last value |
# |
# If no argument is given, all ports of this instance are processed. |
# If arguments are given, each argument is supposed to the name of |
# a interface. All specified interfaces with all ports are processed. |
# |
# +args+:: Optional list of interface names |
# |
# |
def ports( *args ) |
|
if args.size == 0 |
ifc_sel = @_ifcs_evaluated |
else |
ifc_sel = @_ifcs_evaluated.select{ |k,v| args.include?( k.to_s ) } |
end |
|
ifc_sel.each_with_index do |(ifc_name, ifc), i_ifc| |
ifc.each_with_index do |(port_name, port_def), i_port| |
yield( port_name.to_s, |
port_def[ :dir ], |
port_def[ :len ], |
port_def[ :default ], |
i_port==ifc.size-1 && i_ifc == ifc_sel.size-1 ) |
end |
end |
end |
|
# |
# Iterate over all generics and call the block with |
# - generic-name |
# - generic-type |
# - the value |
# - is-last information |
# |
def generics |
@defn.generics do |name, type, default_value, is_last| |
value = @params[ name.to_sym ]; |
value = value |
value = default_value if value == nil |
yield( name.to_s, type, value, is_last ) |
end |
end |
|
|
|
|
|
|
|
# |
# Returns a port, identified by the interface and port name |
# |
# +ifc_name+:: name of the interface |
# +port_spec_name+:: name of the port |
# |
def port( ifc_name, port_spec_name ) |
tmp = @defn.interfaces[ ifc_name.to_sym ]. |
ports.select{ |key,hash| hash.defn == port_spec_name.to_s }. |
keys.first.to_s |
return [ tmp, @_ifcs_evaluated[ ifc_name.to_sym ][ tmp.to_sym ] ] |
end |
|
# |
# Returns the length of a port within an interface. |
# If no instance is given, we know that it is |
# a toplevel interface. |
# Otherwise we check for this and we do a recursive call. |
# If this port is within a interface of a core, we |
# pass the call to the core-definition of this instance, which |
# knows all cores. |
# |
# +ifc_name+:: name of the interface |
# +port_spec_name+:: name of the port |
# +inst+:: name of the instance (optional), default is nil |
# |
def port_length( ifc_name, port_spec_name, inst = nil ) |
if inst == nil |
tmp = @defn.interfaces[ ifc_name.to_sym ]. |
ports.select{ |key,hash| hash.defn == port_spec_name.to_s }. |
keys.first.to_s |
return tmp.size == 0 ? 0 : @_ifcs_evaluated[ ifc_name.to_sym ][ tmp.to_sym ][ :len ] |
else |
if inst == @defn.name.to_sym |
return port_length( ifc_name, port_spec_name ) |
else |
return @defn.port_length( ifc_name, port_spec_name, inst ) |
end |
end |
end |
|
# |
# Returns the core definition for an instance (identified by its name) |
# |
# +inst+:: name of the instance |
# |
def core_definition( inst ) |
if inst == @defn.name |
return @defn |
else |
tmp = @defn.core_definition( inst ) |
perr_if( tmp == nil, "#Processing error: {inst} not found by core_definition" ) |
return tmp |
end |
end |
|
# |
# Returns a core instance, identified by its name. |
# If it is not a sub-core, we return our self |
# |
# +inst+:: name of the instance |
# |
def core_instance( inst ) |
if @defn.cores[ inst ] != nil |
return @defn.cores[ inst ] |
else |
return self |
end |
end |
|
|
|
|
|
|
# |
# Returns a string describing this instance |
# |
def to_s |
"type: #{type}\n" + |
"params: #{params}\n" |
end |
|
# |
# Equality operator |
# |
def ==(o) |
o.class == self.class && |
o.type == self.type && |
o.params == self.params |
end |
|
|
|
|
|
|
# |
# Assign default values for unused interfaces. |
# This is just a helper function and is used by gen_toplevel |
# |
400,7 → 408,6
end |
|
|
|
# |
# This function is called during the toplevel generation |
# for each connection. |
421,8 → 428,8
# and searching for the core-definition. |
# |
ifc_spec = SOCMaker::lib.get_ifc( |
get_core_def( src.keys.first.to_s ).interfaces[ src.values.first ].name, |
get_core_def( src.keys.first.to_s ).interfaces[ src.values.first ].version ) |
core_definition( src.keys.first.to_s ).interfaces[ src.values.first ].name, |
core_definition( src.keys.first.to_s ).interfaces[ src.values.first ].version ) |
|
|
# |
438,10 → 445,10
ifc_spec.ports.keys.each do |_name| |
length_tmp[ _name ] = [] |
dst.each do |inst_name, ifc_name| |
length_tmp[ _name ] << get_port_len( ifc_name, _name, inst_name ) |
length_tmp[ _name ] << port_length( ifc_name, _name, inst_name ) |
end |
src.each do |inst_name, ifc_name| |
length_tmp[ _name ] << get_port_len( ifc_name, _name, inst_name ) |
length_tmp[ _name ] << port_length( ifc_name, _name, inst_name ) |
end |
end |
max_length = Hash[ length_tmp.map{ |key, arr| [ key, arr.max ] } ] |
453,10 → 460,10
# the value. |
# |
src.keys.each do |inst_name| |
src_inst[ inst_name ] = get_core_inst( inst_name ) |
src_inst[ inst_name ] = core_instance( inst_name ) |
end |
dst.keys.each do |inst_name| |
dst_inst[ inst_name ] = get_core_inst( inst_name ) |
dst_inst[ inst_name ] = core_instance( inst_name ) |
end |
|
# |
467,26 → 474,18
end |
|
|
# |
# Returns a string describing this instance |
# |
def to_s |
"type: #{type}\n" + |
"params: #{params}\n" |
end |
|
# |
# Equal operator |
# |
def ==(o) |
o.class == self.class && |
o.type == self.type && |
o.params == self.params |
end |
|
# TODO |
# private: assign_unused_to_default, :gen_toplevel_con |
|
|
|
|
|
|
private :assign_unused_to_default, :gen_toplevel_con |
|
|
|
end # CoreInst |
end # SOCMaker |
|
/soc_maker/trunk/lib/soc_maker/component.rb
33,29 → 33,6
############################################################### |
# |
# Description: |
# This class represents an abstract component. |
# It is one of the central classes and holds data, |
# which is used to describe and instanciate a core or SOC. |
# |
# The following fields are defined and used |
# by CoreDef and SOCDef |
# - name : name of the core (mandatory) |
# - version : version of the core (mandatory) |
# - toplevel : toplevel name (mandatory) |
# - description : description of this core |
# - date : creation date |
# - license : license of this core |
# - licensefile : location of the license file |
# - author : author of this core |
# - authormail : author-mail of this core |
# - vccmd : a version control command, which is used |
# to download the files |
# - interfaces : interfaces which are implemented |
# see SOCMaker::IfcSpc |
# - inst_parameters : hash of instantiation parameters |
# see SOCMaker::Parameter |
# - static_parameters : hash of static parameters |
# see SOCMaker::SParameter |
######## |
# |
# TODO |
64,30 → 41,87
############################################################### |
|
|
|
module SOCMaker |
|
|
|
###### |
# |
# This class represents an abstract component. |
# It is one of the central classes and holds data, |
# which is used to describe a core or System-On-Chip (SOC). |
# |
# |
class Component |
include ERR |
include YAML_EXT |
|
|
# name of the core (mandatory) |
attr_accessor :name |
|
# version of the core (mandatory) |
attr_accessor :version |
|
# toplevel name (mandatory) |
attr_accessor :toplevel |
|
# description of this core |
attr_accessor :description |
|
# creation date |
attr_accessor :date |
|
# license of this core |
attr_accessor :license |
|
# location of the license file |
attr_accessor :licensefile |
|
# author of this core |
attr_accessor :author |
|
# author-mail of this core |
attr_accessor :authormail |
|
# a version control command, which is used to download the files |
attr_accessor :vccmd |
|
# interfaces which are implemented see SOCMaker::IfcSpc |
attr_accessor :interfaces |
|
attr_accessor :functions |
|
# hash of instantiation parameters see SOCMaker::Parameter |
attr_accessor :inst_parameters |
|
# hash of static parameters see SOCMaker::SParameter |
attr_accessor :static_parameters |
def initialize( name, version, toplevel, options = {} ) |
|
|
# |
# Constructor |
# The three attributes are required, and all other attributes |
# can be given as a optinal hash |
# |
# *name*:: Name of this component |
# *version*:: Version of this component |
# *toplevel*:: Toplevel name of this component |
# *optional*:: Non-mandatory values, which can be set during initialization. |
# |
# |
def initialize( name, version, toplevel, optional = {} ) |
init_with( { 'name' => name, |
'version' => version, |
'toplevel' => toplevel }.merge( options ) ) |
'toplevel' => toplevel }.merge( optional ) ) |
end |
|
# |
# Encoder function (to yaml) |
# |
# +coder+:: An instance of the Psych::Coder to encode this class to a YAML file |
# |
def encode_with( coder ) |
%w[ name version description date license licensefile |
author authormail vccmd toplevel interfaces |
94,6 → 128,13
functions inst_parameters static_parameters ]. |
each { |v| coder[ v ] = instance_variable_get "@#{v}" } |
end |
|
# |
# Initialization function (from yaml) |
# |
# +coder+:: An instance of the Psych::Coder to init this class from a YAML file |
# |
# |
def init_with( coder ) |
|
serr_if( coder[ 'name' ] == nil, |
218,6 → 259,13
end |
|
|
# |
# Runs a consistency check: |
# Iterate over all interfaces and check, if the interface is |
# in the SOCMaker::Lib. |
# The function also checks also, if the ports defined by this |
# core is also defined in the interface. |
# |
def consistency_check |
@interfaces.values.each_with_index do | ifc, i_ifc; ifc_def| |
|
236,7 → 284,10
end |
|
|
def get_files |
# |
# Runs the Version Control System command via system(....) |
# |
def update_vcs |
unless self.vccmd.nil? or @vccmd.size == 0 |
#puts"cd #{@dir} && #{@vccmd}" |
system( "cd #{@dir} && #{vccmd} " ) |
245,119 → 296,91
|
|
|
|
|
# Iterates over all generic values of this component |
# and yield the call block with |
# - generic name |
# - generic type |
# - generic default |
# - is-last value |
def generics |
@inst_parameters.each_with_index do |(name, val), i| |
yield( name.to_s, val.type, val.default, i == @inst_parameters.size-1 ) |
|
_generic_name = name.to_s |
_generic_type = val.type |
_generic_default = val.default |
_is_last = i == @inst_parameters.size-1 |
yield( _generic_name , |
_generic_type , |
_generic_default, |
_is_last ) |
|
end |
end |
|
def get_and_ensure_dst_dir!( core_name ) |
dst_dir = File.expand_path( |
File.join( |
SOCMaker::conf[ :build_dir ], |
SOCMaker::conf[ :hdl_dir ], |
core_name ) ) |
FileUtils.mkdir_p dst_dir |
return dst_dir |
end |
|
# |
# Iterates over interface list. |
# Iterates over interface list (if no argument is given) |
# or all specified interfaces. |
# For each interface, all ports are processed. |
# For each port within each interface, we lookup the port defn |
# and yield the call block with |
# - port-name |
# - port-definition |
# - info if last |
# - port-name |
# - port length |
# - default value |
# - is-last value |
# as argument |
# |
# An xor mechanism between port_dir and ifc=>dir is used |
# to determine the direction of a port, for example: |
# If the interface is declared as input (1) and a port is declared as input (1) |
# the resulting direction will be an output 1^1 = 0. |
# But if the overall interface direction is an output (0) and a port is declared |
# as input, the resulting direction will an input 0^1 = 1. |
# If the interface is declared as input (1) and a port is declared as input (1) |
# the resulting direction will be an output 1^1 = 0. |
# But if the overall interface direction is an output (0) and a port is declared |
# as input, the resulting direction will an input 0^1 = 1. |
# This allows to define a port-direction in the interface definition, |
# and toggle the directions on core-definition level. |
# |
# |
# *args*:: An optional list of interface names |
def ports( *args ) |
|
if args.size == 0 |
@interfaces.values.each_with_index do | ifc, i_ifc; ifc_def| |
|
# get interface definition |
ifc_def = SOCMaker::lib.get_ifc( ifc.name, ifc.version ) |
@ifc_sel = @interfaces |
else |
@ifc_sel = @interfaces.select{ |k,v| args.include?( k.to_s ) } |
end |
|
# loop over ports in this interface |
ifc.ports.each_with_index do |(port_name, port_def), i_port; port_dir| |
@ifc_sel.values.each_with_index do | ifc, i_ifc; ifc_def| |
|
# get interface definition |
ifc_def = SOCMaker::lib.get_ifc( ifc.name, ifc.version ) |
|
# the reference to the port in the definition |
defn_ref = port_def.defn.to_sym |
perr_if( !ifc_def.ports.has_key?( defn_ref ), |
"Can't find #{port_def} in" + |
"interface definition #{ifc_def.name} " + |
"version #{ifc_def.version}" ) |
yield( port_name.to_s, |
ifc_def.ports[ defn_ref ][:dir] ^ ifc.dir, |
port_def.len, |
ifc_def.ports[ defn_ref ][ :default ], |
( (i_port == ifc.ports.size-1 ) and (i_ifc == @interfaces.size-1 ) ) ) |
end |
end |
# loop over ports in this interface |
ifc.ports.each_with_index do |(port_name, port_def), i_port | |
|
elsif args.size == 1 |
|
# get interface (input is the name as string ) |
ifc = @interfaces[ args.first.to_sym ] |
ifc_def = SOCMaker::lib.get_ifc( ifc.name, ifc.version ) |
|
# loop over all ports of this interface |
ifc.ports.each_with_index do |(port_name, port_def),i_port; port_dir| |
# the reference to the port in the definition |
defn_ref = port_def.defn.to_sym |
perr_if( !ifc_def.ports.has_key?( defn_ref ), |
"Can't find #{defn_ref} in" + |
"Can't find #{port_def} in" + |
"interface definition #{ifc_def.name} " + |
"version #{ifc_def.version}" ) |
yield( port_name.to_s, |
ifc_def.ports[ defn_ref ][:dir] ^ ifc.dir, |
port_def.len, |
ifc_def.ports[ defn_ref ][ :default ], |
( (i_port == ifc.ports.size-1 ) ) |
) |
#yield( port_def.to_s, |
#port_name.to_s, |
#port_dir ^ ifc.dir, |
#port_default ) |
|
_port_name = port_name.to_s |
_port_dir = ifc_def.ports[ defn_ref ][:dir] ^ ifc.dir |
_port_length = port_def.len |
_port_default = ifc_def.ports[ defn_ref ][ :default ] |
_is_last = ( (i_port == ifc.ports.size-1 ) and (i_ifc == @ifc_sel.size-1 ) ) |
yield( _port_name, _port_dir, _port_length, _port_default, _is_last ) |
end |
|
else |
# TODO |
end |
|
end |
|
|
|
# def implements_port?( ifc_name, port_spec_name ) |
# tmp = @interfaces[ ifc_name.to_sym ]. |
# ports.select{ |key,hash| hash.defn == port_spec_name.to_s }.keys |
|
# perr_if( tmp.size > 1, |
# "The port #{port_spec_name} of interface #{ifc_name} is implemented |
# multiple times" ) |
|
# return tmp.size == 1 |
# end |
|
def param_ok?( param_name, param_value ) |
param = inst_parameters[ param_name.to_sym ] |
param = static_parameters[ param_name.to_sym ] if param == nil |
return false if param == nil |
end |
|
|
|
# |
# Equality operator |
# |
def ==(o) |
|
tmp = ( o.class == self.class ) |
372,6 → 395,9
return true |
end |
|
# |
# Returns a string describing this instance |
# |
def to_s |
"version: #{@version}\n" + |
"toplevel: #{@toplevel}\n" + |
389,6 → 415,35
end |
|
|
|
|
|
# |
# Creates a core directory, if it doesn't exist. |
# The path of the target directoy depends |
# on SOCMaker::conf[ :build_dir ] and |
# on SOCMaker::conf[ :hdl_dir ]. |
# The resulting path is |
# ./#{SOCMaker::conf[ :build_dir ]}/#{SOCMaker::conf[ :hdl_dir ]}/dir_name |
# |
# *dir_name*:: Name of the target directory |
# |
def self.get_and_ensure_dst_dir!( dir_name ) |
dst_dir = File.expand_path( |
File.join( |
SOCMaker::conf[ :build_dir ], |
SOCMaker::conf[ :hdl_dir ], |
dir_name ) ) |
FileUtils.mkdir_p dst_dir |
return dst_dir |
end |
|
|
|
|
|
|
|
end # class CoreDef |
end # module SOCMaker |
|
/soc_maker/trunk/lib/soc_maker/soc_def.rb
51,11 → 51,11
attr_accessor :cores |
attr_accessor :cons |
attr_accessor :static |
def initialize( name, version, toplevel, options = {} ) |
def initialize( name, version, toplevel, optional = {} ) |
|
init_with( { 'name' => name, |
'version' => version, |
'toplevel' => toplevel }.merge( options ) ) |
'toplevel' => toplevel }.merge( optional ) ) |
|
end |
|
128,15 → 128,15
end |
|
|
def get_port_len( ifc_name, port_name, inst ) |
def port_length( ifc_name, port_name, inst ) |
if @cores[ inst.to_sym ] != nil |
return @cores[ inst ].get_port_len( ifc_name, port_name ) |
return @cores[ inst ].port_length( ifc_name, port_name ) |
else |
return nil |
end |
end |
|
def get_core_def( inst ) |
def core_definition( inst ) |
if @cores[ inst.to_sym ] != nil |
return @cores[ inst.to_sym ].defn |
elsif inst == @name |
173,8 → 173,8
end |
|
|
core_def_1 = get_core_def( inst1 ) |
core_def_2 = get_core_def( inst2 ) |
core_def_1 = core_definition( inst1 ) |
core_def_2 = core_definition( inst2 ) |
|
perr_if( !core_def_1, "Can't find core #{inst1}" ) |
perr_if( !core_def_2, "Can't find core #{inst2}" ) |
283,7 → 283,7
core_def = SOCMaker::lib.get_core( core_inst.type ) |
|
# create destination directory name and ensure, that it is exist |
dst_dir = get_and_ensure_dst_dir!( core_def.name ) |
dst_dir = Component.get_and_ensure_dst_dir!( core_def.name ) |
|
# copy each file into destination dir |
core_def.hdlfiles.each do |file, val| |
329,7 → 329,7
|
# create file paths |
src_path = File.join( core_def.dir, sparam.path ) |
dst_dir = get_and_ensure_dst_dir!( core_def.name ) |
dst_dir = Component::get_and_ensure_dst_dir!( core_def.name ) |
dst_path = File.join( dst_dir, sparam.file_dst ) |
|
|
/soc_maker/trunk/lib/soc_maker/sparameter.rb
60,9 → 60,9
attr_accessor :file_dst |
attr_accessor :parameters |
|
def initialize( path, file_dst, options = {} ) |
def initialize( path, file_dst, optional = {} ) |
init_with( { 'path' => path, |
'file_dst' => file_dst }.merge( options ) ) |
'file_dst' => file_dst }.merge( optional ) ) |
end |
def encode_with( coder ) |
%w[ path file_dst parameters ]. |
126,9 → 126,9
class SParameterEntry < Parameter |
attr_accessor :token |
|
def initialize( type, token, options = {} ) |
def initialize( type, token, optional = {} ) |
init_with( { 'type' => type, |
'token' => token }.merge( options ) ) |
'token' => token }.merge( optional ) ) |
|
end |
def encode_with( coder ) |
/soc_maker/trunk/lib/soc_maker/core_def.rb
33,20 → 33,7
############################################################### |
# |
# Description: |
# This class represents a core definition. |
# It is one of the central classes and holds data, |
# which is used to describe and instanciate this core. |
# In general, instances of this class desribe a core, |
# it's interface and parameters as well as the files, |
# which are required for synthesis/simulation. |
# |
# In addition to this core, there exist CoreInst, |
# which represents a concret instanciation of a definition |
# (see core_inst.rb). |
# This class adds two fields to SOCMaker::Component: |
# - hdlfiles : hash of SOCMaker::HDLFile (mandatory, |
# at least one file) |
# |
######## |
# |
# TODO |
56,16 → 43,32
|
|
module SOCMaker |
|
|
######### |
# |
# This class represents a core definition. |
# It is one of the central classes and holds data, |
# which is used to describe and instanciate this core. |
# In general, instances of this class desribe a core, |
# it's interface and parameters as well as the files, |
# which are required for synthesis/simulation. |
# |
# In addition to this core, there exist SOCMaker::CoreInst, |
# which represents a concret instanciation of a definition. |
# |
class CoreDef < Component |
include ERR |
include YAML_EXT |
|
attr_accessor :hdlfiles |
def initialize( name, version, hdl_files, toplevel, options = {} ) |
|
|
def initialize( name, version, hdl_files, toplevel, optional = {} ) |
init_with( { 'name' => name, |
'version' => version, |
'hdlfiles' => hdl_files, |
'toplevel' => toplevel }.merge( options ) ) |
'toplevel' => toplevel }.merge( optional ) ) |
end |
def encode_with( coder ) |
super coder |
74,23 → 77,11
def init_with( coder ) |
super( coder ) |
|
# TODO: this was removed because we want to |
# support cores, which have a config-file only |
# (where config and implementation is in one file) |
|
# serr_if( coder[ 'hdlfiles' ] == nil, |
# 'No hdlfiles field found', |
# instance: @name, |
# fiel: 'hdlfiles' ) |
@hdlfiles = coder[ 'hdlfiles' ] || {} |
serr_if( !@hdlfiles.is_a?( Hash ), |
'HDL file def. != Hash', |
instance: @name, |
field: 'hdlfiles' ) |
# serr_if( @hdlfiles.size == 0, |
# 'No HDL files are given', |
# instance: @name, |
# field: 'hdlfiles' ) |
|
@hdlfiles.each do |file_name, defn | |
serr_if( defn == nil, |
115,89 → 106,7
end |
|
|
# |
# TODO this also exists in component.rb |
# might this be removed? |
# If yes, make sure, that the 'default' stuff |
# is also done in component.rb!!! |
# |
# Iterates over interface list. |
# For each interface, all ports are processed. |
# For each port within each interface, we lookup the port defn |
# and yield the call block with |
# - port-name |
# - port-definition |
# - info if last |
# as argument |
# |
# |
# |
#def ports( *args ) |
|
|
#if args.size == 0 |
#@interfaces.values.each_with_index do | ifc, i_ifc; ifc_def| |
|
## get interface definition |
#ifc_def = SOCMaker::lib.get_ifc( ifc.name, ifc.version ) |
|
## loop over ports in this interface |
#ifc.ports.each_with_index do |(port_name, port_def), i_port; port_dir| |
|
## the reference to the port in the definition |
#defn_ref = port_def.defn |
#port_dir = ifc_def.ports[ defn_ref.to_sym ][ :dir ] |
#port_default = ifc_def.ports[ defn_ref.to_sym ][ :default ] |
#perr_if( port_dir == nil, |
#"Can't find #{defn_ref} in interface " + |
#"definition #{ifc_def.name} version " + |
#ifc_def.version + "==>>" + ifc_def.to_yaml ) |
|
## An xor mechanism between port_dir and ifc=>dir is used |
## to determine the direction of a port, for example: |
## If the interface is declared as input (1) and a port is declared as input (1) |
## the resulting direction will be an output 1^1 = 0. |
## But if the overall interface direction is an output (0) and a port is declared |
## as input, the resulting direction will an input 0^1 = 1. |
## This allows to define a port-direction in the interface definition, |
## and toggle the directions on core-definition level. |
|
## (name, direction, length, is_last) |
#yield( port_name.to_s, |
#port_dir ^ ifc.dir, |
#port_def.len, |
#port_default, |
#( (i_port == ifc.ports.size-1 ) and (i_ifc == @interfaces.size-1 ) ) ) |
#end |
#end |
|
## elsif args.size == 1 |
|
## # get interface (input is the name as string ) |
## ifc = @interfaces[ args.first.to_sym ] |
|
## ifc_def = SOCMaker::lib.get_ifc( ifc.name, ifc.version ) |
## ifc.ports.each do |port_name, port_def; port_dir| |
## port_def = port_def.defn |
## port_dir = ifc_def.ports[ port_def.to_sym ] |
## if port_dir == nil |
## perr_if( port_dir==nil, |
## "Can't find #{port_def} in" + |
## "interface definition #{ifc_def.name} " + |
## "version #{ifc_def.version}" ) |
## end |
## yield( port_def.to_s, |
## port_name.to_s, |
## port_dir ^ ifc.dir ) |
## end |
|
#else |
|
#end |
|
#end |
|
|
# this is a core_def and doesn't have |
# sub-cores |
def get_core_def( inst ) |
/soc_maker/trunk/lib/soc_maker/hdl_file.rb
62,8 → 62,8
attr_accessor :use_mod_sim |
attr_accessor :type |
|
def initialize( path, options = {} ) |
init_with( { 'path' => path }.merge( options ) ) |
def initialize( path, optional = {} ) |
init_with( { 'path' => path }.merge( optional ) ) |
end |
|
def encode_with( coder ) |
/soc_maker/trunk/lib/soc_maker/ifc_spc.rb
47,9 → 47,9
attr_accessor :version |
attr_accessor :ports |
|
def initialize( name, version, options = {} ) |
def initialize( name, version, optional = {} ) |
init_with( { 'name' => name, |
'version' => version }.merge( options ) ) |
'version' => version }.merge( optional ) ) |
end |
def encode_with( coder ) |
%w[ name version ports ]. |
/soc_maker/trunk/spec/lib_spec.rb
149,7 → 149,7
core_A.class.should be SOCMaker::CoreDef |
core_B.class.should be SOCMaker::CoreDef |
core_AB_ifc.class.should be SOCMaker::IfcSpc |
core_A.static_parameters.size.should be == 2 |
core_A.static_parameters.size.should be == 3 |
end |
|
end |
/soc_maker/trunk/spec/soc_def_spec.rb
177,9 → 177,11
@soc.add_core( "mycore", "rel1", "core_inst" ).should_not be == false |
end |
|
it "should return nil if a connection is added twice" do |
# in one of the first version, we returned nil, but now this is |
# used to extend a interface |
it "should not return nil if a connection is added twice" do |
@soc.cons[ :a_con ] = { rule: "or", mapping: [ { :core_a => :ifc_a }, { :core_b => :ifc_b } ] } |
@soc.add_connection( "core_a", "ifc_a", "core_c", "ifc_b", "a_con" ).should be == nil |
@soc.add_connection( "core_a", "ifc_a", "core_c", "ifc_b", "a_con" ).should_not be == nil |
end |
|
it "should raise a library error when adding an unknown core" do |
192,7 → 194,7
SOCMaker::conf[ :hdl_dir ] = "hdl" |
path = File.expand_path "./spec/tmp_build/hdl/a_core" |
FileUtils.rmdir( path ) if File.directory?( path ) |
res = @soc.get_and_ensure_dst_dir!( "a_core" ) |
res = SOCMaker::Component::get_and_ensure_dst_dir!( "a_core" ) |
File.directory?( path ).should be == true |
res.should be == path |
end |
/soc_maker/trunk/spec/component_spec.rb
219,6 → 219,7
r_name = [] |
r_dir = [] |
|
p c.interfaces |
c.ports( "i1" ) do |arg_name,arg_dir, arg_default, arg_is_last| |
#r_def << arg_def |
r_name << arg_name |
237,10 → 238,10
|
|
it "should throw an error if an incomplete interface is used" do |
file = { "file.vhd".to_sym => SOCMaker::HDLFile.new( "./file.vhd" ) } |
|
# three (auto) mandatory ports |
ifc_s1 = SOCMaker::IfcSpc.new( "i1", "v1", 'ports' => { p1: { dir: 1}, p2: {dir: 1}, p3: {dir:0} } ) |
SOCMaker::lib.add_ifc( ifc_s1 ) |
|
# interface implementaiton with only two of the three ports |
p1 = SOCMaker::IfcPort.new( "p1", 1 ) |
/soc_maker/trunk/examples/or1200_test/or1200_test.rb
16,7 → 16,7
|
|
SOCMaker::lib.cores do |name_version, core| |
# core.get_files |
# core.update_vcs |
end |
|
soc = SOCMaker::SOCDef.new( 'or1200_test', 'v1', 'or1200_test' ) |