Skip to content

Commit e2578db

Browse files
authored
Merge pull request #11635 from hugueskamba/hk-fix-deepsleep-usb-components
USBDevice: add documentation on USB suspend/resume to enter deep sleep
2 parents 8c86052 + a3f20f8 commit e2578db

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

drivers/internal/USBDevice.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,11 @@ class USBDevice: public USBPhyEvents {
9797
* Power down this instance
9898
*
9999
* Disable interrupts and stop sending events.
100+
* This method can be used for temporary power-saving; This call can allow
101+
* USB to be temporarily disabled to permit power saving.
102+
* However, it is up to the user to make sure all the
103+
* transfers have concluded (for example when USB power is lost).
104+
* USBDevice::connect can be used to resume USB operation.
100105
*/
101106
void deinit();
102107

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

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

0 commit comments

Comments
 (0)