Initial repository README and LICENSE file. Signed-off-by: Tim 'mithro' Ansell <tansell@google.com> Signed-off-by: Krishna Settaluri <krishna@bcanalog.com> Signed-off-by: Kevin Kelley <Kevin.Kelley@skywatertechnology.com>
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..3c52212 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,16 @@ +## Expected Behavior + + +## Actual Behavior + + +## Steps to Reproduce the Problem + +1. +1. +1. + +## Specifications + +- Version: +- Platform: \ No newline at end of file
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..0787bd9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,6 @@ +Fixes #<issue_number_goes_here> + +> It's a good idea to open an issue first for discussion. + +- [ ] Tests pass +- [ ] Appropriate changes to README are included in PR \ No newline at end of file
diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..23dbfa3 --- /dev/null +++ b/AUTHORS
@@ -0,0 +1,23 @@ +# This is the list of significant contributors. +# +# This does **not** necessarily list everyone who has contributed code, +# especially since many employees of one corporation may be contributing. +# To see the full list of contributors, see the revision history in +# source control. + +# Companies +Google LLC (google.com) +BlueCheetah Analog (bcanalog.com) +SkyWater Technology Foundry (skywatertechnology.com) +efabless corporation (efabless.com) + +# Individuals +tansell@google.com, me@mith.ro (Tim 'mithro' Ansell) +pgron@google.com (Per Grön) +ethanmoon@google.com (Per Grön) +kevin.kelley@skywatertechnology.com, kevin.kelly@skywater.tools (Kevin Kelley) +ayan@bcanalog.com (Ayan Biswas) +elad@bcanalog.com (Elad Alon) +eric@bcanalog.com, pkerichang@gmail.com (Eric Chang) +krishna@bcanalog.com (Krishna Settaluri) +nathan@bcanalog.com (Nathan Narevsky)
diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE
@@ -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/LICENSE.alternative b/LICENSE.alternative new file mode 100644 index 0000000..fdddfd1 --- /dev/null +++ b/LICENSE.alternative
@@ -0,0 +1,27 @@ +Copyright 2020-2021 Google LLC + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * Neither the name of Google LLC nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/README.md b/README.md new file mode 100644 index 0000000..82a8cd3 --- /dev/null +++ b/README.md
@@ -0,0 +1,26 @@ +# BAG (BAG AMS Generator) Primitives Library for [SKY130](https://github.com/google/skywater-pdk) + +This repository contains the required primitives to use BAG3 framework with +[the Google skywater-pdk, a fully open source, manufacturable PDK for +SkyWater's 130nm (SKY13) process node](https://github.com/google/skywater-pdk). + +When combined with appropriate generator code, the primitives enables the +creation of analog integrated circuits that are manufacturable at +[SkyWater Technologies](https://www.skywatertechnology.com/) commercially or +through programs like +[Google's no-cost MPW shuttle program for open source designs, done in collaboration with efabless](https://efabless.com/open_shuttle_program). + +## What is BAG? + +[BAG AMS Generator (BAG)](https://github.com/ucb-art/bag) is the 3rd generation +of the Berkeley Analog Generator framework (see also +[BAG v2 framework](https://github.com/ucb-art/bag)). + + +## License + +To enable wide compatibility with the existing BAG ecosystem, this repository +is dual-licensed. It is available to you under your choice of the +[the Apache 2.0 license](LICENSE) or a [3 clause BSD style](LICENSE.alternative). + +SPDX-License-Identifier: BSD-3-Clause OR Apache 2.0
diff --git a/docs/code-of-conduct.rst b/docs/code-of-conduct.rst new file mode 100644 index 0000000..3c58179 --- /dev/null +++ b/docs/code-of-conduct.rst
@@ -0,0 +1,68 @@ +Google Open Source Community Guidelines +--------------------------------------- + +.. community_guidelines_text + +At Google, we recognize and celebrate the creativity and collaboration +of open source contributors and the diversity of skills, experiences, +cultures, and opinions they bring to the projects and communities they +participate in. + +Every one of Google's open source projects and communities are inclusive +environments, based on treating all individuals respectfully, regardless +of gender identity and expression, sexual orientation, disabilities, +neurodiversity, physical appearance, body size, ethnicity, nationality, +race, age, religion, or similar personal characteristic. + +We value diverse opinions, but we value respectful behavior more. + +Respectful behavior includes: + +- Being considerate, kind, constructive, and helpful. +- Not engaging in demeaning, discriminatory, harassing, hateful, + sexualized, or physically threatening behavior, speech, and imagery. +- Not engaging in unwanted physical contact. + +Some Google open source projects +`may adopt <https://opensource.google/docs/releasing/preparing/#conduct>`__ +an explicit project code of conduct, which may have additional detailed +expectations for participants. Most of those projects will use our +`modified Contributor Covenant <https://opensource.google/docs/releasing/template/CODE_OF_CONDUCT/>`__. + +Resolve peacefully +~~~~~~~~~~~~~~~~~~ + +We do not believe that all conflict is necessarily bad; healthy debate +and disagreement often yields positive results. However, it is never +okay to be disrespectful. + +If you see someone behaving disrespectfully, you are encouraged to +address the behavior directly with those involved. Many issues can be +resolved quickly and easily, and this gives people more control over the +outcome of their dispute. If you are unable to resolve the matter for +any reason, or if the behavior is threatening or harassing, report it. +We are dedicated to providing an environment where participants feel +welcome and safe. + +Reporting problems +~~~~~~~~~~~~~~~~~~ + +Some Google open source projects may adopt a project-specific code of +conduct. In those cases, a Google employee will be identified as the +Project Steward, who will receive and handle reports of code of conduct +violations. In the event that a project hasn’t identified a Project +Steward, you can report problems by emailing opensource@google.com. + +We will investigate every complaint, but you may not receive a direct +response. We will use our discretion in determining when and how to +follow up on reported incidents, which may range from not taking action +to permanent expulsion from the project and project-sponsored spaces. We +will notify the accused of the report and provide them an opportunity to +discuss it before any action is taken. The identity of the reporter will +be omitted from the details of the report supplied to the accused. In +potentially harmful situations, such as ongoing harassment or threats to +anyone's safety, we may take action without notice. + +*This document was adapted from the* +`IndieWeb Code of Conduct <https://indieweb.org/code-of-conduct>`_ +*and can also be found at* <https://opensource.google/conduct/>.
diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 0000000..14f6b0f --- /dev/null +++ b/docs/contributing.rst
@@ -0,0 +1,36 @@ +How to Contribute +================= + +We'd love to accept your patches and contributions to this project. +There are just a few small guidelines you need to follow. + +Contributor License Agreement +----------------------------- + +Contributions to this project must be accompanied by a Contributor +License Agreement. You (or your employer) retain the copyright to your +contribution; this simply gives us permission to use and redistribute +your contributions as part of the project. Head over to +https://cla.developers.google.com/ to see your current agreements on +file or to sign a new one. + +You generally only need to submit a CLA once, so if you've already +submitted one (even if it was for a different project), you probably +don't need to do it again. + +Code reviews +------------ + +All submissions, including submissions by project members, require +review. We use GitHub pull requests for this purpose. Consult `GitHub +Help <https://help.github.com/articles/about-pull-requests/>`__ for more +information on using pull requests. + +Community Guidelines +-------------------- + +This project follows `Google's Open Source Community +Guidelines <https://opensource.google/conduct/>`__. + +.. include:: code-of-conduct.rst + :start-after: community_guidelines_text
diff --git a/docs/license_header.txt b/docs/license_header.txt new file mode 100644 index 0000000..a0fce4a --- /dev/null +++ b/docs/license_header.txt
@@ -0,0 +1,19 @@ +Copyright 2021 SkyWater PDK Authors + +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 + + https://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. + +This code is *alternatively* available under a BSD-3-Clause license, see +details in the README.md at the top level and the license text at +https://github.com/google/skywater-pdk-libs-sky130_bag3_pr/blob/master/LICENSE.alternative + +SPDX-License-Identifier: BSD-3-Clause OR Apache 2.0