Go to file
D. Mitch Bailey e82ddeb0b7 Ignore comments and add error checking.
Require default constants in 13'hxxxx format.
Require default constants to be 13 binary bits maximum.
Standardize file names to lower case hex digits.

NOTE: Invalid values are merely ignored. No error code is returned.
2024-05-02 22:30:23 -07: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 2023-10-22 10:08:28 +03:00
.travisCI add documentation 2021-12-17 11:55:08 -08:00
def Added the set of missing pins on the 2nd of the two vccd1/vssd1 power 2023-10-01 21:11:33 -04:00
docs New TRM document 2024-04-15 08:35:27 -07:00
gds Add files via upload 2023-10-08 14:05:22 +03:00
lef reharden `caravan` to fix outer pins labeling 2023-05-29 06:47:03 -07:00
lib edited the `max_tran=0` constraint in the lib files 2023-05-24 13:57:41 -07:00
mag Revert the user_id_programming.mag file back to the state it was 2023-11-04 21:08:20 -04:00
maglef swapped the left `vssd` and `vccd` rings in `caravan_core` to fix an LVS issue 2023-05-30 22:33:33 -07:00
openlane ~ update `caravan` mag and openlane config with the `caravan` specific logo, motto, and copyright 2023-06-01 10:10:11 -07:00
scripts Ignore comments and add error checking. 2024-05-02 22:30:23 -07:00
signoff - remove outdated physical verification results 2023-06-01 06:37:36 -07:00
spef update the physical views for `caravel_core` as the previous ones had issues in integration 2023-04-11 07:43:05 -07:00
spi/lvs added physical verification reports 2023-05-31 11:09:10 +03:00
verilog Merge pull request #498 from efabless/remove_cocotb 2023-10-23 08:00:35 -07:00
xschem Copied files from the original pull request into a new one. Includes 2023-05-08 16:29:24 -04:00
.gitignore - update gpio_control_block config (#57) 2022-04-08 09:27:51 -07:00
.readthedocs.yml Update .readthedocs.yml 2023-11-12 15:02:35 +02: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 tag = mpw-9f 2023-11-05 10:47:16 -08: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 2023-12-06 04:11:14 +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