diff mbox

[RFC] Documentation/: update hibernation debug documentation

Message ID 20160812062241.GB30992@amd (mailing list archive)
State Not Applicable, archived
Headers show

Commit Message

Pavel Machek Aug. 12, 2016, 6:22 a.m. UTC
Hi!

> Update the description of test_resume mode for hibernation.
> 
> Signed-off-by: Chen Yu <yu.c.chen@intel.com>
> ---
>  Documentation/power/basic-pm-debugging.txt | 7 +++++++
>  1 file changed, 7 insertions(+)

That's certainly step in the right direction, but I guess it should be
mentioned in the other places, too. Something like this?

Additionally, we have testproc. Should we move it to test_proc for
consistency (or replace test_resume with simple "resume"? That's what
it does... it is hibernate+resume...

Thanks,
								Pavel





> diff --git a/Documentation/power/basic-pm-debugging.txt b/Documentation/power/basic-pm-debugging.txt
> index b96098c..5f1f228 100644
> --- a/Documentation/power/basic-pm-debugging.txt
> +++ b/Documentation/power/basic-pm-debugging.txt
> @@ -36,6 +36,13 @@ button to make the system resume).
>  If neither "platform" nor "shutdown" hibernation mode works, you will need to
>  identify what goes wrong.
>  
> +Besides, if all the modes described above work, "test_resume" mode can be used to
> +verify if the snapshot data written to swap device can be successfully restored
> +to memory:
> +# echo test_resume > /sys/power/disk
> +# echo disk > /sys/power/state
> +If everything goes well, the system will resume back without BIOSes involved in.
> +
>  a) Test modes of hibernation
>  
>  To find out why hibernation fails on your system, you can use a special testing

Comments

Chen Yu Aug. 12, 2016, 11:46 a.m. UTC | #1
Hi Pavel,

