Re: [PATCH v7] Introduce support for Systems Management Driver over WMI for Dell Systems

[Mauro Carvalho Chehab <mchehab+huawei@kernel.org>]

Em Thu, 29 Oct 2020 09:01:14 +0100
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> escreveu:

> Em Tue, 27 Oct 2020 19:19:44 +0530
> Divya Bharathi <divya27392@gmail.com> escreveu:
> 
> > The Dell WMI Systems Management Driver provides a sysfs
> > interface for systems management to enable BIOS configuration
> > capability on certain Dell Systems.
> > 
> > This driver allows user to configure Dell systems with a
> > uniform common interface. To facilitate this, the patch
> > introduces a generic way for driver to be able to create
> > configurable BIOS Attributes available in Setup (F2) screen.
> > 
> > Cc: Hans de Goede <hdegoede@redhat.com>
> > Cc: Andy Shevchenko <andy.shevchenko@gmail.com>
> > Cc: mark gross <mgross@linux.intel.com>
> > 
> > Co-developed-by: Mario Limonciello <mario.limonciello@dell.com>
> > Signed-off-by: Mario Limonciello <mario.limonciello@dell.com>
> > Co-developed-by: Prasanth KSR <prasanth.ksr@dell.com>
> > Signed-off-by: Prasanth KSR <prasanth.ksr@dell.com>
> > Signed-off-by: Divya Bharathi <divya.bharathi@dell.com>
> > ---  
> 
> 
> > +What:		/sys/class/firmware-attributes/*/authentication/
> > +Date:		February 2021
> > +KernelVersion:	5.11
> > +Contact:	Divya Bharathi <Divya.Bharathi@Dell.com>,
> > +		Mario Limonciello <mario.limonciello@dell.com>,
> > +		Prasanth KSR <prasanth.ksr@dell.com>
> > +
> > +		Devices support various authentication mechanisms which can be exposed
> > +		as a separate configuration object.
> > +
> > +		For example a "BIOS Admin" password and "System" Password can be set,
> > +		reset or cleared using these attributes.
> > +		- An "Admin" password is used for preventing modification to the BIOS
> > +		  settings.
> > +		- A "System" password is required to boot a machine.
> > +  
> 
> This is adding a new warning:
> 
> 	$ ./scripts/get_abi.pl validate
> 	Warning: file Documentation/ABI/testing/sysfs-class-firmware-attributes#172:
> 		What '/sys/class/firmware-attributes/*/authentication/' doesn't have a description
> 
> Because you forgot to add a Description: tag.
> 
> Feel free to either add the enclosed tag to the tree which added this into
> linux-next, or to fold id with the original patch.
> 
> Thanks,
> Mauro
> 
> ABI: docs: sysfs-class-firmware-attributes: add a missing tag
>     
> The Description:  tag is missing, causing this warning with
> scripts/get_abi.pl:
>     
> 	Warning: file Documentation/ABI/testing/sysfs-class-firmware-attributes#172:
> 		 What '/sys/class/firmware-attributes/*/authentication/' doesn't have a description
>     
> Fixes: e8a60aa7404b ("platform/x86: Introduce support for Systems Management Driver over WMI for Dell Systems")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-firmware-attributes b/Documentation/ABI/testing/sysfs-class-firmware-attributes
> index 04a15c72e883..ea1837f1f3c2 100644
> --- a/Documentation/ABI/testing/sysfs-class-firmware-attributes
> +++ b/Documentation/ABI/testing/sysfs-class-firmware-attributes
> @@ -113,7 +113,7 @@ KernelVersion:	5.11
>  Contact:	Divya Bharathi <Divya.Bharathi@Dell.com>,
>  		Mario Limonciello <mario.limonciello@dell.com>,
>  		Prasanth KSR <prasanth.ksr@dell.com>
> -
> +Description:
>  		Devices support various authentication mechanisms which can be exposed
>  		as a separate configuration object.
>  
> 

There are a few other warnings produced by it, when generating the
ABI output, so, I sent a new patch covering all warnings.

If you want to test the ABI file generation, the patchset is at:

	https://git.linuxtv.org/mchehab/experimental.git/log/?h=abi_patches_v7

You can easily build just the sysfs firmware attribute class ABI with
something like this:

	$ mkdir -p fodir && cp Documentation/ABI/testing/sysfs-class-firmware-attributes fodir/ && ./scripts/get_abi.pl rest -dir fodir/ --rst-source >Documentation/foo/abi.rst && make SPHINXDIRS=foo htmldocs

You can also see it at:

	http://www.infradead.org/~mchehab/kernel_docs/foo/abi.html


Thanks,
Mauro