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

* [ralgen] Minor correction in alias-file passing mechanism (Michael
  Schaffner)
* [entropy_src/dv] Track FW_OV FIFO exceptions (Martin Lueker-Boden)
* [dv/clkmgr] Fix reset handling (Guillermo Maturana)
* [flash_ctrl] Add generic registers for the flash wrapper (Michael
  Schaffner)
* [fpv/prim_onehot_check] Fix prim_onehot_check compile error (Cindy
  Chen)
* [dvsim] Minor cleanup of job_runtime updates (Srikrishna Iyer)
* [chip/dv] replace wait with DV_WAIT (Weicai Yang)
* [dv] Add DV_WAIT macro (Weicai Yang)
* [dvsim] Display max CPU time in regression result (Cindy Chen)
* [dv, xcelium] Indicate SVA-disabled hierarchies (Srikrishna Iyer)
* [dv, xcelium] Update switches, sim finishi (Srikrishna Iyer)
* [utils,dvsim] Add wall-clock timeout feature (Guillermo Maturana)
* [prim_count] This reworks the primitive to make it more generic
  (Michael Schaffner)
* [dvsim] remove unecessary `sw_build_dir` parameter (Timothy Trippel)
* [dvsim] use Bazel labels for SW images (Timothy Trippel)
* [entropy_src/dv] Refactor entropy_src_rng_vseq (Martin Lueker-Boden)
* [dv, waves] Improve wave dumping (Srikrishna Iyer)
* [dv/kmac] Fix EDN timeout assertion failures (Cindy Chen)
* [doc] Move style guides into a separate section (Miguel Osorio)
* [spi_device/dv] Enable testing SFDP command (Weicai Yang)
* [doc] Unlist dangling pages from menus. (Miguel Osorio)
* [doc] Add DV intermediate sections (Miguel Osorio)
* [doc] Skip markdown templates from the build (Miguel Osorio)
* [dv/verilator] Fix numeric base of simulation statistics (Andreas
  Kurth)
* [dvsim] Make email.html filename more descriptive (Srikrishna Iyer)
* [csrng/dv] Add deposit to force states when disabled (Steve Nelson)
* fix(rdc): typo (Eunchan Kim)
* fix(rdc): Include NEW violations only to report (Eunchan Kim)
* [dvsim] Add support for SW (bazel) build opts (Srikrishna Iyer)
* fix(cdc): Parse NEW violations only (Eunchan Kim)
* feat(rdc): Add Meridian RDC log parser (Eunchan Kim)
* feat(rdc): Add Meridian RDC flow to dvsim (Eunchan Kim)
* [dv/cip_base] Add checking in stress_all_with_rand_reset seq (Cindy
  Chen)
* [clkmgr/prim] Make frequency measurement disable more robust
  (Timothy Chen)
* [prim/lint] Update waivers (Michael Schaffner)
* [doc] Update D2 checklist (Michael Schaffner)
* [clang-format] Format all covered files (Alexander Williams)
* [dvsim] Indicate what is currently running (Srikrishna Iyer)
* [doc] Fix trailing whitespace on md files. (Miguel Osorio)
* [doc] Remove README.md files from hw,utils folders (Miguel Osorio)
* [tools/dv] Modify common.ccf file for proper expression coverage
  (Steve Nelson)
* [prim_edn_req] Accumulate repetition errors until the data is
  consumed (Pirmin Vogel)
* [chip dv] Cleanup task invoked in func warning (Srikrishna Iyer)
* [topgen] Pass alias register paths into topgen for top RAL
  generation (Michael Schaffner)
* [dv] Split debug_access opt to another hjson variable for override
  (Weicai Yang)
* [dv] Fix ping exclusion (Weicai Yang)
* [prim] update register CDC scheme (Timothy Chen)
* [dv] Add assertion to check reg_we onehot error leads to a fatal
  alert (Weicai Yang)
* [sw,tests] Test flash_ctrl init and scramble (Dave Williams)
* [PRIM] new clock mux to prevent a glitch (Joshua Park)
* [dv] Add prim_cdc_rand_delay exclusion in cover_reg_top (Weicai
  Yang)