> -----Original Message-----
> From: Pavel Machek [mailto:pavel@ucw.cz]
> Sent: Friday, August 12, 2016 2:23 PM
> To: Chen, Yu C
> Cc: Linux PM List; Rafael J. Wysocki; Len Brown; linux-kernel@vger.kernel.org
> Subject: Re: [PATCH][RFC] Documentation/: update hibernation debug
> documentation
> 
> Hi!
> 
> > Update the description of test_resume mode for hibernation.
> >
> > Signed-off-by: Chen Yu <yu.c.chen@intel.com>
> > ---
> >  Documentation/power/basic-pm-debugging.txt | 7 +++++++
> >  1 file changed, 7 insertions(+)
> 
> That's certainly step in the right direction, but I guess it should be mentioned in
> the other places, too. Something like this?
> 
> Additionally, we have testproc. Should we move it to test_proc for consistency
> (or replace test_resume with simple "resume"? That's what it does... it is
> hibernate+resume...
It looks like testproc has been removed in 
commit 48580ab8729865c81e148d59159fbe2aa7865511,
so I think we can replace 'testproc/test' with 'resume' in interface.txt and add some description in it,
I'll do that, thanks.

Yu

--
To unsubscribe from this list: send the line "unsubscribe linux-pm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Rafael J. Wysocki Aug. 12, 2016, 11:53 a.m. UTC | #2
On Fri, Aug 12, 2016 at 1:46 PM, Chen, Yu C <yu.c.chen@intel.com> wrote:
> Hi Pavel,
>
>> -----Original Message-----
>> From: Pavel Machek [mailto:pavel@ucw.cz]
>> Sent: Friday, August 12, 2016 2:23 PM
>> To: Chen, Yu C
>> Cc: Linux PM List; Rafael J. Wysocki; Len Brown; linux-kernel@vger.kernel.org
>> Subject: Re: [PATCH][RFC] Documentation/: update hibernation debug
>> documentation
>>
>> Hi!
>>
>> > Update the description of test_resume mode for hibernation.
>> >
>> > Signed-off-by: Chen Yu <yu.c.chen@intel.com>
>> > ---
>> >  Documentation/power/basic-pm-debugging.txt | 7 +++++++
>> >  1 file changed, 7 insertions(+)
>>
>> That's certainly step in the right direction, but I guess it should be mentioned in
>> the other places, too. Something like this?
>>
>> Additionally, we have testproc. Should we move it to test_proc for consistency
>> (or replace test_resume with simple "resume"? That's what it does... it is
>> hibernate+resume...
> It looks like testproc has been removed in
> commit 48580ab8729865c81e148d59159fbe2aa7865511,

Yes, it was removed, back in 2011.

> so I think we can replace 'testproc/test' with 'resume' in interface.txt and add some description in it,
> I'll do that, thanks.

You mean "test_resume" I suppose?

Clearly, the documentation needs to be updated.

Let me take care of that later today.

Thanks,
Rafael
--
To unsubscribe from this list: send the line "unsubscribe linux-pm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Chen Yu Aug. 12, 2016, 11:55 a.m. UTC | #3
DQo+IC0tLS0tT3JpZ2luYWwgTWVzc2FnZS0tLS0tDQo+IEZyb206IHJqd3lzb2NraUBnbWFpbC5j
b20gW21haWx0bzpyand5c29ja2lAZ21haWwuY29tXSBPbiBCZWhhbGYgT2YNCj4gUmFmYWVsIEou
IFd5c29ja2kNCj4gU2VudDogRnJpZGF5LCBBdWd1c3QgMTIsIDIwMTYgNzo1NCBQTQ0KPiBUbzog
Q2hlbiwgWXUgQw0KPiBDYzogUGF2ZWwgTWFjaGVrOyBMaW51eCBQTSBMaXN0OyBSYWZhZWwgSi4g
V3lzb2NraTsgTGVuIEJyb3duOyBsaW51eC0NCj4ga2VybmVsQHZnZXIua2VybmVsLm9yZw0KPiBT
dWJqZWN0OiBSZTogW1BBVENIXVtSRkNdIERvY3VtZW50YXRpb24vOiB1cGRhdGUgaGliZXJuYXRp
b24gZGVidWcNCj4gZG9jdW1lbnRhdGlvbg0KPiANCj4gT24gRnJpLCBBdWcgMTIsIDIwMTYgYXQg
MTo0NiBQTSwgQ2hlbiwgWXUgQyA8eXUuYy5jaGVuQGludGVsLmNvbT4gd3JvdGU6DQo+ID4gSGkg
UGF2ZWwsDQo+ID4NCj4gPj4gLS0tLS1PcmlnaW5hbCBNZXNzYWdlLS0tLS0NCj4gPj4gRnJvbTog
UGF2ZWwgTWFjaGVrIFttYWlsdG86cGF2ZWxAdWN3LmN6XQ0KPiA+PiBTZW50OiBGcmlkYXksIEF1
Z3VzdCAxMiwgMjAxNiAyOjIzIFBNDQo+ID4+IFRvOiBDaGVuLCBZdSBDDQo+ID4+IENjOiBMaW51
eCBQTSBMaXN0OyBSYWZhZWwgSi4gV3lzb2NraTsgTGVuIEJyb3duOw0KPiA+PiBsaW51eC1rZXJu
ZWxAdmdlci5rZXJuZWwub3JnDQo+ID4+IFN1YmplY3Q6IFJlOiBbUEFUQ0hdW1JGQ10gRG9jdW1l
bnRhdGlvbi86IHVwZGF0ZSBoaWJlcm5hdGlvbiBkZWJ1Zw0KPiA+PiBkb2N1bWVudGF0aW9uDQo+
ID4+DQo+ID4+IEhpIQ0KPiA+Pg0KPiA+PiA+IFVwZGF0ZSB0aGUgZGVzY3JpcHRpb24gb2YgdGVz
dF9yZXN1bWUgbW9kZSBmb3IgaGliZXJuYXRpb24uDQo+ID4+ID4NCj4gPj4gPiBTaWduZWQtb2Zm
LWJ5OiBDaGVuIFl1IDx5dS5jLmNoZW5AaW50ZWwuY29tPg0KPiA+PiA+IC0tLQ0KPiA+PiA+ICBE
b2N1bWVudGF0aW9uL3Bvd2VyL2Jhc2ljLXBtLWRlYnVnZ2luZy50eHQgfCA3ICsrKysrKysNCj4g
Pj4gPiAgMSBmaWxlIGNoYW5nZWQsIDcgaW5zZXJ0aW9ucygrKQ0KPiA+Pg0KPiA+PiBUaGF0J3Mg
Y2VydGFpbmx5IHN0ZXAgaW4gdGhlIHJpZ2h0IGRpcmVjdGlvbiwgYnV0IEkgZ3Vlc3MgaXQgc2hv
dWxkDQo+ID4+IGJlIG1lbnRpb25lZCBpbiB0aGUgb3RoZXIgcGxhY2VzLCB0b28uIFNvbWV0aGlu
ZyBsaWtlIHRoaXM/DQo+ID4+DQo+ID4+IEFkZGl0aW9uYWxseSwgd2UgaGF2ZSB0ZXN0cHJvYy4g
U2hvdWxkIHdlIG1vdmUgaXQgdG8gdGVzdF9wcm9jIGZvcg0KPiA+PiBjb25zaXN0ZW5jeSAob3Ig
cmVwbGFjZSB0ZXN0X3Jlc3VtZSB3aXRoIHNpbXBsZSAicmVzdW1lIj8gVGhhdCdzIHdoYXQNCj4g
Pj4gaXQgZG9lcy4uLiBpdCBpcw0KPiA+PiBoaWJlcm5hdGUrcmVzdW1lLi4uDQo+ID4gSXQgbG9v
a3MgbGlrZSB0ZXN0cHJvYyBoYXMgYmVlbiByZW1vdmVkIGluIGNvbW1pdA0KPiA+IDQ4NTgwYWI4
NzI5ODY1YzgxZTE0OGQ1OTE1OWZiZTJhYTc4NjU1MTEsDQo+IA0KPiBZZXMsIGl0IHdhcyByZW1v
dmVkLCBiYWNrIGluIDIwMTEuDQo+IA0KPiA+IHNvIEkgdGhpbmsgd2UgY2FuIHJlcGxhY2UgJ3Rl
c3Rwcm9jL3Rlc3QnIHdpdGggJ3Jlc3VtZScgaW4NCj4gPiBpbnRlcmZhY2UudHh0IGFuZCBhZGQg
c29tZSBkZXNjcmlwdGlvbiBpbiBpdCwgSSdsbCBkbyB0aGF0LCB0aGFua3MuDQo+IA0KPiBZb3Ug
bWVhbiAidGVzdF9yZXN1bWUiIEkgc3VwcG9zZT8NClllcy4NCj4gDQo+IENsZWFybHksIHRoZSBk
b2N1bWVudGF0aW9uIG5lZWRzIHRvIGJlIHVwZGF0ZWQuDQo+IA0KPiBMZXQgbWUgdGFrZSBjYXJl
IG9mIHRoYXQgbGF0ZXIgdG9kYXkuDQpPSywgdGhhbmtzIQ0KDQpZdQ0K
--
To unsubscribe from this list: send the line "unsubscribe linux-pm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/power/interface.txt b/Documentation/power/interface.txt
index f1f0f59a..d4ac8f7 100644
--- a/Documentation/power/interface.txt
+++ b/Documentation/power/interface.txt
@@ -23,8 +23,8 @@  few options for putting the system to sleep - using the platform driver
 (e.g. ACPI or other suspend_ops), powering off the system or rebooting the
 system (for testing).
 
-Additionally, /sys/power/disk can be used to turn on one of the two testing
-modes of the suspend-to-disk mechanism: 'testproc' or 'test'.  If the
+Additionally, /sys/power/disk can be used to turn on one of the three testing
+modes of the suspend-to-disk mechanism: 'test_resume', 'testproc' or 'test'.  If the
 suspend-to-disk mechanism is in the 'testproc' mode, writing 'disk' to
 /sys/power/state will cause the kernel to disable nonboot CPUs and freeze
 tasks, wait for 5 seconds, unfreeze tasks and enable nonboot CPUs.  If it is
@@ -32,12 +32,13 @@  in the 'test' mode, writing 'disk' to /sys/power/state will cause the kernel
 to disable nonboot CPUs and freeze tasks, shrink memory, suspend devices, wait
 for 5 seconds, resume devices, unfreeze tasks and enable nonboot CPUs.  Then,
 we are able to look in the log messages and work out, for example, which code
-is being slow and which device drivers are misbehaving.
+is being slow and which device drivers are misbehaving. In 'test_resume' mode,
+... (insert your description here).
 
 Reading from this file will display all supported modes and the currently
 selected one in brackets, for example
 
-	[shutdown] reboot test testproc
+	[shutdown] reboot test testproc test_resume
 
 Writing to this file will accept one of