Go to file
Passant f79ebfae82 update caravan timing reports:
- add timing reports as a tarball per RC corner and *files.txt include the files archived in the *tar.gz
- *global.rpt and *all_viol.rpt could be checked for a summary of the results
2022-11-11 07:03:19 -08:00
.githooks misc: scripts to prevent & fix bad mag paths 2022-10-18 04:51:32 -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 Update Openlane views 2022-10-27 09:53:45 -07:00
docs Added documentation for ECOs done on caravel 2022-10-28 16:45:12 +02:00
gds Added LVS result for caravel and the scripts to run LVS (using the 2022-11-11 07:43:16 -05:00
lef added views for caravel and caravan and fixed lvs in power routing 2022-10-28 15:23:00 -07:00
mag updated caravel and caravan mag views to fix the default block issues 2022-11-10 16:15:23 -08:00
maglef Update Openlane views 2022-10-27 09:53:45 -07:00
openlane Update Openlane views 2022-10-27 09:53:45 -07:00
scripts update signoff scripts with: 2022-11-11 02:52:32 -08:00
signoff update caravan timing reports: 2022-11-11 07:03:19 -08:00
spi/lvs Merge pull request #356 from efabless/caravel_redesign-2 2022-10-29 08:08:15 -07:00
verilog Update cocotb README file to include PDK export requirements 2022-10-30 01:47:46 -07:00
xschem Fix the simple_por to (logically) isolate the 1.8V and 3.3V grounds. (#90) 2022-05-08 22:51:29 -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 Update Makefile 2022-10-29 08:13:41 -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 Fixes to caravan for LVS and ERC (#330) 2022-10-21 14:28:53 -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