[RFC] PCI/PM: Add ABI document for sysfs file d3cold_allowed

[RFC] PCI/PM: Add ABI document for sysfs file d3cold_allowed

[Huang Ying]

This patch adds ABI document for the following sysfs file:

/sys/bus/pci/devices/.../d3cold_allowed

Signed-off-by: Huang Ying <ying.huang@intel.com>
---
 Documentation/ABI/testing/sysfs-bus-pci |   12 ++++++++++++
 1 file changed, 12 insertions(+)

--- a/Documentation/ABI/testing/sysfs-bus-pci
+++ b/Documentation/ABI/testing/sysfs-bus-pci
@@ -210,3 +210,15 @@ Users:
 		firmware assigned instance number of the PCI
 		device that can help in understanding the firmware
 		intended order of the PCI device.
+
+What:		/sys/bus/pci/devices/.../d3cold_allowed
+Date:		July 2012
+Contact:	Huang Ying <ying.huang@intel.com>
+Description:
+		d3cold_allowed is bit to control whether the corresponding PCI
+		device can be put into D3Cold state.  If it is cleared, the
+		device will never be put into D3Cold state.  If it is set, the
+		device may be put into D3Cold state if other requirement are
+		satisfied too.  Reading this attribute will show the current
+		value of d3cold_allowed bit.  Writting this attribute will set
+		the value of d3cold_allowed bit.

Re: [RFC] PCI/PM: Add ABI document for sysfs file d3cold_allowed

[Rafael J. Wysocki]

On Friday, July 27, 2012, Huang Ying wrote:
> This patch adds ABI document for the following sysfs file:
> 
> /sys/bus/pci/devices/.../d3cold_allowed
> 
> Signed-off-by: Huang Ying <ying.huang@intel.com>

Acked-by: Rafael J. Wysocki <rjw@sisk.pl>

> ---
>  Documentation/ABI/testing/sysfs-bus-pci |   12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> --- a/Documentation/ABI/testing/sysfs-bus-pci
> +++ b/Documentation/ABI/testing/sysfs-bus-pci
> @@ -210,3 +210,15 @@ Users:
>  		firmware assigned instance number of the PCI
>  		device that can help in understanding the firmware
>  		intended order of the PCI device.
> +
> +What:		/sys/bus/pci/devices/.../d3cold_allowed
> +Date:		July 2012
> +Contact:	Huang Ying <ying.huang@intel.com>
> +Description:
> +		d3cold_allowed is bit to control whether the corresponding PCI
> +		device can be put into D3Cold state.  If it is cleared, the
> +		device will never be put into D3Cold state.  If it is set, the
> +		device may be put into D3Cold state if other requirement are
> +		satisfied too.  Reading this attribute will show the current
> +		value of d3cold_allowed bit.  Writting this attribute will set
> +		the value of d3cold_allowed bit.
> 
> 

Re: [RFC] PCI/PM: Add ABI document for sysfs file d3cold_allowed

[Don Dutile]

On 07/27/2012 04:07 AM, Huang Ying wrote:
> This patch adds ABI document for the following sysfs file:
>
> /sys/bus/pci/devices/.../d3cold_allowed
>
> Signed-off-by: Huang Ying<ying.huang@intel.com>
> ---
>   Documentation/ABI/testing/sysfs-bus-pci |   12 ++++++++++++
>   1 file changed, 12 insertions(+)
>
> --- a/Documentation/ABI/testing/sysfs-bus-pci
> +++ b/Documentation/ABI/testing/sysfs-bus-pci
> @@ -210,3 +210,15 @@ Users:
>   		firmware assigned instance number of the PCI
>   		device that can help in understanding the firmware
>   		intended order of the PCI device.
> +
> +What:		/sys/bus/pci/devices/.../d3cold_allowed
> +Date:		July 2012
> +Contact:	Huang Ying<ying.huang@intel.com>
> +Description:
> +		d3cold_allowed is bit to control whether the corresponding PCI
> +		device can be put into D3Cold state.  If it is cleared, the
> +		device will never be put into D3Cold state.  If it is set, the
> +		device may be put into D3Cold state if other requirement are
did you mean 'requirements' here? -------------------------------^
or is there only 1 other requirement?

