[PATCH v3 2/3] x86/platform/dell-privacy-wmi: add document for dell privacy driver

[Perry Yuan]

Hi Mario,
Thanks for your review.
On 2021/1/13 1:54, Limonciello, Mario wrote:
>> -----Original Message-----
>> From: Yuan, Perry <Perry_Yuan at Dell.com>
>> Sent: Tuesday, January 12, 2021 11:18
>> To: oder_chiou at realtek.com; perex at perex.cz; tiwai at suse.com;
>> hdegoede at redhat.com; mgross at linux.intel.com
>> Cc: lgirdwood at gmail.com; broonie at kernel.org; alsa-devel at alsa-project.org;
>> linux-kernel at vger.kernel.org; platform-driver-x86 at vger.kernel.org; Yuan,
>> Perry; Limonciello, Mario
>> Subject: [PATCH v3 2/3] x86/platform/dell-privacy-wmi: add document for dell
>> privacy driver
>>
>> From: Perry Yuan <perry_yuan at dell.com>
>>
>> Describe the Dell Privacy feature capabilities and devices
>> state class exposed by BIOS
>>
>> Signed-off-by: Perry Yuan <perry_yuan at dell.com>
>> ---
>>   .../testing/sysfs-platform-dell-privacy-wmi   | 31 +++++++++++++++++++
>>   1 file changed, 31 insertions(+)
>>   create mode 100644 Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi
> 
> I don't see a reason that the documentation needs to come in it's own commit.
> In v4, I would think this can collapse as part of:
> "Add support for Dell hardware privacy"
> 
Agreed. will merge this patch content to "Add support for Dell hardware 
privacy"
>>
>> diff --git a/Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi
>> b/Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi
>> new file mode 100644
>> index 000000000000..3dbc2d25b60e
>> --- /dev/null
>> +++ b/Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi
>> @@ -0,0 +1,31 @@
>> +What:		/sys/bus/wmi/devices/6932965F-1671-4CEB-B988-
>> D3AB0A901919/devices_supported
>> +Date:		Jan 2021
>> +KernelVersion:	5.11
> I think this is 5.12 material now.
> Need to update this to approximate 5.12 date.
> 
>> +Contact:	"perry_yuan at dell.com>"
> 
> I think Dell addresses publicly use a period rather than an underscore, no?
> So shouldn't this be perry.yuan at dell.com? (Although I acknowledge it's an
> alias, I don't trust that I/T wouldn't remove that some day).
> 
changed using period for the mail address.
>> +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 privacy haredware privacy devices are:
> 
> You have a typo here.
will fix this in V4.
> 
>> +		 * 0x0 - None,
>> +		 * 0x1 - Microphone,
>> +		 * 0x2 - Camera,
>> +		 * 0x4 - ePrivacy Screen
> 
> So this is an bitmap encoded in the integer?  I think that needs to be mentioned
> in the documentation.
> 
Indeed it is a bitmap , will change this part as below in V4.

  What: 
/sys/bus/wmi/devices/6932965F-1671-4CEB-B988-D3AB0A901919/devices_supported
  Date:          Jan 2021
-KernelVersion: 5.11
-Contact:       "perry_yuan at dell.com>"
+KernelVersion: 5.12
+Contact:       "perry.yuan at 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
                 Dell’s commitment to platform privacy for MIC, Camera, and
                 ePrivacy screens.
-               The supported privacy haredware privacy devices are:
-                * 0x0 - None,
-                * 0x1 - Microphone,
-                * 0x2 - Camera,
-                * 0x4 - ePrivacy Screen
+               The supported hardware privacy devices are:
+               - 0 = Not Supported
+               - 1 = Supported
+               - Bit0 -> Microphone
+               - Bit1 -> Camera
+               - Bit2 -> ePrivacy Screen

>> +
>> +What:		/sys/bus/wmi/devices/6932965F-1671-4CEB-B988-
>> D3AB0A901919/current_state
>> +Date:		Jan 2021
>> +KernelVersion:	5.11
>> +Contact:	"perry_yuan at 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
>> +		There are three Bits for available states:
>> +		    * 0 -> Off
>> +		    * 1 -> On
>> +		    * Bit0 -> Microphone
>> +		    * Bit1 -> Camera
>> +		    * Bit2 -> ePrivacyScreen
>> +
>> --
>> 2.25.1
>