diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..6703dedd --- /dev/null +++ b/README.rst @@ -0,0 +1,255 @@ +.. raw:: html + + + +Caravel Harness +=============== + +|License| |Documentation Status| |Build Status| + +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 Google SKY130 free shuttles. The +current SoC architecture is given below. + +.. raw:: html + +

+ +

+ +Datasheet and detailed documentation exist `here `__ + +.. raw:: html + + +.. _getting-started: + +Caravel Architecture +==================== + +Caravel is composed of three main sub-blocks: *management area*, *storage area*, and *user project area*. + +.. _management-area: + +Management Area +-------------- + +The managment area includes a `picorv32 `__ based SoC that includes a number of periphrals like timers, uart, and gpio. The managemnt area runs firmware that can be used to: + +- Configure User Project I/O pads +- Observe and control User Project signals (through on-chip logic + analyzer probes) +- Control the User Project power supply + +For a complete list of the SoC periphrals, check the `memory map `__ + +.. _storage-area: + +Storage Area +-------------- + +The storage area is an auxiliary storage space for the managment SoC. It holds two dual port RAM blocks (1KB) generated by +`OpenRAM `__ + +The storage area is only accessible by the management SoC. + +.. _user-project-area: + +User Project Area +-------------- + +This is the user space. It has a limited silicon area ``2.92mm x 3.52mm`` as well as a fixed number of I/O pads ``38`` and power pads ``4``. + +The user space has access to the following utilities provided by the management SoC: + +- ``38`` IO Ports +- ``128`` Logic analyzer probes +- Wishbone port connection to the management SoC wishbone bus. + + +Quick Start for User Projects +============================= + +Your area is the full user space, so feel free to add your +project there or create a differnt macro and harden it seperately then +insert it into the ``user_project_wrapper`` for digital projects or insert it into ``user_project_analog_wrapper`` for analog projects. + +.. _digital-user-project: + +Digital User Project +-------------------- + +If you are building a digital project for the user space, check a sample project at `caravel_user_project `__. + +If you will use OpenLANE to harden your design, go through the instructions in this `README `__. + +Digital user projects should adhere the following requirements: + +- Top module is named ``user_project_wrapper`` + + +- The ``user_project_wrapper`` adheres to the pin order defined at `Digital Wrapper Pin Order `__. + + +- The ``user_project_wrapper`` adheres to the fixed design configurations at `Digital Wrapper Fixed Configuration `__. + + +- The user project repository adheres to the `Required Directory Structure <#required-directory-structure>`__. + + +.. _analog-user-project: + +Analog User Project +------------------ + +If you are building an analog project for the user space, check a sample project at `caravel_user_project_analog `__. + +Analog user projects should adhere the following requirements: + +- Top module is named ``user_analog_project_wrapper`` + +- The ``user_analog_project_wrapper`` uses the `empty analog wrapper `__. + +- The ``user_analog_project_wrapper`` adheres to the same pin order and placement of the `empty analog wrapper `__. + +------ + +IMPORTANT +^^^^^^^^^ + +Please make sure to run ``make compress`` before commiting anything to +your repository. Avoid having 2 versions of the +``gds/user_project_wrapper.gds`` one compressed and the +other not compressed. + +For information on tooling and versioning, please refer to `tool-versioning.rst <./docs/source/tool-versioning.rst>`__. + +----- + +Required Directory Structure +============================ + +- ``gds/`` : includes all the gds files used or produced from the + project. +- ``def`` : includes all the def files used or produced from the + project. +- ``lef/`` : includes all the lef files used or produced from the + project. +- ``mag/`` : includes all the mag files used or produced from the + project. +- ``maglef`` : includes all the maglef files used or produced from the + project. +- ``spi/lvs/`` : includes all the spice files used or produced from the + project. +- ``verilog/dv`` : includes all the simulation test benches and how to + run them. +- ``verilog/gl/`` : includes all the synthesized/elaborated netlists. +- ``verilog/rtl`` : includes all the Verilog RTLs and source files. +- ``openlane//`` : includes all configuration files used to + run openlane on your project. +- ``info.yaml``: includes all the info required in `this + example `__. Please make sure that you are pointing to an + elaborated caravel netlist as well as a synthesized + gate-level-netlist for the `user_project_wrapper` + + +**NOTE:** + + If you're using openlane to harden your design, the ``verilog/gl`` ``def/`` ``lef/`` ``gds/`` ``mag`` ``maglef`` directories should + be automatically populated by openlane. + +.. _additional-material: + +Additional Material +=============== + +.. _mpw-two: + +MPW Two +-------- + +- `Open MPW Program - MPW-TWO Walkthrough `__ +- `MPW Two Shuttle Program `__ + +.. _mpw-one: + +MPW One +-------------- + +- `Caravel User Project Features -- What are the utilities provided by caravel to the user project ? `__ +- `Aboard Caravel -- How to integrate your design with Caravel? `__ +- `Things to Clarify About Caravel -- What versions to use with Caravel? `__ +- `45 Chips in 30 Days: Open Source ASIC at its best! `__ + +Check `mpw-one-final `__ for the caravel used for the mpw-one tapeout. + +> :warning: You don't need to integrate your design with Caravel GDS for **MPW two**. Running ``make ship`` is no longer required. + + +.. |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 + +.. |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 + diff --git a/README.src.rst b/README.src.rst new file mode 100755 index 00000000..e47d424e --- /dev/null +++ b/README.src.rst @@ -0,0 +1,63 @@ +.. raw:: html + + + +Caravel Harness +=============== + +|License| |Documentation Status| |Build Status| + +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 Google SKY130 free shuttles. The +current SoC architecture is given below. + +.. raw:: html + +