> +		satisfied too.  Reading this attribute will show the current
> +		value of d3cold_allowed bit.  Writting this attribute will set
spell checker says 'Writing' --------------------^

> +		the value of d3cold_allowed bit.
> --
> To unsubscribe from this list: send the line "unsubscribe linux-pci" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [RFC] PCI/PM: Add ABI document for sysfs file d3cold_allowed

[Huang Ying]

Hi, Don,

Thanks for your comments.

On Mon, 2012-07-30 at 14:03 -0400, Don Dutile wrote:
> On 07/27/2012 04:07 AM, Huang Ying wrote:
> > This patch adds ABI document for the following sysfs file:
> >
> > /sys/bus/pci/devices/.../d3cold_allowed
> >
> > Signed-off-by: Huang Ying<ying.huang@intel.com>
> > ---
> >   Documentation/ABI/testing/sysfs-bus-pci |   12 ++++++++++++
> >   1 file changed, 12 insertions(+)
> >
> > --- a/Documentation/ABI/testing/sysfs-bus-pci
> > +++ b/Documentation/ABI/testing/sysfs-bus-pci
> > @@ -210,3 +210,15 @@ Users:
> >   		firmware assigned instance number of the PCI
> >   		device that can help in understanding the firmware
> >   		intended order of the PCI device.
> > +
> > +What:		/sys/bus/pci/devices/.../d3cold_allowed
> > +Date:		July 2012
> > +Contact:	Huang Ying<ying.huang@intel.com>
> > +Description:
> > +		d3cold_allowed is bit to control whether the corresponding PCI
> > +		device can be put into D3Cold state.  If it is cleared, the
> > +		device will never be put into D3Cold state.  If it is set, the
> > +		device may be put into D3Cold state if other requirement are
> did you mean 'requirements' here? -------------------------------^
> or is there only 1 other requirement?

I mean requirements here.

> 
> > +		satisfied too.  Reading this attribute will show the current
> > +		value of d3cold_allowed bit.  Writting this attribute will set
> spell checker says 'Writing' --------------------^

Sorry about my poor English and I should have spell checked it before
sending out.

Best Regards,
Huang Ying

Re: [RFC] PCI/PM: Add ABI document for sysfs file d3cold_allowed

[Don Dutile]

On 07/30/2012 11:12 PM, Huang Ying wrote:
> Hi, Don,
>
> Thanks for your comments.
>
> On Mon, 2012-07-30 at 14:03 -0400, Don Dutile wrote:
>> On 07/27/2012 04:07 AM, Huang Ying wrote:
>>> This patch adds ABI document for the following sysfs file:
>>>
>>> /sys/bus/pci/devices/.../d3cold_allowed
>>>
>>> Signed-off-by: Huang Ying<ying.huang@intel.com>
>>> ---
>>>    Documentation/ABI/testing/sysfs-bus-pci |   12 ++++++++++++
>>>    1 file changed, 12 insertions(+)
>>>
>>> --- a/Documentation/ABI/testing/sysfs-bus-pci
>>> +++ b/Documentation/ABI/testing/sysfs-bus-pci
>>> @@ -210,3 +210,15 @@ Users:
>>>    		firmware assigned instance number of the PCI
>>>    		device that can help in understanding the firmware
>>>    		intended order of the PCI device.
>>> +
>>> +What:		/sys/bus/pci/devices/.../d3cold_allowed
>>> +Date:		July 2012
>>> +Contact:	Huang Ying<ying.huang@intel.com>
>>> +Description:
>>> +		d3cold_allowed is bit to control whether the corresponding PCI
>>> +		device can be put into D3Cold state.  If it is cleared, the
>>> +		device will never be put into D3Cold state.  If it is set, the
>>> +		device may be put into D3Cold state if other requirement are
>> did you mean 'requirements' here? -------------------------------^
>> or is there only 1 other requirement?
>
> I mean requirements here.
>
>>
>>> +		satisfied too.  Reading this attribute will show the current
>>> +		value of d3cold_allowed bit.  Writting this attribute will set
>> spell checker says 'Writing' --------------------^
>
> Sorry about my poor English and I should have spell checked it before
> sending out.
>
no problem!  I figured since you were making the extra
effort to add the documentation, we might as well make it clear.
Thanks for the update.

> Best Regards,
> Huang Ying
>
>