Ibex is a small 32 bit RISC-V CPU core, previously known as zero-riscy.
Find a file
Marno van der Maas 2b1e3de746 Update lowrisc_ip to lowRISC/opentitan@0deeaa99e
Update code from upstream repository
https://github.com/lowRISC/opentitan to revision
0deeaa99e5760ee4f5c0a08e5fc1670509d22744

* [dv] Fix extension parsing in memutil (Gary Guo)
* [dv,vcs] add an option to override debug_region vcs flag (Sharon
  Topaz)
* [bazel,dvsim] fix airgapped cquery bug (Tim Trippel)
* [prim_present/dv] Only test relevant configs and improve coverage
  (Michael Schaffner)
* [prim_lfsr/dv] Add tests to improve coverage (Michael Schaffner)
* [gpio/dv] Add second build mode for CDC prims (Michael Schaffner)
* bugFix sim_cfg.hjson.tpl (skfwe wang)
* [verilator] Add optional argument for trace file path (Alexander
  Williams)
* [dv] Fix multibit bug in interrupt test register prediction (Michael
  Schaffner)
* [dvsim] update sim.mk to accomodate OTP images under hw/ (Tim
  Trippel)
* [doc] Remove defunct sectionContent macros (James Wainwright)
* [util/uvmdvgen] Fix links in HW checklist template (Andreas Kurth)
* [governance] Add `SEC_CM_SCOPED` to D1 Checklist (Andreas Kurth)
* [dv/otp_ctrl] Fix cdc issue (Cindy Chen)
* [dvsim] add custom wavefile option (Jaedon Kim)
* [kmac,dv] fix regression - kmac_err (Jaedon Kim)
* [dv/clk_rst_if] Avoid freeze due to rst undriven (Guillermo
  Maturana)
* [top-level,clk_rst] Create separate clk_rst_if for xbar mode
  (Guillermo Maturana)
* [chip,dv] update flash_wrtie mappping (Jaedon Kim)
* [chip_tb] Integrate usbdpi into chip tb (Adrian Lees)
* [dv/cdc] Enable CDC in four more IPs (Guillermo Maturana)
* [dv/prim_alert] Enable CDC instrumentation (Guillermo Maturana)
* [dv/prim] Enable CDC instrumentation for some prims (Guillermo
  Maturana)
* [prim/rtl] Define `WITHIN_MARGIN` macro (Andreas Kurth)
* Remove out-of-date "mode" in dvsim (Rupert Swarbrick)
* [dv] Define `ASSERT_AT_RESET_AND_FINAL` macro (Andreas Kurth)
* [dv] Define `ASSERT_AT_RESET` macro (Andreas Kurth)
* [usb_diff_rx] Model pull-up behavior (Michael Schaffner)
* [doc] Fix `that that` typo (Douglas Reis)
* [doc] Fix `the the` typo (Douglas Reis)
* [doc] Fixed broken file links (Hugo McNally)
* [doc] Fixed links between books (Hugo McNally)
* [doc] Fixed some broken links to external sites (Hugo McNally)
* [doc] fixed links into github repos (Hugo McNally)
* [doc] removed link to private repo (Hugo McNally)
* [doc] Add DVSim design doc and glossary (Miguel Osorio)
* [doc] Add new DVSim README (Miguel Osorio)
* [doc] Move dvsim test planner into dvsim/doc (Miguel Osorio)
* Add function called by dvsim publish to trigger a website rebuild
  (Harry Callahan)
* [hw,dv_utils] Fix macro substitution issue with Xcelium (Raviteja
  Chatta)
* [bazel,dvsim] enable passing `--data-perm` flag through dvsim/bazel
  (Timothy Trippel)
* [doc] Updated documentation to reference the new build script. (Hugo
  McNally)
* [doc] Update simulation results link (Raviteja Chatta)
* [flash_ctrl] update `IPoly` parameter in flash scrambler (Timothy
  Trippel)
