Ibex is a small 32 bit RISC-V CPU core, previously known as zero-riscy.
Find a file
Andreas Kurth e9a866ef55 Update lowrisc_ip to lowRISC/opentitan@affb06d8d
Update code from upstream repository
https://github.com/lowRISC/opentitan to revision
affb06d8de0973bfdc271a6aa4b5ed7dc0b575bb

* [dv] Add `wait_clks_or_rst` to `clk_rst_if` (Andreas Kurth)
* [dv/cdc] Use cycle based CDC instrumentation (Guillermo Maturana)
* [dv/prim_edn_req] Check data valid (Cindy Chen)
* [rtl, chip dv] Coverage exclusions for pinmux / padring (Srikrishna
  Iyer)
* [dv] Enhance probe function macro (Srikrishna Iyer)
* [dv] enable loading `opentitan_flash_binary` images in DV (Timothy
  Trippel)
* [prim_diff_decode] Update SVAs to make them compatible with sim CDC
  (Michael Schaffner)
* [prim-lfsr] Fix DefaultSeedLocal compile scope (Srikrishna Iyer)
* [dv] Update dv_base_reg_field to handle status interrupts (Weicai
  Yang)
* [dvsim] fix bindgen error in nightlies (Timothy Trippel)
* feat(prim): Add Status Interrupt type to `prim_intr_hw` (Eli Kim)
* [dv/shadow_reg] Add coverplan for shadow reg (Cindy Chen)
* [dv/shadow_reg] Add shadow reg fcov (Cindy Chen)
* [dv/chip] Skip creating dv_base_reg coverage (Cindy Chen)
* [chip, dv] Remove a testpoint - tl_intg_err (Weicai Yang)
* [dv/top] Add option to automatically set rom_exec_en (Timothy Chen)
* [dv] Use positive check in DV_CHECK* macros (Srikrishna Iyer)
* [top/dv] Add plusargs to clear secret partitions (Michael Schaffner)
* [dv/prim] Disable coverage for unused logic (Guillermo Maturana)
* [dv] Add a global end-of-test signaling for RTL (Srikrishna Iyer)
* [dv] Properly remove coverage on CDC rand delay module (Srikrishna
  Iyer)
* [prim_sync_reqack] Disable reset checks by default, enable inside
  OTBN (Pirmin Vogel)
* [prim_sync_reqack] Modify/extend SVAs with respect to reset (Pirmin
  Vogel)
* [dv/clkmgr] Add exclusions and coverage pragmas (Guillermo Maturana)
* [prim] Simplify defensive coding (Timothy Chen)
* [prim_mubi] Fix sampling issue in MUBI sync assertions (Michael
  Schaffner)
* [rtl/prim] Fix some prim_esc_receiver SVAs (Guillermo Maturana)
* refactor(prim): rst_sync to have scanchain (Eli Kim)
* [unr] Use elite license (Cindy Chen)
* feat(prim): prim_rst_sync (Eli Kim)
* refactor(dvsim): Remove `verdi` checker (Eli Kim)
* [mubi/lc] Relax transient SVA checks (Michael Schaffner)
* [fpv] fix random seed syntax error (Cindy)
* [doc] Fix typos in //hw/lint and //hw/top_earlgrey (Dan McArdle)
* [doc] Fix typos in //hw/ip (Dan McArdle)
* [doc] Fix trailing whitespace before editing Markdown (Dan McArdle)
* [dv/shadow_reg] Update comment (Cindy Chen)
* [dv] Add macro `DV_CHECK_Q_EQ` (Weicai Yang)
* [fpv/pwrmgr] Add assertions to check escalation (Cindy Chen)
* [dv] Fix clk_rst_if limitation (Srikrishna Iyer)
* [dv, pins_if] Add disconnect() method (Srikrishna Iyer)
* SunGrid launcher support (Sharon Topaz)
* [chip dv] Fix errors due to use of invalid HIER macros (Srikrishna
  Iyer)
* [dv, clk_rst_if] Expand instance name in context (Srikrishna Iyer)
* [dv] pins_if improvement (Srikrishna Iyer)
* [CDC/PRIM] Updated prim_fifo_sync and prim_fifo_async to avoid CDC
  in rdata (Joshua Park)
* Fix various typos in Markdown files (Dan McArdle)
* [dvsim] Promote xcelium warning ENUMERR to an error (Michael
  Schaffner)
* [dvsim] Install a SIGTERM handler (Srikrishna Iyer)
* [flash_ctrl,dv] Enable random device param for all tests (Jaedon
  Kim)
