search

openhwgroup / programs

Documentation for the OpenHW Group's set of CORE-V RISC-V cores
Other
187 stars 96 forks source link

OBI protocol documentation not found #559

Closed pcotret closed 1 year ago

pcotret commented 1 year ago

Bug Title

OBI protocol documentation may have disappeared.

Type

Indicate whether the type of problem you found:

I understand that core-v-docs may have been rename as this programs repository. However, I couldn't find the OBI protocol documentation (even if it's based on RST, I could regenerate the PDF by myself).

Location of Issue

Please provide: https://docs.openhwgroup.org/projects/cv32e40x-user-manual/en/latest/intro.html

Additional context

We basically have the same issue with other cores, sometimes with older version of OBI specs. For instance, the CV32E40P : https://docs.openhwgroup.org/projects/cv32e40p-user-manual/en/latest/intro.html

pcotret commented 1 year ago

EDIT: I found the documentation I was looking for in an older commit (https://github.com/openhwgroup/programs/tree/a8e6076c6cfecd57e584f66ce6414cc3b75bf0ca/cores/obi). However, the issue is still here.

MikeOpenHWGroup commented 1 year ago

Whoops! Thanks for reporting this @pcotret. It seems the OBI spec did not survive the transition from the "core-v-docs" repo to "programs". I will work with @DBees to resolve this. There are two aspects to resolving the issue:

Silabs-ArjanB commented 1 year ago

@MikeOpenHWGroup @DBees I would like to add that moving OBI documentation under 'programs' is not very logical. Nobody will search it there. Can we keep a core-v-docs as well and keep 'programs' only for 'programs' related stuff?

abukharmeh commented 1 year ago

Saw @davideschiavone opened this repo https://github.com/openhwgroup/obi !

pcotret commented 1 year ago

Great, thanks for the notice @abukharmeh :wink:

MikeOpenHWGroup commented 1 year ago

Can this issue be closed now?

pcotret commented 1 year ago

Link has to be updated in each CPU documentation (for instance, https://docs.openhwgroup.org/projects/cv32e40x-user-manual/en/latest/intro.html). But I think it's correct for this programs repository.