linux-imx/Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi
Mauro Carvalho Chehab 2166cc2657 ABI: sysfs-platform-dell-privacy-wmi: correct ABI entries
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: 8af9fa37b8 ("platform/x86: dell-privacy: Add support for Dell hardware privacy")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/42846621fdf2bf206feb114d06b14cbc47475fb5.1632740376.git.mchehab+huawei@kernel.org
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
2021-10-11 14:52:02 +02:00

2.5 KiB
Raw Permalink Blame History

What: /sys/bus/wmi/devices/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_supported_type Date: Apr 2021 KernelVersion: 5.13 Contact: "perry.yuan@dell.com" Description: Display which dell hardware level privacy devices are supported “Dell Privacy” is a set of HW, FW, and SW features to enhance Dells commitment to platform privacy for MIC, Camera, and ePrivacy screens. The supported hardware privacy devices are:

	Attributes:
		Microphone Mute:
			Identifies the local microphone can be muted by hardware, no applications
			is available to capture system mic sound

		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

	Values:

		supported:
			The privacy device is supported by this system

		unsupported:
			The privacy device is not supported on this system

	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]

What: /sys/bus/wmi/devices/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_current_state Date: Apr 2021 KernelVersion: 5.13 Contact: "perry.yuan@dell.com" 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:
		Microphone:
			Identifies the local microphone can be muted by hardware, no applications
			is available to capture system mic sound

		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

	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]