* [prim] Patch up design to help with coverage (Timothy Chen)
* [flash_ctrl] Use comportable channels for alerts emanating from
  prim_flash (Michael Schaffner)
* [doc, prim] doc update for new prim library (Joshua Park)
* [otp_ctrl] Use comportable channels for alerts emanating from
  prim_otp (Michael Schaffner)
* [dv] Replace wait_timeout with DV_WAIT_TIMEOUT (Weicai Yang)
* [prim_lfsr] Initial block label (Srikrishna Iyer)
* [dv/top] Regression triage (Timothy Chen)
* [prim_lfsr] Enable randomization of initial seed (Srikrishna Iyer)
* [dv] Fix timeout log (Weicai Yang)

Signed-off-by: Andreas Kurth <adk@lowrisc.org>
2022-11-04 15:21:14 +01:00
.github [lint] Point to correct Verible rules for lint workflow 2022-07-19 11:03:09 +01:00
ci [ci] Bump cosim version to latest 2022-10-31 16:46:55 +00:00
doc [doc] Add RF write enable glitch detection 2022-11-03 10:31:03 +01:00
dv [dv] Compile dv_assert.sv before prim_util_pkg.sv 2022-11-04 15:21:14 +01:00
examples [rtl] Protect core_busy_o with a multi-bit encoding 2022-10-25 12:52:01 +02:00
formal [formal] Remove build infrastructure for instruction cache assertions 2022-10-04 13:59:39 +01:00
lint [lint] Lint fix for RndCntLfsrX parameters 2022-01-14 09:00:48 +00:00
rtl [rtl] Fix dummy instructions 2022-10-31 17:42:12 +00:00
shared [ram_2p] Set DataBitsPerMask parameter for prim_ram_2p 2022-04-01 16:32:45 +02:00
syn [rtl] Protect core_busy_o with a multi-bit encoding 2022-10-25 12:52:01 +02:00
util core_ibex dv build system refactor 2022-08-16 14:41:12 +01:00
vendor Update lowrisc_ip to lowRISC/opentitan@affb06d8d 2022-11-04 15:21:14 +01:00
.clang-format Add lowRISC standard clang-format file 2019-09-11 12:00:49 +01:00
.gitignore [dv] Made dedicated gitignore file and add coverage files 2022-08-19 11:39:49 +01:00
.svlint.toml Add .svlint.toml 2020-10-30 20:38:08 +00:00
__init__.py core_ibex dv build system refactor 2022-08-16 14:41:12 +01:00
azure-pipelines.yml [ci] Switch to using Ubuntu 20 LTS azure agent 2022-10-07 13:34:07 +01:00
check_tool_requirements.core Use vendored-in primitives from OpenTitan 2020-05-27 10:23:15 +01:00
CONTRIBUTING.md Fix vim setting suggestion 2019-06-19 14:39:41 +02:00
CREDITS.md Add myself to CREDITS.md 2020-07-30 14:40:46 +01:00
ibex_configs.yaml Updating parameters for OpenTitan option 2022-04-28 15:14:42 +01:00
ibex_core.core Updating parameters for OpenTitan option 2022-04-28 15:14:42 +01:00
ibex_icache.core [icache] Add RAM Primitives for scrambling 2022-01-19 14:59:43 +00:00
ibex_multdiv.core [formal] Add check for multdiv cycle consumption 2020-09-16 16:30:20 +01:00
ibex_pkg.core Factor out ibex_pkg.sv into a separate core file 2020-03-27 10:44:09 +00:00
ibex_top.core Updating parameters for OpenTitan option 2022-04-28 15:14:42 +01:00
ibex_top_tracing.core Updating parameters for OpenTitan option 2022-04-28 15:14:42 +01:00
ibex_tracer.core Factor out ibex_pkg.sv into a separate core file 2020-03-27 10:44:09 +00:00
LICENSE Convert from Solderpad to standard Apache 2.0 license 2019-04-26 15:05:17 +01:00
Makefile In util, restrict mypy linting to sv2v_in_place.py 2020-09-17 15:51:40 +01:00
python-requirements.txt Change method to locate ibex root to relative paths 2022-08-19 11:45:52 +01:00
README.md [doc] Add examples info to README 2022-03-11 17:28:52 +00:00
src_files.yml Update src_files.yml 2020-04-23 15:44:56 +02:00
tool_requirements.py [util] Document minimal requirement for Xilinx Vivado 2021-08-26 14:42:26 +02:00