* [prim] Add additional qualification to the trigger (Timothy Chen)
* [prim] Add description to parameters (Timothy Chen)
* [sw,tests] Add -f option to copy in sim.mk (Dave Williams)
* [top/spi_device] constraint and clock updates (Timothy Chen)
* [dv] Update xcelium coverage config file (Weicai Yang)
* fix(prim): High memory usage of Assertion (Eunchan Kim)
* [top,dv] rv_dm agent update (Jaedon Kim)
* [dv] Enable reg_wr_check test for all blocks (Weicai Yang)
* [dv] Update tl testplan for reg write enable check (Weicai Yang)
* Refixed 12236 to a more rubust solution (Rasmus Madsen)
* [fpv/alert_handler] Add sec_cm FPV testbench for alert_handler
  (Cindy Chen)
* [dv,ralgen] revert `ralgen.py` to use relative file paths (Timothy
  Trippel)
* [dv,ralgen] update `ralgen.py` to use git paths over relative
  (Timothy Trippel)
* doc(prim): Specify ICEBOX for prim_packer (Eunchan Kim)
* [bazel,dvsim] update dvsim.py to use Bazel to build SW (Timothy
  Trippel)
* [prim] Added generic xnor2 (Arnon Sharlin)
* [flash_ctrl/prim_flash] Add parameters to tweak module latency
  (Timothy Chen)
* [prim_assert] Fix ASSERT_FPV_LINEAR_FSM (Guillermo Maturana)
* [chip,rstmgr,dv] regression fix rstmgr_alert_info test (Jaedon Kim)
* [dv/tool] Collect csr assertion cov (Cindy Chen)
* [otp_ctrl] Add generic registers for prim_otp_wrapper (Michael
  Schaffner)
* [dvsim] Use leaf most field if conflict rather than Exception
  (Eunchan Kim)
* [regtool] Extend UVM backend to support alias definitions (Michael
  Schaffner)
* [fvp/pwrmgr] Pwrmgr fsm error (Cindy Chen)
* [dvsim] Revert lowRISC/opentitan#12761 to build SW with meson
  (Timothy Trippel)
* [bazel,dvsim] update dvsim.py to use Bazel to build SW (Timothy
  Trippel)
* [prim] removed unused files (Timothy Chen)
* [flash_ctrl] Harden FIFO pointers (Timothy Chen)
* [dv] Remove TB_LINT_PASS in all IP checklists (Weicai Yang)
* [dv/flash_ctrl] Temp fix flash_ctrl regression compile error (Cindy
  Chen)
* fix(prim): Lint fix for line length (Eunchan Kim)
* fix(prim): Lint warning for `err_o` (Eunchan Kim)
* [dv] Fix Xcelium toggle collection (Weicai Yang)
* [hw/ip] Add extra prim_fifo_sync port (Timothy Chen)
* [prim/fifo] Add option to harden prim fifo pointers (Timothy Chen)
* [dv_base_reg] Extend search by name functions (Michael Schaffner)
* [fpv/lc_ctrl] Add gating conditions for sec_cm assertions (Cindy
  Chen)
* [primgen] Sort the parameters (Weicai Yang)
* [python] flake8 lint cleanups (Michael Schaffner)
* [prim_subreg] Remove anchor bufs since they are not needed (Michael
  Schaffner)
* [dv] Add `-xprop=mmsopt` run-opt for VCS (Weicai Yang)
* [dv] Temporarily remove CDC assertions (Weicai Yang)
* [hw/dv] further updated dv flow to now score systemverilog tasks and
  functions (Rasmus Madsen)
* [dv/chip] Fix bit_bash timeout error (Cindy Chen)
* [flash_ctrl] Allow fixed priority arbiter (Timothy Chen)
* [prim_assert] Minor rewording in comment (Michael Schaffner)
* [dv/xcelium] 1 attempt of cleaning up the coverage files (Rasmus
  Madsen)
* [dvsim] revert lowRISC/opentitan#12319 to fix CI (Timothy Trippel)
* [primgen] Sort the parameters to ensure stable order (Weicai Yang)
* [prim] Fix python style (Weicai Yang)
* [bazel] update dvsim.py to build ROMs with bazel (Timothy Trippel)
* [dvsim] Correct argparse usage statement and help (Drew Macrae)
* [prim_assert] Fix assertion include order (Michael Schaffner)
* [ast] Lint fixes and waiver updates (Michael Schaffner)
* [prim/lc_ctrl] Create a common assertion macro for linear FSM check
  (Michael Schaffner)
* [dv/csr_utils] Clean up mem_rd/wr print out message (Cindy Chen)
* [doc] Update D3 checklist per RFC (Michael Schaffner)
* [prim_dom_and_2share] Allow re-use of intermediate results for
  remasking (Pirmin Vogel)
