Go to file
R. Timothy Edwards b2089fe9eb
Corrected the gpio_control_block so that the user_gpio_out signal (#89)
does not pass through an inverter, so that the input can remain
unconnected.  Rewired the existing implementation to use an
alternative gate that has an inverting input so that the
user_gpio_out signal can be left undriven when the GPIOs are in
the management enable state.  This is a simple logic refactoring
and does not change the logic function.  The manual rewiring has
been confirmed by LVS, but at least one GL simulation should be
run to confirm that the logic function remains the same as before.
2022-04-25 11:27:41 -07:00
.github/workflows Update auto-update-caravel-lite.yml 2022-02-02 00:52:23 +02:00
.travisCI add documentation 2021-12-17 11:55:08 -08:00
def gpio_control_block constrains fix (#69) 2022-04-15 11:50:54 -07:00
docs Fix GPIO digital mode 010 description (#21) 2022-04-07 07:46:20 -07:00
gds gpio_control_block constrains fix (#69) 2022-04-15 11:50:54 -07:00
lef gpio_control_block constrains fix (#69) 2022-04-15 11:50:54 -07:00
mag Corrected the gpio_control_block so that the user_gpio_out signal (#89) 2022-04-25 11:27:41 -07:00
maglef gpio_control_block constrains fix (#69) 2022-04-15 11:50:54 -07:00
openlane Fix upstream breakage due to missing docker mount (#80) 2022-04-21 05:34:37 -07:00
scripts Fix verilog gpio_defaults_block replacement for gpio 0-4 (#87) 2022-04-23 17:57:34 -07:00
sdc gpio_control_block constrains fix (#69) 2022-04-15 11:50:54 -07:00
sdf gpio_control_block constrains fix (#69) 2022-04-15 11:50:54 -07:00
signoff gpio_control_block constrains fix (#69) 2022-04-15 11:50:54 -07:00
spef gpio_control_block constrains fix (#69) 2022-04-15 11:50:54 -07:00
spi/lvs gpio_control_block constrains fix (#69) 2022-04-15 11:50:54 -07:00
verilog Corrected the gpio_control_block so that the user_gpio_out signal (#89) 2022-04-25 11:27:41 -07:00
xschem Introduction of PDK variable (#39) 2022-04-08 09:05:58 -07:00
.gitignore - update gpio_control_block config (#57) 2022-04-08 09:27:51 -07:00
.readthedocs.yml add documentation 2021-12-17 11:55:08 -08:00
.travis.yml add documentation 2021-12-17 11:55:08 -08:00
LICENSE Create LICENSE 2021-12-15 23:53:39 -08:00
Makefile Updating magic version for pdk build to 8.3.277 2022-04-24 06:45:00 -07:00
README.rst Quick fix to a layout route for DRC (#84) 2022-04-22 15:10:31 -07:00
README.src.rst add documentation 2021-12-17 11:55:08 -08:00
manifest Corrects four signal routes which were missing from the caravan top level (#88) 2022-04-25 08:50:55 -07:00

README.src.rst

.. raw:: html

   <!---
   # SPDX-FileCopyrightText: 2020 Efabless Corporation
   #
   # 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.
   #
   # SPDX-License-Identifier: Apache-2.0
   -->

Caravel Harness
===============

|License| |Documentation Status| |Build Status|

.. note::

   Documentation for this project is being updated to reflect the changes
   for the new redesigned version of Caravel.

Table of contents
=================

-  `Overview <#overview>`__
-  `Caravel Architecture <#caravel-architecture>`__
-  `Quick Start for User Projects  <#quick-start-for-user-projects>`__

   - `Digital User Project <#digital-user-project>`__
   - `Analog User Project <#analog-user-project>`__

-  `Required Directory Structure <#required-directory-structure>`__
-  `Additional Material <#additional-material>`__

Overview
========

Caravel is a template SoC for Efabless Open MPW and chipIgnite shuttles based on the Sky130 node from SkyWater Technologies. The
current SoC architecture is given below.

.. image:: docs/source/_static/caravel_block_diagram.jpg
    :align: center

Datasheet and detailed documentation exist `here <https://caravel-harness.readthedocs.io/>`__

.. include:: docs/source/getting-started.rst

.. |License| image:: https://img.shields.io/github/license/efabless/caravel
   :alt: GitHub license - Apache 2.0
   :target: https://github.com/efabless/caravel
.. |Documentation Status| image:: https://readthedocs.org/projects/caravel-harness/badge/?version=latest
   :alt: ReadTheDocs Badge - https://caravel-harness.rtfd.io
   :target: https://caravel-harness.readthedocs.io/en/latest/?badge=latest
.. |Build Status| image:: https://travis-ci.com/efabless/caravel.svg?branch=master
   :alt: Travis Badge - https://travis-ci.org/efabless/caravel
   :target: https://travis-ci.com/efabless/caravel