Build Status

Ibex RISC-V Core

Ibex is a production-quality open source 32-bit RISC-V CPU core written in SystemVerilog. The CPU core is heavily parametrizable and well suited for embedded control applications. Ibex is being extensively verified and has seen multiple tape-outs. Ibex supports the Integer (I) or Embedded (E), Integer Multiplication and Division (M), Compressed (C), and B (Bit Manipulation) extensions.

The block diagram below shows the small parametrization with a 2-stage pipeline.

Ibex was initially developed as part of the PULP platform under the name "Zero-riscy", and has been contributed to lowRISC who maintains it and develops it further. It is under active development.

Configuration

Ibex offers several configuration parameters to meet the needs of various application scenarios. The options include different choices for the architecture of the multiplier unit, as well as a range of performance and security features. The table below indicates performance, area and verification status for a few selected configurations. These are configurations on which lowRISC is focusing for performance evaluation and design verification (see supported configs).

Config "micro" "small" "maxperf" "maxperf-pmp-bmfull"
Features RV32EC RV32IMC, 3 cycle mult RV32IMC, 1 cycle mult, Branch target ALU, Writeback stage RV32IMCB, 1 cycle mult, Branch target ALU, Writeback stage, 16 PMP regions
Performance (CoreMark/MHz) 0.904 2.47 3.13 3.13
Area - Yosys (kGE) 16.85 26.60 32.48 66.02
Area - Commercial (estimated kGE) ~15 ~24 ~30 ~61
Verification status Red Green Amber Amber

Notes:

  • Performance numbers are based on CoreMark running on the Ibex Simple System platform. Note that different ISAs (use of B and C extensions) give the best results for different configurations. See the Benchmarks README for more information.
  • Yosys synthesis area numbers are based on the Ibex basic synthesis flow using the latch-based register file.
  • Commercial synthesis area numbers are a rough estimate of what might be achievable with a commercial synthesis flow and technology library.
  • For comparison, the original "Zero-riscy" core yields an area of 23.14kGE using our Yosys synthesis flow.
  • Verification status is a rough guide to the overall maturity of a particular configuration. Green indicates that verification is close to complete. Amber indicates that some verification has been performed, but the configuration is still experimental. Red indicates a configuration with minimal/no verification. Users must make their own assessment of verification readiness for any tapeout.
  • v.1.0.0 of the RISC-V Bit-Manipulation Extension is supported as well as the remaining sub-extensions of draft v.0.93 of the bitmanip spec. The latter are not ratified and there may be changes before ratification. See Standards Compliance in the Ibex documentation for more information.

Documentation

The Ibex user manual can be read online at ReadTheDocs. It is also contained in the doc folder of this repository.

Examples

The Ibex repository includes Simple System. This is an intentionally simple integration of Ibex with a basic system that targets simulation. It is intended to provide an easy way to get bare metal binaries running on Ibex in simulation.

A more complete example can be found in the Ibex Super System repository. In particular it includes a integration of the PULP RISC-V debug module. It targets the Arty A7 FPGA board from Digilent and supports debugging via OpenOCD and GDB over USB (no external JTAG probe required). The Ibex Super System is written by lowRISC but is not an official part of Ibex, nor officially supported by lowRISC.

Contributing

We highly appreciate community contributions. To ease our work of reviewing your contributions, please:

  • Create your own branch to commit your changes and then open a Pull Request.
  • Split large contributions into smaller commits addressing individual changes or bug fixes. Do not mix unrelated changes into the same commit!
  • Write meaningful commit messages. For more information, please check out the contribution guide.
  • If asked to modify your changes, do fixup your commits and rebase your branch to maintain a clean history.

When contributing SystemVerilog source code, please try to be consistent and adhere to our Verilog coding style guide.

When contributing C or C++ source code, please try to adhere to the OpenTitan C++ coding style guide. All C and C++ code should be formatted with clang-format before committing. Either run clang-format -i filename.cc or git clang-format on added files.

To get started, please check out the "Good First Issue" list.

Issues and Troubleshooting

If you find any problems or issues with Ibex or the documentation, please check out the issue tracker and create a new issue if your problem is not yet tracked.

Questions?

Do not hesitate to contact us, e.g., on our public Ibex channel on Zulip!

License

Unless otherwise noted, everything in this repository is covered by the Apache License, Version 2.0 (see LICENSE for full text).

Credits

Many people have contributed to Ibex through the years. Please have a look at the credits file and the commit history for more information.