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

Jump to bottom

USBDevice: add documentation on USB suspend/resume to enter deep sleep #11635

Merged
merged 1 commit into from Oct 17, 2019
Merged

USBDevice: add documentation on USB suspend/resume to enter deep sleep #11635

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions drivers/internal/USBDevice.h
View file
Open in desktop
Expand Up @@ -97,6 +97,11 @@ class USBDevice: public USBPhyEvents {
* Power down this instance
*
* Disable interrupts and stop sending events.
* This method can be used for temporary power-saving; This call can allow
* USB to be temporarily disabled to permit power saving.
* However, it is up to the user to make sure all the
* transfers have concluded (for example when USB power is lost).
* USBDevice::connect can be used to resume USB operation.
*/
void deinit();

Expand All @@ -109,6 +114,8 @@ class USBDevice: public USBPhyEvents {

/**
* Connect a device
* This method can also be used to resume USB operation when USB power is
* detected after it was suspended via USBDevice::deinit.
*/
void connect();

Expand Down