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.

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

[otp_ctrl/doc] Add documentation regarding re-parameterization after D3/V3 #13860

Merged
merged 1 commit into from
Jul 29, 2022

Conversation

msfschaffner
Copy link
Contributor

This addresses one of the cleanup items in #13438.

Let me know if you think this should be moved to a different section in the spec.

Signed-off-by: Michael Schaffner [email protected]

@tjaychen
Copy link

do you think your description here sort applies to blocks in general? I'm wondering if it makes sense to have this as a common blurb somewhere that other blocks can simply link to.

What do you think? In addition to calling out the common point about V3 needing requalification, you can point out specific parameters of concern.

@msfschaffner
Copy link
Contributor Author

That probably makes sense, yes.

How about we add a D3 checklist item with the following description?

### DOC_PARAM_IP

If not otherwise stated in the comportable IP specification, all instantiation parameter combinations are considered legal and do not impact D3/V3 status.
If an IP supports only a subset of parameterizations, it must explicitly document the supported parameterizations in a section called "Parameter Changes after D3/V3" in the design specification.

@tjaychen
Copy link

That probably makes sense, yes.

How about we add a D3 checklist item with the following description?

### DOC_PARAM_IP

If not otherwise stated in the comportable IP specification, all instantiation parameter combinations are considered legal and do not impact D3/V3 status.
If an IP supports only a subset of parameterizations, it must explicitly document the supported parameterizations in a section called "Parameter Changes after D3/V3" in the design specification.

that sounds good to me.

@msfschaffner
Copy link
Contributor Author

I have moved the paragraph a bit further up in the spec into the Hardware Interfaces section where the instantiation parameters are declared.

I will also separately propose the addition to the D3 checklist as discussed above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants