Initial draft of the HAL USBPhy API #438
Merged
Conversation
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
Fill in the USB contributing page for the HAL USBPhy API.
Complete initial copy edit, mostly for active voice and formatting.
| - You can use all endpoints in any valid endpoint configuration concurrently. | ||
| - The device supports use of at least one control, bulk, interrupt and isochronous in each direction at the same time - at least 8 endpoints. | ||
| - The device supports all standard endpoint sizes (wMaxPacketSize). | ||
| - The device can handle an interrupt latency of at least 100ms if reset is not being performed and address is not being set. |
There was a problem hiding this comment.
Query: Who or what is not performing the reset? Also, who or what is not sending the address? You, the user?
| - The device supports use of at least one control, bulk, interrupt and isochronous in each direction at the same time - at least 8 endpoints. | ||
| - The device supports all standard endpoint sizes (wMaxPacketSize). | ||
| - The device can handle an interrupt latency of at least 100ms if reset is not being performed and address is not being set. | ||
| - USBPhyEvents events are only sent when USBPhy is in the initialized state. |
There was a problem hiding this comment.
Query: Who or what sends USBPhyEvents?
| - The device supports all standard endpoint sizes (wMaxPacketSize). | ||
| - The device can handle an interrupt latency of at least 100ms if reset is not being performed and address is not being set. | ||
| - USBPhyEvents events are only sent when USBPhy is in the initialized state. | ||
| - When unpowered, only the `USBPhyEvents::power` event can be sent. |
There was a problem hiding this comment.
Query: Who or what sends the USBPhyEvents::power event?
| - The device can handle an interrupt latency of at least 100ms if reset is not being performed and address is not being set. | ||
| - USBPhyEvents events are only sent when USBPhy is in the initialized state. | ||
| - When unpowered, only the `USBPhyEvents::power` event can be sent. | ||
| - On USB reset, all endpoints are removed except for endpoint 0. |
There was a problem hiding this comment.
Query: Who or what removes all endpoints? Does the USB reset do this, or is that correlation?
| - When unpowered, only the `USBPhyEvents::power` event can be sent. | ||
| - On USB reset, all endpoints are removed except for endpoint 0. | ||
| - `USBPhyEvents::out` and `USBPhyEvents::in` events only occur for endpoints that you have added. | ||
| - A call to `USBPhy::ep0_write` results in `USBPhyEvents::in` being called if not interrupted by a power loss or reset. |
There was a problem hiding this comment.
Query: Who or what calls USBPhyEvents::in?
| - On USB reset, all endpoints are removed except for endpoint 0. | ||
| - `USBPhyEvents::out` and `USBPhyEvents::in` events only occur for endpoints that you have added. | ||
| - A call to `USBPhy::ep0_write` results in `USBPhyEvents::in` being called if not interrupted by a power loss or reset. | ||
| - A call to `endpoint_read` followed by `endpoint_read_result` results in `USBPhyEvents::out` being called if not interrupted by a power loss or reset. |
There was a problem hiding this comment.
Query: Who or what calls USBPhyEvents::out?
| - `USBPhyEvents::out` and `USBPhyEvents::in` events only occur for endpoints that you have added. | ||
| - A call to `USBPhy::ep0_write` results in `USBPhyEvents::in` being called if not interrupted by a power loss or reset. | ||
| - A call to `endpoint_read` followed by `endpoint_read_result` results in `USBPhyEvents::out` being called if not interrupted by a power loss or reset. | ||
| - Endpoint 0 naks all transactions aside from setup packets until one of `ep0_read`, `ep0_write` or `ep0_stall` has been called. |
There was a problem hiding this comment.
Query: Who or what calls ep0_read, ep0_write or ep0_stall?
|
|
||
| ##### Notes | ||
|
|
||
| [Include any potential trouble areas in bullet format here.] | ||
| - Make sure USB packets are processed in the correct order when multiple packets are present. IN endpoints should be handled before OUT endpoints if both are pending. |
There was a problem hiding this comment.
Query: Who or what processes the USB packets?
|
|
||
| ##### Notes | ||
|
|
||
| [Include any potential trouble areas in bullet format here.] | ||
| - Make sure USB packets are processed in the correct order when multiple packets are present. IN endpoints should be handled before OUT endpoints if both are pending. | ||
| - Setup packets may be resent if there is noise on the USB line. The USBPhy should be able to handle this scenario and respond to the setup packet with an ACK. |
There was a problem hiding this comment.
Query: Who or what resends setup packets?
added 2 commits
March 13, 2018 15:37
Change passive to active voice.
Add embedded Doxygen class reference, and add warning for feature-branch docs.
AnotherButler
approved these changes
Mar 13, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fill in the USB contributing page for the HAL USBPhy API.