Re: [PATCH] Documentation: sysfs-bus-usb: update power/persist description

[Alan Stern]

On Tue, 24 Jun 2014, Paul Bolle wrote:

> There's no power/persist file for hubs. And CONFIG_USB_PERSIST was
> removed in v2.6.26. Update the description of power/persist accordingly.
> 
> Signed-off-by: Paul Bolle <pebolle@xxxxxxxxxx>
> ---
> I don't know anything about USB-Persist. Could Greg and Alan please
> check whether the new description does actually match reality?

Not exactly.  More details below.

>  Documentation/ABI/stable/sysfs-bus-usb | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/Documentation/ABI/stable/sysfs-bus-usb b/Documentation/ABI/stable/sysfs-bus-usb
> index a6b685724740..a61d04b8fc78 100644
> --- a/Documentation/ABI/stable/sysfs-bus-usb
> +++ b/Documentation/ABI/stable/sysfs-bus-usb
> @@ -3,13 +3,13 @@ Date:		May 2007
>  KernelVersion:	2.6.23
>  Contact:	Alan Stern <stern@xxxxxxxxxxxxxxxxxxx>
>  Description:
> -		If CONFIG_USB_PERSIST is set, then each USB device directory
> -		will contain a file named power/persist.  The file holds a
> -		boolean value (0 or 1) indicating whether or not the
> -		"USB-Persist" facility is enabled for the device.  Since the
> -		facility is inherently dangerous, it is disabled by default
> -		for all devices except hubs.  For more information, see
> -		Documentation/usb/persist.txt.
> +		USB device directories for all devices except hubs will contain
> +		a file named power/persist.  The file holds a boolean value (0
> +		or 1) indicating whether or not the "USB-Persist" facility is
> +		enabled for the device.  Since the facility is inherently
> +		dangerous, it is disabled by default.  For hubs this facility is
> +		always enabled making the file pointless.  For more information,
> +		see Documentation/usb/persist.txt.

Instead of depending on CONFIG_USB_PERSIST, the power/persist attribute
depends on CONFIG_PM.  But pointing that out would be redundant, since
the power/ device directory itself doesn't exist unless CONFIG_PM is
enabled.

The default value for the persist facility depends on the setting of 
CONFIG_USB_DEFAULT_PERSIST.  If that symbol is set then persist is 
enabled by default for all devices, except those which have the 
USB_QUIRK_RESET flag set (meaning that they will morph or change modes 
when reset).  If the symbol is not set then persist is enabled by 
default only for hubs.

Thanks for the documentation update.

Alan Stern

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/