Re: [PATCH 2/7] ABI: sysfs-platform-dell-privacy-wmi: correct ABI entries

[Hans de Goede]

Hi,

On 9/27/21 1:10 PM, Mauro Carvalho Chehab wrote:
> As described at Documentation/ABI/README doesn't contain an
> Attribute: field.
> 
> The way sysfs ABI is supposed to work is that each different
> attribute would have a separate file. So, the right way to
> map this would be like:
> 
> 	/sys/.../dell_privacy_supported_type/mic_mute
> 	/sys/.../dell_privacy_supported_type/camera_shutter
> 
> 	/sys/.../dell_privacy_current_state/mic_mute
> 	/sys/.../dell_privacy_current_state/camera_shutter
> 
> However, it seems to late to fix that, as this was merged already on
> Kernel 5.13, and a change right now would be a regression.
> 
> So, instead, let's at least fix the entry to match the expected
> format.
> 
> While here, fix the format of the contact, which is not a valid
> e-mail URL.
> 
> This should also fix the current warnings produced when building the
> docs:
> 
> 	Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi:35: WARNING: Unexpected indentation.
> 	Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi:2: WARNING: Unexpected indentation.
> 
> Fixes: 8af9fa37b8a3 ("platform/x86: dell-privacy: Add support for Dell hardware privacy")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>

Thank you for your patch, I've applied this patch to my review-hans 
branch:
https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans

Note it will show up in my review-hans branch once I've pushed my
local branch there, which might take a while.

Once I've run some tests on this branch the patches there will be
added to the platform-drivers-x86/for-next branch and eventually
will be included in the pdx86 pull-request to Linus for the next
merge-window.

Regards,

Hans



> ---
> 
> See [PATCH 0/7] at: https://lore.kernel.org/all/cover.1632740376.git.mchehab+huawei@xxxxxxxxxx/T/#t
> 
>  .../testing/sysfs-platform-dell-privacy-wmi   | 60 ++++++++++++-------
>  1 file changed, 38 insertions(+), 22 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi b/Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi
> index 7f9e18705861..1f1f274a6979 100644
> --- a/Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi
> +++ b/Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi
> @@ -1,55 +1,71 @@
>  What:		/sys/bus/wmi/devices/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_supported_type
>  Date:		Apr 2021
>  KernelVersion:	5.13
> -Contact:	"perry.yuan@xxxxxxxx>"
> +Contact:	"<perry.yuan@xxxxxxxx>"
>  Description:
>  		Display which dell hardware level privacy devices are supported
>  		“Dell Privacy” is a set of HW, FW, and SW features to enhance
>  		Dell’s commitment to platform privacy for MIC, Camera, and
>  		ePrivacy screens.
>  		The supported hardware privacy devices are:
> -Attributes:
> -		Microphone Mute:
> +
> +		Attributes:
> +			Microphone Mute:
>  				Identifies the local microphone can be muted by hardware, no applications
>  				is available to capture system mic sound
>  
> -		Camera Shutter:
> +			Camera Shutter:
>  				Identifies camera shutter controlled by hardware, which is a micromechanical
>  				shutter assembly that is built onto the camera module to block capturing images
>  				from outside the laptop
>  
> -		supported:
> +		Values:
> +
> +			supported:
>  				The privacy device is supported by this system
>  
> -		unsupported:
> +			unsupported:
>  				The privacy device is not supported on this system
>  
> -		For example to check which privacy devices are supported:
> +		For example to check which privacy devices are supported::
>  
> -		# cat /sys/bus/wmi/drivers/dell-privacy/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_supported_type
> -		[Microphone Mute] [supported]
> -		[Camera Shutter] [supported]
> -		[ePrivacy Screen] [unsupported]
> +		    # cat /sys/bus/wmi/drivers/dell-privacy/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_supported_type
> +		    [Microphone Mute] [supported]
> +		    [Camera Shutter] [supported]
> +		    [ePrivacy Screen] [unsupported]
>  
>  What:		/sys/bus/wmi/devices/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_current_state
>  Date:		Apr 2021
>  KernelVersion:	5.13
> -Contact:	"perry.yuan@xxxxxxxx>"
> +Contact:	"<perry.yuan@xxxxxxxx>"
>  Description:
>  		Allow user space to check current dell privacy device state.
>  		Describes the Device State class exposed by BIOS which can be
>  		consumed by various applications interested in knowing the Privacy
>  		feature capabilities
> -Attributes:
> -		muted:
> -			Identifies the privacy device is turned off and cannot send stream to OS applications
>  
> -		unmuted:
> -			Identifies the privacy device is turned on ,audio or camera driver can get
> -			stream from mic and camera module to OS applications
> +		Attributes:
> +			Microphone:
> +				Identifies the local microphone can be muted by hardware, no applications
> +				is available to capture system mic sound
>  
> -		For example to check all supported current privacy device states:
> +			Camera Shutter:
> +				Identifies camera shutter controlled by hardware, which is a micromechanical
> +				shutter assembly that is built onto the camera module to block capturing images
> +				from outside the laptop
>  
> -		# cat /sys/bus/wmi/drivers/dell-privacy/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_current_state
> -		[Microphone] [unmuted]
> -		[Camera Shutter] [unmuted]
> +		Values:
> +			muted:
> +				Identifies the privacy device is turned off
> +				and cannot send stream to OS applications
> +
> +			unmuted:
> +				Identifies the privacy device is turned on,
> +				audio or camera driver can get stream from mic
> +				and camera module to OS applications
> +
> +		For example to check all supported current privacy device states::
> +
> +		    # cat /sys/bus/wmi/drivers/dell-privacy/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_current_state
> +		    [Microphone] [unmuted]
> +		    [Camera Shutter] [unmuted]
>