+ +

+ +Datasheet and detailed documentation exist `here `__ + +.. 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 diff --git a/doc/.gitignore b/docs/.gitignore similarity index 100% rename from doc/.gitignore rename to docs/.gitignore diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/README b/docs/README similarity index 100% rename from doc/README rename to docs/README diff --git a/doc/environment.yml b/docs/environment.yml similarity index 100% rename from doc/environment.yml rename to docs/environment.yml diff --git a/doc/memory_map.txt b/docs/memory_map.txt similarity index 100% rename from doc/memory_map.txt rename to docs/memory_map.txt diff --git a/doc/other/clamp_list.txt b/docs/other/clamp_list.txt similarity index 100% rename from doc/other/clamp_list.txt rename to docs/other/clamp_list.txt diff --git a/doc/pdf/caravel_block_diagram.pdf b/docs/pdf/caravel_block_diagram.pdf similarity index 100% rename from doc/pdf/caravel_block_diagram.pdf rename to docs/pdf/caravel_block_diagram.pdf diff --git a/doc/pdf/caravel_clocking.pdf b/docs/pdf/caravel_clocking.pdf similarity index 100% rename from doc/pdf/caravel_clocking.pdf rename to docs/pdf/caravel_clocking.pdf diff --git a/doc/pdf/caravel_floorplan.pdf b/docs/pdf/caravel_floorplan.pdf similarity index 100% rename from doc/pdf/caravel_floorplan.pdf rename to docs/pdf/caravel_floorplan.pdf diff --git a/doc/pdf/counter_timer_function.pdf b/docs/pdf/counter_timer_function.pdf similarity index 100% rename from doc/pdf/counter_timer_function.pdf rename to docs/pdf/counter_timer_function.pdf diff --git a/doc/pdf/gpio_function.pdf b/docs/pdf/gpio_function.pdf similarity index 100% rename from doc/pdf/gpio_function.pdf rename to docs/pdf/gpio_function.pdf diff --git a/doc/pdf/housekeeping_function.pdf b/docs/pdf/housekeeping_function.pdf similarity index 100% rename from doc/pdf/housekeeping_function.pdf rename to docs/pdf/housekeeping_function.pdf diff --git a/doc/pdf/irq_function.pdf b/docs/pdf/irq_function.pdf similarity index 100% rename from doc/pdf/irq_function.pdf rename to docs/pdf/irq_function.pdf diff --git a/doc/pdf/memory_map.pdf b/docs/pdf/memory_map.pdf similarity index 100% rename from doc/pdf/memory_map.pdf rename to docs/pdf/memory_map.pdf diff --git a/doc/pdf/monitor_function.pdf b/docs/pdf/monitor_function.pdf similarity index 100% rename from doc/pdf/monitor_function.pdf rename to docs/pdf/monitor_function.pdf diff --git a/doc/pdf/openframe_pinout.pdf b/docs/pdf/openframe_pinout.pdf similarity index 100% rename from doc/pdf/openframe_pinout.pdf rename to docs/pdf/openframe_pinout.pdf diff --git a/doc/pdf/qspi_function.pdf b/docs/pdf/qspi_function.pdf similarity index 100% rename from doc/pdf/qspi_function.pdf rename to docs/pdf/qspi_function.pdf diff --git a/doc/pdf/spi_master_function.pdf b/docs/pdf/spi_master_function.pdf similarity index 100% rename from doc/pdf/spi_master_function.pdf rename to docs/pdf/spi_master_function.pdf diff --git a/doc/pdf/uart_function.pdf b/docs/pdf/uart_function.pdf similarity index 100% rename from doc/pdf/uart_function.pdf rename to docs/pdf/uart_function.pdf diff --git a/doc/postscript/caravel_block_diagram.ps b/docs/postscript/caravel_block_diagram.ps similarity index 100% rename from doc/postscript/caravel_block_diagram.ps rename to docs/postscript/caravel_block_diagram.ps diff --git a/doc/postscript/caravel_clocking.ps b/docs/postscript/caravel_clocking.ps similarity index 100% rename from doc/postscript/caravel_clocking.ps rename to docs/postscript/caravel_clocking.ps diff --git a/doc/postscript/caravel_floorplan.ps b/docs/postscript/caravel_floorplan.ps similarity index 100% rename from doc/postscript/caravel_floorplan.ps rename to docs/postscript/caravel_floorplan.ps diff --git a/doc/postscript/counter_timer_function.ps b/docs/postscript/counter_timer_function.ps similarity index 100% rename from doc/postscript/counter_timer_function.ps rename to docs/postscript/counter_timer_function.ps diff --git a/doc/postscript/gpio_function.ps b/docs/postscript/gpio_function.ps similarity index 100% rename from doc/postscript/gpio_function.ps rename to docs/postscript/gpio_function.ps diff --git a/doc/postscript/housekeeping_function.ps b/docs/postscript/housekeeping_function.ps similarity index 100% rename from doc/postscript/housekeeping_function.ps rename to docs/postscript/housekeeping_function.ps diff --git a/doc/postscript/irq_function.ps b/docs/postscript/irq_function.ps similarity index 100% rename from doc/postscript/irq_function.ps rename to docs/postscript/irq_function.ps diff --git a/doc/postscript/memory_map.ps b/docs/postscript/memory_map.ps similarity index 100% rename from doc/postscript/memory_map.ps rename to docs/postscript/memory_map.ps diff --git a/doc/postscript/monitor_function.ps b/docs/postscript/monitor_function.ps similarity index 100% rename from doc/postscript/monitor_function.ps rename to docs/postscript/monitor_function.ps diff --git a/doc/postscript/openframe_pinout.ps b/docs/postscript/openframe_pinout.ps similarity index 100% rename from doc/postscript/openframe_pinout.ps rename to docs/postscript/openframe_pinout.ps diff --git a/doc/postscript/qspi_function.ps b/docs/postscript/qspi_function.ps similarity index 100% rename from doc/postscript/qspi_function.ps rename to docs/postscript/qspi_function.ps diff --git a/doc/postscript/spi_master_function.ps b/docs/postscript/spi_master_function.ps similarity index 100% rename from doc/postscript/spi_master_function.ps rename to docs/postscript/spi_master_function.ps diff --git a/doc/postscript/uart_function.ps b/docs/postscript/uart_function.ps similarity index 100% rename from doc/postscript/uart_function.ps rename to docs/postscript/uart_function.ps diff --git a/doc/requirements.txt b/docs/requirements.txt similarity index 100% rename from doc/requirements.txt rename to docs/requirements.txt diff --git a/doc/source/_static/Google_logo.svg b/docs/source/_static/Google_logo.svg similarity index 100% rename from doc/source/_static/Google_logo.svg rename to docs/source/_static/Google_logo.svg diff --git a/doc/source/_static/bond_plan.svg b/docs/source/_static/bond_plan.svg similarity index 100% rename from doc/source/_static/bond_plan.svg rename to docs/source/_static/bond_plan.svg diff --git a/doc/source/_static/caravel.png b/docs/source/_static/caravel.png similarity index 100% rename from doc/source/_static/caravel.png rename to docs/source/_static/caravel.png diff --git a/doc/source/_static/caravel_harness.png b/docs/source/_static/caravel_harness.png similarity index 100% rename from doc/source/_static/caravel_harness.png rename to docs/source/_static/caravel_harness.png diff --git a/doc/source/_static/caravel_harness_die.svg b/docs/source/_static/caravel_harness_die.svg similarity index 100% rename from doc/source/_static/caravel_harness_die.svg rename to docs/source/_static/caravel_harness_die.svg diff --git a/doc/source/_static/caravel_management_soc_simplified_block_diagram.svg b/docs/source/_static/caravel_management_soc_simplified_block_diagram.svg similarity index 100% rename from doc/source/_static/caravel_management_soc_simplified_block_diagram.svg rename to docs/source/_static/caravel_management_soc_simplified_block_diagram.svg diff --git a/doc/source/_static/counter_32.png b/docs/source/_static/counter_32.png similarity index 100% rename from doc/source/_static/counter_32.png rename to docs/source/_static/counter_32.png diff --git a/doc/source/_static/die_pads.svg b/docs/source/_static/die_pads.svg similarity index 100% rename from doc/source/_static/die_pads.svg rename to docs/source/_static/die_pads.svg diff --git a/doc/source/_static/efabless_lg_logo.png b/docs/source/_static/efabless_lg_logo.png similarity index 100% rename from doc/source/_static/efabless_lg_logo.png rename to docs/source/_static/efabless_lg_logo.png diff --git a/doc/source/_static/gpio.svg b/docs/source/_static/gpio.svg similarity index 100% rename from doc/source/_static/gpio.svg rename to docs/source/_static/gpio.svg diff --git a/doc/source/_static/gpio_pads.svg b/docs/source/_static/gpio_pads.svg similarity index 100% rename from doc/source/_static/gpio_pads.svg rename to docs/source/_static/gpio_pads.svg diff --git a/doc/source/_static/housekeeping_spi_register_map.svg b/docs/source/_static/housekeeping_spi_register_map.svg similarity index 100% rename from doc/source/_static/housekeeping_spi_register_map.svg rename to docs/source/_static/housekeeping_spi_register_map.svg diff --git a/doc/source/_static/housekeeping_spi_signalling.svg b/docs/source/_static/housekeeping_spi_signalling.svg similarity index 100% rename from doc/source/_static/housekeeping_spi_signalling.svg rename to docs/source/_static/housekeeping_spi_signalling.svg diff --git a/doc/source/_static/mgmt_soc_memory_map.png b/docs/source/_static/mgmt_soc_memory_map.png similarity index 100% rename from doc/source/_static/mgmt_soc_memory_map.png rename to docs/source/_static/mgmt_soc_memory_map.png diff --git a/doc/source/_static/package_as_viewed_from_the_bottom.svg b/docs/source/_static/package_as_viewed_from_the_bottom.svg similarity index 100% rename from doc/source/_static/package_as_viewed_from_the_bottom.svg rename to docs/source/_static/package_as_viewed_from_the_bottom.svg diff --git a/doc/source/_static/pcb_example_route_pattern.svg b/docs/source/_static/pcb_example_route_pattern.svg similarity index 100% rename from doc/source/_static/pcb_example_route_pattern.svg rename to docs/source/_static/pcb_example_route_pattern.svg diff --git a/doc/source/_static/plus.png b/docs/source/_static/plus.png similarity index 100% rename from doc/source/_static/plus.png rename to docs/source/_static/plus.png diff --git a/doc/source/_static/power_domain_splits.svg b/docs/source/_static/power_domain_splits.svg similarity index 100% rename from doc/source/_static/power_domain_splits.svg rename to docs/source/_static/power_domain_splits.svg diff --git a/doc/source/_static/reg_gpio_data.svg b/docs/source/_static/reg_gpio_data.svg similarity index 100% rename from doc/source/_static/reg_gpio_data.svg rename to docs/source/_static/reg_gpio_data.svg diff --git a/doc/source/_static/reg_gpio_ena.svg b/docs/source/_static/reg_gpio_ena.svg similarity index 100% rename from doc/source/_static/reg_gpio_ena.svg rename to docs/source/_static/reg_gpio_ena.svg diff --git a/doc/source/_static/reg_gpio_pd.svg b/docs/source/_static/reg_gpio_pd.svg similarity index 100% rename from doc/source/_static/reg_gpio_pd.svg rename to docs/source/_static/reg_gpio_pd.svg diff --git a/doc/source/_static/reg_gpio_pu.svg b/docs/source/_static/reg_gpio_pu.svg similarity index 100% rename from doc/source/_static/reg_gpio_pu.svg rename to docs/source/_static/reg_gpio_pu.svg diff --git a/doc/source/_static/reg_irq7_source.svg b/docs/source/_static/reg_irq7_source.svg similarity index 100% rename from doc/source/_static/reg_irq7_source.svg rename to docs/source/_static/reg_irq7_source.svg diff --git a/doc/source/_static/reg_pll_out_dest.svg b/docs/source/_static/reg_pll_out_dest.svg similarity index 100% rename from doc/source/_static/reg_pll_out_dest.svg rename to docs/source/_static/reg_pll_out_dest.svg diff --git a/doc/source/_static/reg_spi_config.svg b/docs/source/_static/reg_spi_config.svg similarity index 100% rename from doc/source/_static/reg_spi_config.svg rename to docs/source/_static/reg_spi_config.svg diff --git a/doc/source/_static/reg_spi_data.svg b/docs/source/_static/reg_spi_data.svg similarity index 100% rename from doc/source/_static/reg_spi_data.svg rename to docs/source/_static/reg_spi_data.svg diff --git a/doc/source/_static/reg_spictrl.svg b/docs/source/_static/reg_spictrl.svg similarity index 100% rename from doc/source/_static/reg_spictrl.svg rename to docs/source/_static/reg_spictrl.svg diff --git a/doc/source/_static/reg_timer0_config.svg b/docs/source/_static/reg_timer0_config.svg similarity index 100% rename from doc/source/_static/reg_timer0_config.svg rename to docs/source/_static/reg_timer0_config.svg diff --git a/doc/source/_static/reg_timer0_data.svg b/docs/source/_static/reg_timer0_data.svg similarity index 100% rename from doc/source/_static/reg_timer0_data.svg rename to docs/source/_static/reg_timer0_data.svg diff --git a/doc/source/_static/reg_timer0_value.svg b/docs/source/_static/reg_timer0_value.svg similarity index 100% rename from doc/source/_static/reg_timer0_value.svg rename to docs/source/_static/reg_timer0_value.svg diff --git a/doc/source/_static/reg_timer1_config.svg b/docs/source/_static/reg_timer1_config.svg similarity index 100% rename from doc/source/_static/reg_timer1_config.svg rename to docs/source/_static/reg_timer1_config.svg diff --git a/doc/source/_static/reg_timer1_data.svg b/docs/source/_static/reg_timer1_data.svg similarity index 100% rename from doc/source/_static/reg_timer1_data.svg rename to docs/source/_static/reg_timer1_data.svg diff --git a/doc/source/_static/reg_timer1_value.svg b/docs/source/_static/reg_timer1_value.svg similarity index 100% rename from doc/source/_static/reg_timer1_value.svg rename to docs/source/_static/reg_timer1_value.svg diff --git a/doc/source/_static/reg_trap_out_dest.svg b/docs/source/_static/reg_trap_out_dest.svg similarity index 100% rename from doc/source/_static/reg_trap_out_dest.svg rename to docs/source/_static/reg_trap_out_dest.svg diff --git a/doc/source/_static/reg_uart_clkdiv.svg b/docs/source/_static/reg_uart_clkdiv.svg similarity index 100% rename from doc/source/_static/reg_uart_clkdiv.svg rename to docs/source/_static/reg_uart_clkdiv.svg diff --git a/doc/source/_static/reg_uart_data.svg b/docs/source/_static/reg_uart_data.svg similarity index 100% rename from doc/source/_static/reg_uart_data.svg rename to docs/source/_static/reg_uart_data.svg diff --git a/doc/source/_static/reg_uart_enable.svg b/docs/source/_static/reg_uart_enable.svg similarity index 100% rename from doc/source/_static/reg_uart_enable.svg rename to docs/source/_static/reg_uart_enable.svg diff --git a/doc/source/_static/single_gpio_pad_structure_used_all_pads_except_0_and_1.svg b/docs/source/_static/single_gpio_pad_structure_used_all_pads_except_0_and_1.svg similarity index 100% rename from doc/source/_static/single_gpio_pad_structure_used_all_pads_except_0_and_1.svg rename to docs/source/_static/single_gpio_pad_structure_used_all_pads_except_0_and_1.svg diff --git a/doc/source/_static/single_gpio_pad_structure_used_for_pad_0_and_pad_1.svg b/docs/source/_static/single_gpio_pad_structure_used_for_pad_0_and_pad_1.svg similarity index 100% rename from doc/source/_static/single_gpio_pad_structure_used_for_pad_0_and_pad_1.svg rename to docs/source/_static/single_gpio_pad_structure_used_for_pad_0_and_pad_1.svg diff --git a/doc/source/_static/voltage_clamp_arrangement.svg b/docs/source/_static/voltage_clamp_arrangement.svg similarity index 100% rename from doc/source/_static/voltage_clamp_arrangement.svg rename to docs/source/_static/voltage_clamp_arrangement.svg diff --git a/doc/source/caravel-with-openlane.rst b/docs/source/caravel-with-openlane.rst similarity index 100% rename from doc/source/caravel-with-openlane.rst rename to docs/source/caravel-with-openlane.rst diff --git a/doc/source/conf.py b/docs/source/conf.py similarity index 100% rename from doc/source/conf.py rename to docs/source/conf.py diff --git a/doc/source/counter-timers.rst b/docs/source/counter-timers.rst similarity index 100% rename from doc/source/counter-timers.rst rename to docs/source/counter-timers.rst diff --git a/doc/source/description.rst b/docs/source/description.rst similarity index 100% rename from doc/source/description.rst rename to docs/source/description.rst diff --git a/doc/source/external-clock.rst b/docs/source/external-clock.rst similarity index 100% rename from doc/source/external-clock.rst rename to docs/source/external-clock.rst diff --git a/doc/source/further-work.rst b/docs/source/further-work.rst similarity index 100% rename from doc/source/further-work.rst rename to docs/source/further-work.rst diff --git a/doc/source/getting-started.rst b/docs/source/getting-started.rst similarity index 100% rename from doc/source/getting-started.rst rename to docs/source/getting-started.rst diff --git a/doc/source/gpio.rst b/docs/source/gpio.rst similarity index 100% rename from doc/source/gpio.rst rename to docs/source/gpio.rst diff --git a/doc/source/housekeeping-spi.rst b/docs/source/housekeeping-spi.rst similarity index 100% rename from doc/source/housekeeping-spi.rst rename to docs/source/housekeeping-spi.rst diff --git a/doc/source/index.rst b/docs/source/index.rst similarity index 100% rename from doc/source/index.rst rename to docs/source/index.rst diff --git a/doc/source/introduction.rst b/docs/source/introduction.rst similarity index 100% rename from doc/source/introduction.rst rename to docs/source/introduction.rst diff --git a/doc/source/irq.rst b/docs/source/irq.rst similarity index 100% rename from doc/source/irq.rst rename to docs/source/irq.rst diff --git a/doc/source/maximum-ratings.rst b/docs/source/maximum-ratings.rst similarity index 100% rename from doc/source/maximum-ratings.rst rename to docs/source/maximum-ratings.rst diff --git a/doc/source/memory-mapped-io-summary.rst b/docs/source/memory-mapped-io-summary.rst similarity index 100% rename from doc/source/memory-mapped-io-summary.rst rename to docs/source/memory-mapped-io-summary.rst diff --git a/doc/source/pinout.rst b/docs/source/pinout.rst similarity index 100% rename from doc/source/pinout.rst rename to docs/source/pinout.rst diff --git a/doc/source/programming.rst b/docs/source/programming.rst similarity index 100% rename from doc/source/programming.rst rename to docs/source/programming.rst diff --git a/doc/source/qspi-flash.rst b/docs/source/qspi-flash.rst similarity index 100% rename from doc/source/qspi-flash.rst rename to docs/source/qspi-flash.rst diff --git a/doc/source/quick-start.rst b/docs/source/quick-start.rst similarity index 100% rename from doc/source/quick-start.rst rename to docs/source/quick-start.rst diff --git a/doc/source/references.rst b/docs/source/references.rst similarity index 100% rename from doc/source/references.rst rename to docs/source/references.rst diff --git a/doc/source/spi.rst b/docs/source/spi.rst similarity index 100% rename from doc/source/spi.rst rename to docs/source/spi.rst diff --git a/doc/source/sram.rst b/docs/source/sram.rst similarity index 100% rename from doc/source/sram.rst rename to docs/source/sram.rst diff --git a/doc/source/supplementary-figures.rst b/docs/source/supplementary-figures.rst similarity index 100% rename from doc/source/supplementary-figures.rst rename to docs/source/supplementary-figures.rst diff --git a/doc/source/tool-versioning.rst b/docs/source/tool-versioning.rst similarity index 100% rename from doc/source/tool-versioning.rst rename to docs/source/tool-versioning.rst diff --git a/doc/source/uart.rst b/docs/source/uart.rst similarity index 100% rename from doc/source/uart.rst rename to docs/source/uart.rst diff --git a/doc/svg/caravel_block_diagram.svg b/docs/svg/caravel_block_diagram.svg similarity index 100% rename from doc/svg/caravel_block_diagram.svg rename to docs/svg/caravel_block_diagram.svg diff --git a/doc/svg/caravel_clocking.svg b/docs/svg/caravel_clocking.svg similarity index 100% rename from doc/svg/caravel_clocking.svg rename to docs/svg/caravel_clocking.svg diff --git a/doc/svg/caravel_floorplan.svg b/docs/svg/caravel_floorplan.svg similarity index 100% rename from doc/svg/caravel_floorplan.svg rename to docs/svg/caravel_floorplan.svg diff --git a/doc/svg/housekeeping.svg b/docs/svg/housekeeping.svg similarity index 100% rename from doc/svg/housekeeping.svg rename to docs/svg/housekeeping.svg diff --git a/doc/svg/management_core_wrapper.svg b/docs/svg/management_core_wrapper.svg similarity index 100% rename from doc/svg/management_core_wrapper.svg rename to docs/svg/management_core_wrapper.svg diff --git a/doc/svg/user_project_wrapper.svg b/docs/svg/user_project_wrapper.svg similarity index 100% rename from doc/svg/user_project_wrapper.svg rename to docs/svg/user_project_wrapper.svg diff --git a/openlane/README.src.rst b/openlane/README.src.rst new file mode 100755 index 00000000..b027e89f --- /dev/null +++ b/openlane/README.src.rst @@ -0,0 +1,22 @@ +.. raw:: html + + + + +.. include:: ../docs/source/caravel-with-openlane.rst \ No newline at end of file