Go to file
Tim Edwards 589f351dcb Additional modification to move pins up into an uncongested area
above housekeeping, because the upper GPIO pins are in the wrong
place relative to the new GPIO signal routing below the SoC.
Added pins for the pass-through connections.  Unconnected/
unrouted OEB pins are still not present and probably should be
removed from the RTL.
2022-10-16 10:52:53 -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 Additional modification to move pins up into an uncongested area 2022-10-16 10:52:53 -04:00
docs Error in User Area Base Address (#97) 2022-09-29 07:14:41 -07:00
gds Additional modification to move pins up into an uncongested area 2022-10-16 10:52:53 -04:00
lef Additional modification to move pins up into an uncongested area 2022-10-16 10:52:53 -04:00
lib Add mgmt_protect views and openlane files 2022-10-15 01:46:22 -07:00
mag Additional modification to move pins up into an uncongested area 2022-10-16 10:52:53 -04:00
maglef Merge pull request #254 from mo-hosni/hk_without_lables 2022-10-16 13:38:02 +02:00
openlane Merge pull request #254 from mo-hosni/hk_without_lables 2022-10-16 13:38:02 +02:00
scripts Merge branch 'caravel_redesign' into fix_top_buffers_again 2022-10-16 10:05:36 -04:00
sdf reharden: caravel_clocking 2022-10-14 05:24:49 -07:00
signoff Merge pull request #254 from mo-hosni/hk_without_lables 2022-10-16 13:38:02 +02:00
spef reharden: caravel_clocking 2022-10-14 05:24:49 -07:00
spi/lvs Merge pull request #254 from mo-hosni/hk_without_lables 2022-10-16 13:38:02 +02:00
verilog add mgmt_protect views and openlane files 2022-10-16 03:14:55 -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-15 07:51:47 -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 Apply automatic changes to Manifest and README.rst 2022-10-15 15:49:11 +00: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