chipsalliance / chipsalliance/usb2
[DOC] Clarify Who shold be clearing DCON before SoC Reset
- Dominant language
- VHDL
- Stars
- 1
- Forks
- 6
- Avg merge
- 4d 13h
- Merged PRs (30d)
- 4
Description
In `src/usb_hub_composite_device/docs/User_guide.md` it states:
"1. The reset initiator or MCU firmware MUST clear USBDC1 `DCON` before SoC reset."
I think a better statement would be:
"1. The SoC (USBDC1 SW owner, reset initiator or MCU FW) MUST clear USBDC1 `DCON` before SoC reset."
Link to PR discussion: https://github.com/chipsalliance/usb2/pull/10/changes/BASE..37cee0a62bc7cb51b1e4517fe51b98890e9f3f32#r3884439377
Contributor guide
No contributing guide indexed for this repository
Research direction
Open src/usb_hub_composite_device/docs/User_guide.md and locate the reset procedure mentioning USBDC1 DCON. Compare the wording with the linked PR discussion, update the statement to identify the SoC/USBDC1 software owner, reset initiator, or MCU firmware, and confirm the guide remains clear and grammatically correct.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 92/100