Go to file
Tim Edwards 680353f7a7 This corrects a shorted net in the caravel top level layout.
Still evaluating why the layout does not pass LVS like it did
previously, although all current LVS errors appear to be related
to magic's extraction of the isolated substrates, and do not
imply functional issues.  Also, LVS has only been done on the
top level.
2022-04-09 14:23:19 -04: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 updates to top level caravel (#59) 2022-04-08 09:31:33 -07:00
docs Fix GPIO digital mode 010 description (#21) 2022-04-07 07:46:20 -07:00
gds updates to top level caravel (#59) 2022-04-08 09:31:33 -07:00
lef Mgmt protect update (#58) 2022-04-08 09:29:49 -07:00
mag This corrects a shorted net in the caravel top level layout. 2022-04-09 14:23:19 -04:00
maglef Mgmt protect update (#58) 2022-04-08 09:29:49 -07:00
openlane updates to top level caravel (#59) 2022-04-08 09:31:33 -07:00
scripts Introduction of PDK variable (#39) 2022-04-08 09:05:58 -07:00
sdc Mgmt protect update (#58) 2022-04-08 09:29:49 -07:00
sdf Mgmt protect update (#58) 2022-04-08 09:29:49 -07:00
signoff Mgmt protect update (#58) 2022-04-08 09:29:49 -07:00
spef Mgmt protect update (#58) 2022-04-08 09:29:49 -07:00
spi/lvs Mgmt protect update (#58) 2022-04-08 09:29:49 -07:00
verilog updates to top level caravel (#59) 2022-04-08 09:31:33 -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 Introduction of PDK variable (#39) 2022-04-08 09:05:58 -07:00
README.rst Apply automatic changes to Manifest and README.rst 2021-12-27 00:00:00 +00:00
README.src.rst add documentation 2021-12-17 11:55:08 -08:00
manifest Corrected the issue reported on the github issue tracker (#34) (#50) 2022-04-07 07:44:57 -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