Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: 8af9fa37b8a3 ("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>

authored by

Mauro Carvalho Chehab and committed by
Hans de Goede
2166cc26 c99ca78d

+38 -22
+38 -22
Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi
··· 1 1 What: /sys/bus/wmi/devices/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_supported_type 2 2 Date: Apr 2021 3 3 KernelVersion: 5.13 4 - Contact: "perry.yuan@dell.com>" 4 + Contact: "<perry.yuan@dell.com>" 5 5 Description: 6 6 Display which dell hardware level privacy devices are supported 7 7 “Dell Privacy” is a set of HW, FW, and SW features to enhance 8 8 Dell’s commitment to platform privacy for MIC, Camera, and 9 9 ePrivacy screens. 10 10 The supported hardware privacy devices are: 11 - Attributes: 12 - Microphone Mute: 11 + 12 + Attributes: 13 + Microphone Mute: 13 14 Identifies the local microphone can be muted by hardware, no applications 14 15 is available to capture system mic sound 15 16 16 - Camera Shutter: 17 + Camera Shutter: 17 18 Identifies camera shutter controlled by hardware, which is a micromechanical 18 19 shutter assembly that is built onto the camera module to block capturing images 19 20 from outside the laptop 20 21 21 - supported: 22 + Values: 23 + 24 + supported: 22 25 The privacy device is supported by this system 23 26 24 - unsupported: 27 + unsupported: 25 28 The privacy device is not supported on this system 26 29 27 - For example to check which privacy devices are supported: 30 + For example to check which privacy devices are supported:: 28 31 29 - # cat /sys/bus/wmi/drivers/dell-privacy/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_supported_type 30 - [Microphone Mute] [supported] 31 - [Camera Shutter] [supported] 32 - [ePrivacy Screen] [unsupported] 32 + # cat /sys/bus/wmi/drivers/dell-privacy/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_supported_type 33 + [Microphone Mute] [supported] 34 + [Camera Shutter] [supported] 35 + [ePrivacy Screen] [unsupported] 33 36 34 37 What: /sys/bus/wmi/devices/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_current_state 35 38 Date: Apr 2021 36 39 KernelVersion: 5.13 37 - Contact: "perry.yuan@dell.com>" 40 + Contact: "<perry.yuan@dell.com>" 38 41 Description: 39 42 Allow user space to check current dell privacy device state. 40 43 Describes the Device State class exposed by BIOS which can be 41 44 consumed by various applications interested in knowing the Privacy 42 45 feature capabilities 43 - Attributes: 44 - muted: 45 - Identifies the privacy device is turned off and cannot send stream to OS applications 46 46 47 - unmuted: 48 - Identifies the privacy device is turned on ,audio or camera driver can get 49 - stream from mic and camera module to OS applications 47 + Attributes: 48 + Microphone: 49 + Identifies the local microphone can be muted by hardware, no applications 50 + is available to capture system mic sound 50 51 51 - For example to check all supported current privacy device states: 52 + Camera Shutter: 53 + Identifies camera shutter controlled by hardware, which is a micromechanical 54 + shutter assembly that is built onto the camera module to block capturing images 55 + from outside the laptop 52 56 53 - # cat /sys/bus/wmi/drivers/dell-privacy/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_current_state 54 - [Microphone] [unmuted] 55 - [Camera Shutter] [unmuted] 57 + Values: 58 + muted: 59 + Identifies the privacy device is turned off 60 + and cannot send stream to OS applications 61 + 62 + unmuted: 63 + Identifies the privacy device is turned on, 64 + audio or camera driver can get stream from mic 65 + and camera module to OS applications 66 + 67 + For example to check all supported current privacy device states:: 68 + 69 + # cat /sys/bus/wmi/drivers/dell-privacy/6932965F-1671-4CEB-B988-D3AB0A901919/dell_privacy_current_state 70 + [Microphone] [unmuted] 71 + [Camera Shutter] [unmuted]