diff options
| -rw-r--r-- | LICENSES/Apache-2.0.txt | 202 | ||||
| -rw-r--r-- | LICENSES/CERN-OHL-1.2.txt | 189 | ||||
| -rw-r--r-- | LICENSES/GPL-2.0-or-later.txt | 339 | ||||
| -rw-r--r-- | README.md | 84 |
4 files changed, 814 insertions, 0 deletions
diff --git a/LICENSES/Apache-2.0.txt b/LICENSES/Apache-2.0.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSES/Apache-2.0.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSES/CERN-OHL-1.2.txt b/LICENSES/CERN-OHL-1.2.txt new file mode 100644 index 0000000..6e2467a --- /dev/null +++ b/LICENSES/CERN-OHL-1.2.txt @@ -0,0 +1,189 @@ +CERN Open Hardware Licence v1.2 + +Preamble + +Through this CERN Open Hardware Licence ("CERN OHL") version 1.2, CERN +wishes to provide a tool to foster collaboration and sharing among +hardware designers. The CERN OHL is copyright CERN. Anyone is welcome +to use the CERN OHL, in unmodified form only, for the distribution of +their own Open Hardware designs. Any other right is reserved. Release +of hardware designs under the CERN OHL does not constitute an +endorsement of the licensor or its designs nor does it imply any +involvement by CERN in the development of such designs. + +1. Definitions + +In this Licence, the following terms have the following meanings: + +“Licence” means this CERN OHL. + +“Documentation” means schematic diagrams, designs, circuit or circuit +board layouts, mechanical drawings, flow charts and descriptive text, +and other explanatory material that is explicitly stated as being made +available under the conditions of this Licence. The Documentation may +be in any medium, including but not limited to computer files and +representations on paper, film, or any other media. + +“Documentation Location” means a location where the Licensor has +placed Documentation, and which he believes will be publicly +accessible for at least three years from the first communication to +the public or distribution of Documentation. + +“Product” means either an entire, or any part of a, device built using +the Documentation or the modified Documentation. + +“Licensee” means any natural or legal person exercising rights under +this Licence. + +“Licensor” means any natural or legal person that creates or modifies +Documentation and subsequently communicates to the public and/ or +distributes the resulting Documentation under the terms and conditions +of this Licence. + +A Licensee may at the same time be a Licensor, and vice versa. + +Use of the masculine gender includes the feminine and neuter genders +and is employed solely to facilitate reading. + +2. Applicability + +2.1. This Licence governs the use, copying, modification, +communication to the public and distribution of the Documentation, and +the manufacture and distribution of Products. By exercising any right +granted under this Licence, the Licensee irrevocably accepts these +terms and conditions. + +2.2. This Licence is granted by the Licensor directly to the Licensee, +and shall apply worldwide and without limitation in time. The Licensee +may assign his licence rights or grant sub-licences. + +2.3. This Licence does not extend to software, firmware, or code +loaded into programmable devices which may be used in conjunction with +the Documentation, the modified Documentation or with Products, unless +such software, firmware, or code is explicitly expressed to be subject +to this Licence. The use of such software, firmware, or code is +otherwise subject to the applicable licence terms and conditions. + +3. Copying, modification, communication to the public and distribution +of the Documentation + +3.1. The Licensee shall keep intact all copyright and trademarks +notices, all notices referring to Documentation Location, and all +notices that refer to this Licence and to the disclaimer of warranties +that are included in the Documentation. He shall include a copy +thereof in every copy of the Documentation or, as the case may be, +modified Documentation, that he communicates to the public or +distributes. + +3.2. The Licensee may copy, communicate to the public and distribute +verbatim copies of the Documentation, in any medium, subject to the +requirements specified in section 3.1. + +3.3. The Licensee may modify the Documentation or any portion thereof +provided that upon modification of the Documentation, the Licensee +shall make the modified Documentation available from a Documentation +Location such that it can be easily located by an original Licensor +once the Licensee communicates to the public or distributes the +modified Documentation under section 3.4, and, where required by +section 4.1, by a recipient of a Product. However, the Licensor shall +not assert his rights under the foregoing proviso unless or until a +Product is distributed. + +3.4. The Licensee may communicate to the public and distribute the +modified Documentation (thereby in addition to being a Licensee also +becoming a Licensor), always provided that he shall: + +a) comply with section 3.1; + +b) cause the modified Documentation to carry prominent notices stating +that the Licensee has modified the Documentation, with the date and +description of the modifications; + +c) cause the modified Documentation to carry a new Documentation +Location notice if the original Documentation provided for one; + +d) make available the modified Documentation at the same level of +abstraction as that of the Documentation, in the preferred format for +making modifications to it (e.g. the native format of the CAD tool as +applicable), and in the event that format is proprietary, in a format +viewable with a tool licensed under an OSI-approved license if the +proprietary tool can create it; and + +e) license the modified Documentation under the terms and conditions +of this Licence or, where applicable, a later version of this Licence +as may be issued by CERN. + +3.5. The Licence includes a non-exclusive licence to those patents or +registered designs that are held by, under the control of, or +sub-licensable by the Licensor, to the extent necessary to make use of +the rights granted under this Licence. The scope of this section 3.5 +shall be strictly limited to the parts of the Documentation or +modified Documentation created by the Licensor. + +4. Manufacture and distribution of Products + +4.1. The Licensee may manufacture or distribute Products always +provided that, where such manufacture or distribution requires a +licence under this Licence the Licensee provides to each recipient of +such Products an easy means of accessing a copy of the Documentation +or modified Documentation, as applicable, as set out in section 3. + +4.2. The Licensee is invited to inform any Licensor who has indicated +his wish to receive this information about the type, quantity and +dates of production of Products the Licensee has (had) manufactured + +5. Warranty and liability + +5.1. DISCLAIMER – The Documentation and any modified Documentation are +provided "as is" and any express or implied warranties, including, but +not limited to, implied warranties of merchantability, of satisfactory +quality, non-infringement of third party rights, and fitness for a +particular purpose or use are disclaimed in respect of the +Documentation, the modified Documentation or any Product. The Licensor +makes no representation that the Documentation, modified +Documentation, or any Product, does or will not infringe any patent, +copyright, trade secret or other proprietary right. The entire risk as +to the use, quality, and performance of a Product shall be with the +Licensee and not the Licensor. This disclaimer of warranty is an +essential part of this Licence and a condition for the grant of any +rights granted under this Licence. The Licensee warrants that it does +not act in a consumer capacity. + +5.2. LIMITATION OF LIABILITY – The Licensor shall have no liability +for direct, indirect, special, incidental, consequential, exemplary, +punitive or other damages of any character including, without +limitation, procurement of substitute goods or services, loss of use, +data or profits, or business interruption, however caused and on any +theory of contract, warranty, tort (including negligence), product +liability or otherwise, arising in any way in relation to the +Documentation, modified Documentation and/or the use, manufacture or +distribution of a Product, even if advised of the possibility of such +damages, and the Licensee shall hold the Licensor(s) free and harmless +from any liability, costs, damages, fees and expenses, including +claims by third parties, in relation to such use. + +6. General + +6.1. Except for the rights explicitly granted hereunder, this Licence +does not imply or represent any transfer or assignment of intellectual +property rights to the Licensee. + +6.2. The Licensee shall not use or make reference to any of the names +(including acronyms and abbreviations), images, or logos under which +the Licensor is known, save in so far as required to comply with +section 3. Any such permitted use or reference shall be factual and +shall in no event suggest any kind of endorsement by the Licensor or +its personnel of the modified Documentation or any Product, or any +kind of implication by the Licensor or its personnel in the +preparation of the modified Documentation or Product. + +6.3. CERN may publish updated versions of this Licence which retain +the same general provisions as this version, but differ in detail so +far this is required and reasonable. New versions will be published +with a unique version number. + +6.4. This Licence shall terminate with immediate effect, upon written +notice and without involvement of a court if the Licensee fails to +comply with any of its terms and conditions, or if the Licensee +initiates legal action against Licensor in relation to this +Licence. Section 5 shall continue to apply. diff --git a/LICENSES/GPL-2.0-or-later.txt b/LICENSES/GPL-2.0-or-later.txt new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSES/GPL-2.0-or-later.txt @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. 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. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE 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. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision 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, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..32d221d --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +# RISC-V Phone + +The goal of the this project is to develop a privacy enhanced, simple and fully featured mobile phone. + +**Technical specs**: + + - CPU: SiFive Freedom E310 (FE310-G002) microcontroller + - WiFi/BT: Espressif ESP32 + - Graphics: BT815 Display/Touch Controller + - Baseband: Mini PCIe module (SIMCom SIM7600X or Quectel EC-25) + - Audio: MAX98357A Class D amplifier / ICS-43434 MEMS Microphone + - Accelerometer: LSM9DS1 - gyro, accel, magnetometer + - Haptic driver: DRV2605L + - NXP i.MX8M System-on-Module daughterboard + +##1. Building + +Follow theese instructions to build both FE310 and ESP32 firmware. + +###1.1 Install prerequisites + +You will need the following software available on your machine: + + - git + - GNU Make + - RISC-V GNU Toolchain + - RISC-V OpenOCD + - ESP-IDF from Espressif + +Binary RISC-V GNU Toolchain and OpenOCD are available from SiFive at [https://github.com/sifive/freedom-tools/releases](https://github.com/sifive/freedom-tools/releases) + +Download and unpack the archives for your platform and export `RISCV_PATH` and `RISCV_OPENOCD_PATH` variables: + +``` +export RISCV_PATH=/path/to/riscv64-gcc +export RISCV_OPENOCD_PATH=/path/to/riscv-openocd +``` + +To install ESP-IDF follow instructions from [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html#installation-step-by-step). Install version 4.2 or later. + +###1.2 Obtain source + +This repository can be cloned by running the following command: + +``` +git clone git://majstor.org/rvPhone.git +``` + +Repository contains following directories: + + - `hw/rvPhone`: KiCad v5 project that contains schematics and board layout + - `fw/fe310`: Firmware for Freedom FE310-G002 SoC + - `fw/esp32`: Firmware for Espressif ESP32 SoC + +###1.3 Build +To build firmware for FE310 run follwing commands: + +``` +cd <path to repository>/fw/fe310 +make +cd test +make upload +``` + +To build firmware for ESP32 run following commands: + +``` +cd <path to repository>/fw/esp32 +make menuconfig +make +make flash +``` + +In `make menuconfig`, please make sure that `Enable PPP support` is selected under `Component config -> LWIP` menu and that `Notify Phase Callback`, `PAP Support` and `CHAP Support` are selected under PPP menu. + +##2. License + +Hardware licensed under the [CERN OHL v1.2](https://ohwr.org/project/licenses/wikis/cern-ohl-v1.2) + +Software licensed under the [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) + +##3. Acknowledgments + +This project is supported by the [NGI Zero PET](https://nlnet.nl/PET) project, a fund established by [NLnet](https://nlnet.nl) foundation with financial support from the European Commission's [Next Generation Internet](https://ngi.eu/) programme, under the aegis of DG Communications Networks, Content and Technology. NGI Zero PET project has received funding from the European Union's [Horizon 2020](https://ec.europa.eu/programmes/horizon2020/) research and innovation programme under grant agreement No 825310.
\ No newline at end of file |