Go to file
Tim Edwards 298ede362b Corrects an issue with the user pass-through flash programming
mode in which the data and clock are activated simultaneously,
so the first data bit after CSB goes low may or may not be
seen by the SPI flash.
2022-06-07 10:42:56 -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 Remove gpio_defaults_block_*.def (#91) 2022-04-25 20:55:43 -07:00
docs add links to litex core (#96) 2022-05-08 22:52:47 -07:00
gds Fix the simple_por to (logically) isolate the 1.8V and 3.3V grounds. (#90) 2022-05-08 22:51:29 -07:00
lef gpio_control_block constrains fix (#69) 2022-04-15 11:50:54 -07:00
mag Fix the simple_por to (logically) isolate the 1.8V and 3.3V grounds. (#90) 2022-05-08 22:51:29 -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 Modified the set_user_id.py script so that mode "-report" returns a valid value. (#93) 2022-05-08 22:50:48 -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 Corrects an issue with the user pass-through flash programming 2022-06-07 10:42:56 -04: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 Fix commit id defines 2022-04-25 14:02:35 -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 Modified the set_user_id.py script so that mode "-report" returns a valid value. (#93) 2022-05-08 22:50:48 -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