* [dvsim] Removed depreciated Universal Newline flag (Hugo McNally)
* [doc] Replace wavejson shortcodes with code-blocks (Hugo McNally)
* [doc] Rewrite most frontmatters to Markdown titles (Hugo McNally)
* [doc] Manually changed remaining hugo links (Hugo McNally)
* [doc] Replaced Hugo links with standard markdown (Hugo McNally)
* [doc] Created two initial mdbooks for new layout (Hugo McNally)
* [doc mv] `util/` doc files moved for new layout. (Hugo McNally)
* [doc mv] `hw/` doc files moved for new layout. (Hugo McNally)
* [doc mv] hw/ip* doc files moved for new layout. (Hugo McNally)
* [dv/verilator] Get '-c' flag of Verilator simulator working (Raphael
  Isemann)
* [lint,prim_generic] Turn off unused Verilator lint in clock buf
  (Marno van der Maas)
* [dv/util/sungrid] Fix issue when running sungrid in parallel (Eitan
  Shapira)
* [dv/common] Fix xelium enum type issue (Cindy Chen)
* [dvsim] Disable automatic timeout in gui mode (Cindy Chen)
* [dvsim] Publish json results if available (Andreas Kurth)
* [dvsim] Write json report to file (Andreas Kurth)
* [dvsim] Generate json from run results (Andreas Kurth)
* [dvsim] Add method to convert unit of JobTime (Andreas Kurth)
* [dvsim] Add option to disable normalization of JobTime (Andreas
  Kurth)
* [dvsim] Store coverage summary also in dict (Andreas Kurth)
* [doc] Improve various titles (Marno van der Maas)
* [doc] Added missing title headers (Marno van der Maas)
* [doc] Add TODO to empty stubs (Marno van der Maas)
* Add missing dependencies (Wojciech Sipak)
* [dv] Add build options after file list (Sharon Topaz)
* [rtl/prim] Fix prim_alert_receiver SVA for CDC (Guillermo Maturana)
* [dv] Make prim_secded_* toggle coverage 100% (Weicai Yang)
* [dv] Exclude prim_secdec_* in coverage collection (Weicai Yang)
* [secded/fpv] Remove data input assumption (Michael Schaffner)
* [fpv/prim_count] Add expected failure hjson (Cindy Chen)
* [dv, rv_dm] Fix scoreboard (Srikrishna Iyer)
* [dv, dv_macros] Expand DV_CLOCK_CONSTRAINT range (Srikrishna Iyer)
* [dv, dv_base_reg] Add `get_mask_from_fields` function (Srikrishna
  Iyer)
* [dv/xprop] Enable per-IP xprop configuration file (Guillermo
  Maturana)
* [dv] Change alert_test to run with default build mode (Weicai Yang)
* [dv,dvsim] Add run timeout multiplier option (Guillermo Maturana)
* [dv/shadowed_reg] Reduce a env_cfg variable (Cindy Chen)
* [dvsim] do not print status if `--interactive` (Eli Kim)
* [dvsim] Add unlimited timeout (Eli Kim)
* Revert "[dvsim] Add descriptions to timeout" (Eli Kim)
* [dvsim] Fix flake8 lint error (Eli Kim)
* [dvsim] Launch subprocess interactively (Eli Kim)
* [dvsim] Add `--interactive` argument (Eli Kim)
* [dvsim] Better dashboard result for parameterized blocks (Weicai
  Yang)
* create the log in a correct way (Sharon Topaz)
* Sungrid input from command file instead of command line (Sharon
  Topaz)
* [chip dv] Fix compile time warnings - Xcelium (Srikrishna Iyer)
* [dv] Clean up TODOs in csr_utils (Weicai Yang)
* [dv] Clean TODOs in mem_bkdr_* (Weicai Yang)
* [chip dv] Fix compile warnings in RTL and DV (Srikrishna Iyer)
* [dv] Resolve/clean up more TODOs (Weicai Yang)
* [dvsim] Add descriptions to timeout (Eli Kim)
* [fpv] Clean up strong property in simulation (Cindy Chen)
* [dv/xprop] Change code to be more xprop-friendly (Guillermo
  Maturana)
* [dv] Clean up TODOs in dv_lib (Weicai Yang)
* [chip dv] Implement the E2E JTAG debug and inject tests (Srikrishna
  Iyer)
