Go to file
marwaneltoukhy 934cf4e709 changed spef and sdf files locations 2022-10-13 10:32:09 -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 add mgmt_protect 2022-10-13 10:11:45 -07:00
docs Error in User Area Base Address (#97) 2022-09-29 07:14:41 -07:00
gds add mgmt_protect 2022-10-13 10:11:45 -07:00
lef add mgmt_protect 2022-10-13 10:11:45 -07:00
lib add mgmt_protect 2022-10-13 10:11:45 -07:00
mag add mgmt_protect 2022-10-13 10:11:45 -07:00
maglef add mgmt_protect 2022-10-13 10:11:45 -07:00
openlane add mgmt_protect 2022-10-13 10:11:45 -07:00
scripts changed build script to load mgmt_core_wrapper mag 2022-10-13 13:13:52 +02:00
sdc add mgmt_protect 2022-10-13 10:11:45 -07:00
sdf changed spef and sdf files locations 2022-10-13 10:22:57 -07:00
signoff changed spef and sdf files locations 2022-10-13 10:32:09 -07:00
spef changed spef and sdf files locations 2022-10-13 10:32:09 -07:00
spi/lvs add mgmt_protect 2022-10-13 10:11:45 -07:00
verilog add mgmt_protect 2022-10-13 10:11:45 -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 updated openlane and open_pdks commit 2022-10-11 10:15: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 Merge pull request #165 from efabless/misc-rtl-changes 2022-10-11 10:48:18 +02: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