* [prim_dom_and_2share] Add parameter to enable full/optional
  pipelining (Pirmin Vogel)
* [dv/vcs] Update cdc exclusion keyword (Cindy Chen)
* [prim] Add a duplicated prim_arbiter instance (Timothy Chen)
* [dv/cdc assertion] Temp remove CDC assertion cov collection in VCS
  (Cindy Chen)
* [prim_onehot_check] Rework lint fix (Michael Schaffner)
* [mubi/lc_ctrl] Change MUBI / lc_tx_t encodings (Michael Schaffner)
* [dv] Update xcelium cover.ccf to only enable coverage for dut
  (Weicai Yang)
* [dv/xcelium] Fix Xcelium nightly regression error (Cindy Chen)
* [prim_onehot_mux] Add lint waivers (Michael Schaffner)
* [prim_lc_sender] Add waiver (Michael Schaffner)
* [prim_mubi] Make sure waiver file is listed in core file (Michael
  Schaffner)
* [tlul_fifo_async] Move waiver to correct file and remove old waivers
  (Michael Schaffner)
* [prim_blanker] Remove prim_and2 waiver file (Michael Schaffner)
* [prim_packer] Lint fixes (Michael Schaffner)
* [prim_secded] Add lint waiver file (Michael Schaffner)
* [dv/cov] Exclude CDC module from collecting coverage (Cindy Chen)
* [reggen] Add spurious WE check to autogen'd regfile (Michael
  Schaffner)
* [prim_reg_we_check] Add spurious CSR write checker (Michael
  Schaffner)
* [prim_onehot_check] Add option for permissive en_i checks (Michael
  Schaffner)
* [tools/dv] updated UNR flow to support xcelium/jg (Rasmus Madsen)
* [prim] Add dv_macros missing dependency (Timothy Chen)
* [top, dv] Fix ext clk plusarg (Weicai Yang)
* [dv/build_seed] Fix build_seed (Cindy Chen)
* [clkmgr] Correct the disable condition (Timothy Chen)
* [flash, dv] Fix RMA test backdoor symbol overwrite (Weicai Yang)
* [top, dv] Fix rom backdoor symbol overwrite (Weicai Yang)
* [flash_ctrl] Add checks for unexpected acks (Timothy Chen)
* [prim_present] Add Verilator lint waiver (Michael Schaffner)
* [xcelium] Pass cov_merge_db_dir through to cov_report.tcl (Rupert
  Swarbrick)
* [dv/build_seed] Fix build seed errors (Cindy Chen)
* [prim_mubi] Add assertion to check that the values are complementary
  (Michael Schaffner)

Signed-off-by: Marno van der Maas <mvdmaas+git@lowrisc.org>
2022-08-05 18:00:25 +01:00
.github [lint] Point to correct Verible rules for lint workflow 2022-07-19 11:03:09 +01:00
ci [dv] Write ePMP tests and enable ePMP in DV 2022-08-03 15:06:03 +01:00
doc [dv,fcov] Implement Misaligned Mem Error coverage 2022-07-21 01:02:15 +03:00
dv [dv] Locking PMP regions in disable all regions tests 2022-08-03 15:06:03 +01:00
examples [examples/sw] Add a pmp smoke test 2022-07-21 15:55:59 +01:00
formal Change use of blocking assignment to non-blocking inside always_ff 2021-10-16 16:46:34 +01:00
lint [lint] Lint fix for RndCntLfsrX parameters 2022-01-14 09:00:48 +00:00
rtl [rtl] Flush controller in PMP CSR write ops 2022-08-05 15:50:42 +03:00
shared [ram_2p] Set DataBitsPerMask parameter for prim_ram_2p 2022-04-01 16:32:45 +02:00
syn [syn] Use sv2v for prim_generic_buf 2022-06-01 11:24:19 +01:00
util [util] Add query functionality to ibex_config.py 2022-07-21 15:55:59 +01:00
vendor Update lowrisc_ip to lowRISC/opentitan@f9e667550 2022-08-05 18:00:25 +01:00
.clang-format Add lowRISC standard clang-format file 2019-09-11 12:00:49 +01:00
.gitignore [dv] Ignoring log files generated by Cadence tools 2022-08-03 15:06:03 +01:00
.svlint.toml Add .svlint.toml 2020-10-30 20:38:08 +00:00
azure-pipelines.yml [ci] Add pmp_smoke_test cosim run to CI 2022-07-21 15:55:59 +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 Avoid premailer 3.9.0 due to API breakage 2021-07-12 10:27:29 +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.