Croc System-on-Chip

A simple SoC for education using PULP IPs. Croc includes all scripts necessary to produce a nearly finished chip in IHPs open-source 130nm technology.

As it is oriented towards education, it forgoes some configurability to increase readability of the RTL and scripts.

Croc is developed as part of the PULP project, a joint effort between ETH Zurich and the University of Bologna.

Architecture

The SoC is composed of two main parts:

• The croc_domain containing an Ibex core, SRAM, an OBI crossbar and a few simple peripherals
• The user_domain where students are invited to add their own designs or other open-source designs (peripherals, accelerators...)

The main interconnect is OBI, you can find the spec online.

The various IPs of the SoC (UART, OBI, debug-module, timer...) come from other PULP repositories and are managed by Bender. To make it easier to browse and understand, only the currently used files are included in rtl/<IP>. You may want to explore the repositories of the respective IPs to find their documentation or additional functionality, the urls are in Bender.yml.

Configuration

Many configurations are in the configuration object:

Parameter	Default	Function
HartId	0	Core's Hart ID
PulpJtagIdCode	32'h1_0000_db3	Debug module ID code
NumExternalIrqs	4	Number of external interrupts into Croc domain
BankNumWords	512	Number of 32bit words in a memory bank
NumSramBanks	2	Number of memory banks

Bootmodes

Currently the only way to boot is via JTAG.

Memory Map

If possible, the memory map should be remain compatible with Cheshire's memory map.
As a guideline each new subordinate should occupy multiples of 4KB of the address space (32'h0000_1000).

Start Address	Stop Address	Description
32'h0000_0000	32'h0004_0000	Debug module (JTAG)
32'h0300_0000	32'h0300_1000	SoC control/info registers
32'h0300_2000	32'h0300_3000	UART peripheral
32'h0300_A000	32'h0300_B000	Timer peripheral
32'h1000_0000	+SRAM_SIZE	Memory banks (SRAM)
32'h2000_0000	32'h8000_0000	Passthrough to user domain
32'h2000_0000	32'h2000_1000	reserved for string formatted user ROM*

*If people modify Croc we suggest they add a ROM at this address location containing additional information. Like their names, a project link or similar. This can then be written out via UART.
We ask people to format the ROM like a C string with zero termination and using ASCII encoding if feasible.

Flow

graph LR;
	Bender-->Morty;
	Morty-->SVase;
	SVase-->SV2V;
	SV2V-->Yosys;
	Yosys-->OpenRoad;
	OpenRoad-->klayout;

Loading

1. Bender provides a list of SystemVerilog files
2. These files are pickled into one context using Morty
3. The pickled file is simplified using SVase
4. The simplified SystemVerilog code is run through SV2V
5. This gives us synthesizable Verilog which is then loaded into Yosys
6. In Yosys the Verilog RTL goes through various passes and is mapped to the technology cells
7. The netlist, constraints and floorplan are loaded into OpenRoad for Place&Route
8. The design as def is read by klayout and the geometry of the cells and macros are merged

The final gds is still missing the following things:

• metal density fill
• pads
• sealring All are added in klayout once your design is final.

Results

Cell/Module placement	Routing

Requirements

We are using the excelent docker container maintained by Harald Pretl. If you get stuck with installing the tools, we urge you to check the Tool Repository.

ETHZ systems

An environment setup for bash is provided.

source ethz.env

Other systems

Note: this has currently only been tested on Ubuntu and RHEL Linux.

Docker (easy)

There are two possible ways, the easiest way is to install docker and work in the docker container, you can follow the install guides on the Docker Website.
You do not need to manually download the container image, this will be done when running the script. If you do not have git installed on your system, you also need to install Github Desktop and then clone this git repository.

It is a good idea to grant non-root (sudo) users access to docker, this is decribed in the Docker Article.

Finally, you can navigate to this directory, open a terminal (PowerShell in Windows) and type:

# Linux only (starts and enters docker container in shell)
./start_linux.sh
# Linux/Mac (starts VNC server on localhost:5901)
./start_vnc.sh
# Windows (starts VNC server on localhost:5901)
./start_vnc.bat

If you use the VNC option, open a browser and type localhost in the address bar. This should connect you to the VNC server, the password is abc123, then test by right-clicking somewhere, starting the terminal and typing ls.
You should see the files in this repository again.

Now you should be in an Ubuntu environment with all tools pre-installed for you.
If something does not work, refer to the upstream IIC-OSIC-Tools

Native install (hard)

You need to build/install the required tools manually:

• Bender: Dependency manager
• Morty: SystemVerilog pickler
• SVase: SystemVerilog pre-elaborator
• SV2V: SystemVerilog to Verilog
• Yosys: Synthesis tool
• OpenRoad: Place & Route tool
• (Optional) Verilator: Simulator
• (Optional) Questasim/Modelsim: Simulator

Getting started

The SoC is fully functional as-is and a simple software example is provided for simulation. To run the synthesis and place & route flow execute:

make checkout
make pickle
make yosys
make openroad
make klayout

Note: The bonding pads, metal fill and seal ring (all done in klayout) are currently still missing

To simulate you can use:

make verilator

If you have Questasim/Modelsim, you can also use:

make vsim

The most important make targets are documented, you can list them with:

make help

Bender

The dependency manager Bender is used in most pulp-platform IPs. Usually each dependency would be in a seperate repository, each with a Bender.yml file to describe where the RTL files are, how you can use this dependency and which additional dependency it has. In the top level repository (like this SoC) you also have a Bender.yml file but you will commonly find a Bender.lock file. It contains the resolved tree of dependencies with specific commits for each. Whenever you run a command using Bender, this is the file it uses to figure out where things are.

Below is a small guide aimed at the usecase for this project. The Bender repo has a more extensive Command Guide.

Checkout

Using the command bender checkout Bender will check the lock file and download the specified commits from the repositories (usually into a hidden .bender directory).

Update

Running bender update on the other hand will resolve the entire tree again and re-generate the lock file (you usually have to resolve some version/revision conflicts if multiple things use the same dependency).

Remember: always test everything again if you generate a new Bender.lock, it is the same as modifying RTL.

Local Versions

For this repository, we use a subcommand called bendor vendor together with the vendor_package section in Bender.yml. bendor vendor can be used to Benderize arbitrary repositories with RTL in it. The dependencies are already 'checked out' into rtl/<IP>. Each file or directory from the repository is mapped to a local path in this repo. Fixes and changes to each IPs rtl/<IP>/Bender.yml are managed by bender vendor in rtl/patches.

If you need to update a dependency or map another file you need to edit the coresponding vendor_package section in Bender.yml and then run bender vendor init. Then you might need to change rtl/<IP>/Bender.yml to list your new file in the sources. To save a fix/change as a patch, stage it in git and then run bender vendor patch. When prompted, add a commit message (this is used as the patches file name). Finally, commit both the patch file and the new rtl/<IP>.

Note: using bender vendor in this repository to change the local versions of the IPs requires an up-to-date version of Bender, specifically it needs to include PR 179.

Targets

Another thing we use are targets (in the Bender.yml), together they build different views/contexts of your RTL. For example without defining any targets the technology independent cells/memories are used (in rtl/tech_cells_generic/) but if we use the target ihp13 then the same modules contain a technology-specific implementation (in ihp13/). Similar contexts are built for different simulators and other things.

License

Unless specified otherwise in the respective file headers, all code checked into this repository is made available under a permissive license. All hardware sources and tool scripts are licensed under the Solderpad Hardware License 0.51 (see LICENSE.md). All software sources are licensed under Apache 2.0.