Merge pull request #11635 from hugueskamba/hk-fix-deepsleep-usb-components

USBDevice: add documentation on USB suspend/resume to enter deep sleep
pull/11679/head
Martin Kojtal 2019-10-17 09:21:50 +02:00 committed by GitHub
commit e2578db2f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions

View File

@ -97,6 +97,11 @@ public:
* 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();
@ -109,6 +114,8 @@ public:
/**
* 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();