Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chip: rename Ibex to EarlGrey #1997

Merged
merged 1 commit into from Jul 6, 2020
Merged

chip: rename Ibex to EarlGrey #1997

merged 1 commit into from Jul 6, 2020

Conversation

silvestrst
Copy link

@silvestrst silvestrst commented Jul 2, 2020 •
edited

Currently EarlGrey is the first and only OpenTitan SoC design, with Ibex CPU at the heart.

Ibex being a CPU does not have any knowledge of EarlGrey peripherals, and hence was misrepresented in Tock. This has caused some confusion to how exactly it was intended to be used, and did not achieve the goals of being stand alone crate, as it was coupled to heavily with the OpenTitan board.

Pull Request Overview

This pull request renames Ibex crate to EarlGrey, because de facto - that's what it is.

This change also makes #1741 more reasonable.

Testing Strategy

  • Should be tested on FPGA or verilator before merging.

Documentation Updated

  • Updated the relevant files in /docs, or no updates are required.

Formatting

  • Ran make prepush.

@silvestrst silvestrst added the WG-OpenTitan In the purview of the OpenTitan working group. label Jul 2, 2020
@silvestrst silvestrst requested a review from a team July 2, 2020 10:15
bradjc
bradjc previously approved these changes Jul 2, 2020
View reviewed changes
alistair23
alistair23 previously approved these changes Jul 2, 2020
View reviewed changes
@silvestrst silvestrst requested a review from a team July 2, 2020 15:57
ppannuto
ppannuto previously approved these changes Jul 2, 2020
View reviewed changes
@ppannuto ppannuto added the last-call Final review period for a pull request. label Jul 2, 2020
@hudson-ayers
Copy link
Contributor

It looks like there are a few references to ibex still around that should probably change (especially the ones in doc comments and the one in tools)

hudson: ~/tmp_tock ((HEAD detached at s2/silvestrs/tock-ibex-to-earlgrey)) $ rg ibex
tools/update_chip_support.py
27:            'lowrisc': ['ibex'],

capsules/src/hmac.rs
7://! let hmac = &ibex::hmac::HMAC;
10://! digest::Digest::set_client(&ibex::hmac::HMAC, mux_hmac);

capsules/src/mlx90614.rs
9://! let mux_i2c = components::i2c::I2CMuxComponent::new(&ibex::i2c::I2C)

boards/components/src/hmac.rs
9://!    let mux_hmac = components::hmac::HmacMuxComponent::new(&ibex::hmac::HMAC).finalize(

doc/wg/opentitan/README.md
55:- `chips/ibex`

capsules/src/usb/cdc.rs
39:/// Platform-specific packet length for the `ibex` USB hardware.

capsules/src/usb/usbc_client.rs
32:/// Platform-specific packet length for the `ibex` USB hardware.

hudson: ~/tmp_tock ((HEAD detached at s2/silvestrs/tock-ibex-to-earlgrey)) $ rg Ibex
boards/README.md
23:| [Nexys Video OpenTitan](opentitan/README.md)                         | RISC-V RV32IMC  | Ibex           | custom     | custom         |

chips/earlgrey/README.md
4:Ibex RISC-V compliant processor.

boards/opentitan/src/main.rs
102:    // Ibex-specific handler

@silvestrst
Copy link
Author

@hudson-ayers good catch, thank you!

@silvestrst silvestrst mentioned this pull request Jul 3, 2020
Merged
2 tasks
@silvestrst silvestrst dismissed stale reviews from ppannuto, alistair23, and bradjc via ece7a4d July 3, 2020 14:28
@silvestrst silvestrst force-pushed the silvestrs/tock-ibex-to-earlgrey branch from 5d7c8c8 to ece7a4d Compare July 3, 2020 14:28
chip: rename Ibex to EarlGrey
356e461 
Currently EarlGrey is the first and only OpenTitan SoC design, with
Ibex CPU at the heart.

Ibex being a CPU does not have any knowledge of EarlGrey peripherals,
and hence was misrepresented in Tock. This has caused some confusion
to how exactly is was intended to be used, and did not achieve the
goals of being stand alone crate, as it was coupled to heavily with
the OpenTitan board.
@silvestrst silvestrst force-pushed the silvestrs/tock-ibex-to-earlgrey branch from ece7a4d to 356e461 Compare July 3, 2020 14:30
@silvestrst
Copy link
Author

I have changed most references of ibex to earlgrey, I think the ones that are left - are justified.

@ppannuto
Copy link
Member

ppannuto commented Jul 6, 2020

bors r+

@bors
Copy link
Contributor

bors bot commented Jul 6, 2020

Build succeeded:

@bors bors bot merged commit 2694f5b into tock:master Jul 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alevy alevy alevy approved these changes

@ppannuto ppannuto ppannuto approved these changes

@hudson-ayers hudson-ayers hudson-ayers approved these changes

@alistair23 alistair23 Awaiting requested review from alistair23

@bradjc bradjc Awaiting requested review from bradjc

Assignees
No one assigned
Labels
last-call Final review period for a pull request. WG-OpenTitan In the purview of the OpenTitan working group.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@silvestrst @hudson-ayers @ppannuto @alevy @alistair23 @bradjc