* [dv, util] Add read_vmem function (Srikrishna Iyer)
* [dv str_utils_pkg] Add more string util methods (Srikrishna Iyer)
* [dv] Move sw_symbol_get_addr_size to dv_utils_pkg (Srikrishna Iyer)
* [dv, sim.mk] Copy elf file without .bin suffix (Srikrishna Iyer)
* [dv] Resolve TODOs in cip_macros (Weicai Yang)
* [prim_sparse_fsm_flop] Make DV statement x-prop safe (Michael
  Schaffner)
* [dv/cov] Exclude coverage of dv-only code (Guillermo Maturana)
* [dv/chip] Disable alert ping scb default check (Cindy Chen)
* [dv] ensure RAM ELF file gets copied to the rundir (Timothy Trippel)
* [dv] Use build seed to regenerate LC encoding for each build
  (Michael Schaffner)
* [dv/coverage_cfg] Remove coverage of prim_onehot_check (Guillermo
  Maturana)
* [prim] Add sync_req_ack based async FIFO (Michael Schaffner)
* [prim] Add RZ protocol to prim_sync_reqack* (Michael Schaffner)
* [dvsim] Move empty pattern list to common (Eli Kim)
* [prim] Reset assertion improvement (Canberk Topal)
* [prim_mubi*_sync] Remove explicit mux prim to improve coverage
  (Michael Schaffner)
* [fpv] Support build_pass_pattern in OneShotCfg (Cindy Chen)
* [dv] Increase MAX_CYCLE to 30 in sec_cm SVA (Weicai Yang)
* [dv_macros] Kill live assertions when disabling in `DV_ASSERT_CTRL`
  (Andreas Kurth)
* [dv, csr_utils_pkg] Add user frontdoor mechanism on all CSR methods
  (Srikrishna Iyer)
* [dv/chip] Support exclude certain alert injections in all_escalation
  test (Cindy Chen)
* [dv, csr_utils_pkg] Fix csr_read for field accesses (Srikrishna
  Iyer)
* [prim-cdc-rand-delay] Fix bug due to dv macro (Srikrishna Iyer)
* [verilator] Simulate GPIOs with weak pull up/down. (Chris Frantz)
* [dv,bazel] only copy over an ELF file if one exists (Timothy
  Trippel)
* [chip,dv,i2c] en_monitor update for top_earlgrey (Jaedon Kim)

Signed-off-by: Marno van der Maas <mvdmaas+git@lowrisc.org>
2023-07-06 07:55:47 +00:00
.github [lint] Point to correct Verible rules for lint workflow 2022-07-19 11:03:09 +01:00
ci [ci] Add missing dependency and fix RTD config 2023-05-10 12:40:05 +00:00
doc [doc] Fix documented mstatus reset value 2023-07-04 09:21:18 +00:00
dv [dv] New directed test to cover some scenarios with U-mode execution 2023-06-23 07:50:22 +00:00
examples [sw/simple_system] Declare pcount_enable function as inline 2023-03-17 13:04:37 +00: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 [dv] Add asserts to check alerts for memory integrity failures 2023-05-15 13:51:06 +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 [util] Ignore Verilator stderr in version check 2023-04-13 16:35:21 +00:00
vendor Update lowrisc_ip to lowRISC/opentitan@0deeaa99e 2023-07-06 07:55:47 +00: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
.readthedocs.yml [ci] Add missing dependency and fix RTD config 2023-05-10 12:40:05 +00: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 [doc] Add documentation on Ibex configuration 2023-02-17 12:24:06 +00: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 [doc] Add documentation on Ibex configuration 2023-02-17 12:24:06 +00: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 [dv] added functional coverpoints 2022-11-08 09:17:45 +00: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 [ci] Constrain pydantic version to under v2.0 2023-07-04 09:21:18 +00:00
README.md [doc] Remove misleading sentence above block diagram 2023-03-14 11:16:41 +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

Ibex OpenTitan configuration Nightly Regression

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.

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 Green Green

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 Demo 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 Demo System is maintained by lowRISC but is not an official part of Ibex.

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.