Skip to content

Commit

Permalink
Merge pull request ARMmbed#11635 from hugueskamba/hk-fix-deepsleep-us…
Browse files Browse the repository at this point in the history
…b-components

USBDevice: add documentation on USB suspend/resume to enter deep sleep
  • Loading branch information
0xc0170 authored Oct 17, 2019
2 parents 8c86052 + a3f20f8 commit e2578db
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions drivers/internal/USBDevice.h
Original file line number Diff line number Diff line change
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

0 comments on commit e2578db

Please sign in to comment.