-
Notifications
You must be signed in to change notification settings - Fork 37
[DOC] Add Errata documentation #954
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
Open
clayton8
wants to merge
2
commits into
main
Choose a base branch
from
ckuchta-add-errata
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+46
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| <div align="center"> | ||
| <img src="./images/OCP_logo.png" alt="OCP Logo"> | ||
| </div> | ||
|
|
||
| <h1 align="center"> Caliptra Subsystem Errata</h1> | ||
| <h3 align="center"> Version 2p1 </h3> | ||
|
|
||
| - [Scope](#scope) | ||
| - [Issues](#issues) | ||
| - [ERRATA-000: I3C HDR Traffic](#errata-000-i3c-hdr-traffic) | ||
|
|
||
| # Scope | ||
|
|
||
| This document lists all known issues for this Caliptra-SS release. | ||
|
|
||
| Each issue has identifier of the form `ERRATA-###` for cross-references. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| # Issues | ||
|
|
||
| ## ERRATA-000: I3C HDR Traffic | ||
|
|
||
| **Type:** | ||
| Functional | ||
|
|
||
| **Description:** | ||
| I3C is an SDR traffic that should be able to tollerage HDR traffic. The I3C implementation does not detect HDR entry and ignore I3C traffic until it sees an HDR exit pattern. | ||
|
|
||
| This is directly tied to I3C release: [v1p4-patch](https://github.com/chipsalliance/i3c-core/releases/tag/v1p4-patch) | ||
|
|
||
| **Conditions:** | ||
| I3C bus enters HDR mode and HDR traffic is put on the I3C bus. | ||
|
|
||
| **Impact:** | ||
| When I3C bus enters HDR mode the Caliptra I3C can inadvertantly accept and/or respond to I3C HDR traffic. This could cause corruption on the bus, or cause the Caliptra I3C to become corrupt. | ||
|
|
||
| **Workaround:** | ||
| No HDR traffic is allowed on the I3C bus. | ||
|
|
||
| **Fix:** | ||
| Future revisions of I3C will properly detect and ignore HDR traffic. | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Embedding Errata in the integration spec might become a bit onerous over time. I would think the presence of an Errata file is sufficient.