lowRISC / lowRISC/ibex

[DV] Remove all copies of OpenTitan files except when vendored in

Open
#985 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Component:DV Type:Bug
Dominant language
SystemVerilog
Stars
2.1k
Forks
810
Avg merge
5d 23h
Merged PRs (30d)
9

Description

We are vendoring in Ibex into OT, and we need to avoid files being duplicated, or core files in Ibex overriding ones in OT.

General rules:
- If code from OT is needed, it *must be* vendored in.
- If code is not vendored in, it *may not* use the same `name` in the core file, and ideally also not the same file names.

One example we know of right now is the mem_model at https://github.com/lowRISC/ibex/tree/master/dv/uvm/core_ibex/common/mem_model; there might be others.

This issue is to double-check all core files, and to ensure that the rules outlined hold.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting dv/uvm/core_ibex/common/mem_model and compare it with the corresponding vendored-in OpenTitan code. Then review the other core files against the stated naming and vendoring rules; done means non-vendored OpenTitan code is not duplicated or able to override Ibex code.

Written by the indexing model from the issue text.

Assessment

Domain
testing
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.