diff mbox series

[v3,1/5] platform/x86: think-lmi: Enable opcode support on BIOS settings

Message ID 20230526171658.3886-1-mpearson-lenovo@squebb.ca (mailing list archive)
State Changes Requested, archived
Headers show
Series [v3,1/5] platform/x86: think-lmi: Enable opcode support on BIOS settings | expand

Commit Message

Mark Pearson May 26, 2023, 5:16 p.m. UTC
Whilst reviewing some documentation from the FW team on using WMI on
Lenovo system I noticed that we weren't using Opcode support when
changing BIOS settings in the thinkLMI driver.

We should be doing this to ensure we're future proof as the old
non-opcode mechanism has been deprecated.

Tested on X1 Carbon G10 and G11.

Signed-off-by: Mark Pearson <mpearson-lenovo@squebb.ca>
---
Changes in v2: Update comment for clearer explanation of what the driver
is doing
Changes in v3: None. Version bump with rest of series

 drivers/platform/x86/think-lmi.c | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

Comments

Ilpo Järvinen May 29, 2023, 11:51 a.m. UTC | #1
On Fri, 26 May 2023, Mark Pearson wrote:

> Whilst reviewing some documentation from the FW team on using WMI on
> Lenovo system I noticed that we weren't using Opcode support when
> changing BIOS settings in the thinkLMI driver.
> 
> We should be doing this to ensure we're future proof as the old
> non-opcode mechanism has been deprecated.
> 
> Tested on X1 Carbon G10 and G11.
> 
> Signed-off-by: Mark Pearson <mpearson-lenovo@squebb.ca>
> ---
> Changes in v2: Update comment for clearer explanation of what the driver
> is doing
> Changes in v3: None. Version bump with rest of series
> 
>  drivers/platform/x86/think-lmi.c | 28 +++++++++++++++++++++++++++-
>  1 file changed, 27 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/platform/x86/think-lmi.c b/drivers/platform/x86/think-lmi.c
> index 1138f770149d..2745224f62ab 100644
> --- a/drivers/platform/x86/think-lmi.c
> +++ b/drivers/platform/x86/think-lmi.c
> @@ -1001,7 +1001,33 @@ static ssize_t current_value_store(struct kobject *kobj,
>  				tlmi_priv.pwd_admin->save_signature);
>  		if (ret)
>  			goto out;
> -	} else { /* Non certiifcate based authentication */
> +	} else if (tlmi_priv.opcode_support) {
> +		/*
> +		 * If opcode support is present use that interface.
> +		 * Note - this sets the variable and then the password as separate
> +		 * WMI calls. Function tlmi_save_bios_settings will error if the
> +		 * password is incorrect.
> +		 */
> +		set_str = kasprintf(GFP_KERNEL, "%s,%s;", setting->display_name,
> +					new_setting);

Alignment.

> +		if (!set_str) {
> +			ret = -ENOMEM;
> +			goto out;
> +		}
> +
> +		ret = tlmi_simple_call(LENOVO_SET_BIOS_SETTINGS_GUID, set_str);
> +		if (ret)
> +			goto out;
> +
> +		if (tlmi_priv.pwd_admin->valid && tlmi_priv.pwd_admin->password[0]) {
> +			ret = tlmi_opcode_setting("WmiOpcodePasswordAdmin",
> +					tlmi_priv.pwd_admin->password);

Align.

> +			if (ret)
> +				goto out;
> +		}
> +
> +		ret = tlmi_save_bios_settings("");
> +	} else { /* old non opcode based authentication method (deprecated)*/

non missing hyphen.

Missing space at the comment closing.

>  		if (tlmi_priv.pwd_admin->valid && tlmi_priv.pwd_admin->password[0]) {
>  			auth_str = kasprintf(GFP_KERNEL, "%s,%s,%s;",
>  					tlmi_priv.pwd_admin->password,
> 

Except for those style issues, it look okay to me:

Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Mark Pearson May 29, 2023, 2:49 p.m. UTC | #2
On Mon, May 29, 2023, at 7:51 AM, Ilpo Järvinen wrote:
> On Fri, 26 May 2023, Mark Pearson wrote:
>
>> Whilst reviewing some documentation from the FW team on using WMI on
>> Lenovo system I noticed that we weren't using Opcode support when
>> changing BIOS settings in the thinkLMI driver.
>> 
>> We should be doing this to ensure we're future proof as the old
>> non-opcode mechanism has been deprecated.
>> 
>> Tested on X1 Carbon G10 and G11.
>> 
>> Signed-off-by: Mark Pearson <mpearson-lenovo@squebb.ca>
>> ---
>> Changes in v2: Update comment for clearer explanation of what the driver
>> is doing
>> Changes in v3: None. Version bump with rest of series
>> 
>>  drivers/platform/x86/think-lmi.c | 28 +++++++++++++++++++++++++++-
>>  1 file changed, 27 insertions(+), 1 deletion(-)
>> 
>> diff --git a/drivers/platform/x86/think-lmi.c b/drivers/platform/x86/think-lmi.c
>> index 1138f770149d..2745224f62ab 100644
>> --- a/drivers/platform/x86/think-lmi.c
>> +++ b/drivers/platform/x86/think-lmi.c
>> @@ -1001,7 +1001,33 @@ static ssize_t current_value_store(struct kobject *kobj,
>>  				tlmi_priv.pwd_admin->save_signature);
>>  		if (ret)
>>  			goto out;
>> -	} else { /* Non certiifcate based authentication */
>> +	} else if (tlmi_priv.opcode_support) {
>> +		/*
>> +		 * If opcode support is present use that interface.
>> +		 * Note - this sets the variable and then the password as separate
>> +		 * WMI calls. Function tlmi_save_bios_settings will error if the
>> +		 * password is incorrect.
>> +		 */
>> +		set_str = kasprintf(GFP_KERNEL, "%s,%s;", setting->display_name,
>> +					new_setting);
>
> Alignment.

OK - I assume you want the new_setting lined up under the bracket.
I've not seen that called out as a requirement (https://www.kernel.org/doc/html/v4.10/process/coding-style.html) but I don't mind fixing....but if you can point me at the specifics it's appreciated

>
>> +		if (!set_str) {
>> +			ret = -ENOMEM;
>> +			goto out;
>> +		}
>> +
>> +		ret = tlmi_simple_call(LENOVO_SET_BIOS_SETTINGS_GUID, set_str);
>> +		if (ret)
>> +			goto out;
>> +
>> +		if (tlmi_priv.pwd_admin->valid && tlmi_priv.pwd_admin->password[0]) {
>> +			ret = tlmi_opcode_setting("WmiOpcodePasswordAdmin",
>> +					tlmi_priv.pwd_admin->password);
>
> Align.

Ack.

>
>> +			if (ret)
>> +				goto out;
>> +		}
>> +
>> +		ret = tlmi_save_bios_settings("");
>> +	} else { /* old non opcode based authentication method (deprecated)*/
>
> non missing hyphen.

non-opcode I assume?

>
> Missing space at the comment closing.

Will fix.

>
>>  		if (tlmi_priv.pwd_admin->valid && tlmi_priv.pwd_admin->password[0]) {
>>  			auth_str = kasprintf(GFP_KERNEL, "%s,%s,%s;",
>>  					tlmi_priv.pwd_admin->password,
>> 
>
> Except for those style issues, it look okay to me:
>
> Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
>
Thanks for the review!
Mark
Ilpo Järvinen May 29, 2023, 3:36 p.m. UTC | #3
On Mon, 29 May 2023, Mark Pearson wrote:
> On Mon, May 29, 2023, at 7:51 AM, Ilpo Järvinen wrote:
> > On Fri, 26 May 2023, Mark Pearson wrote:
> >
> >> Whilst reviewing some documentation from the FW team on using WMI on
> >> Lenovo system I noticed that we weren't using Opcode support when
> >> changing BIOS settings in the thinkLMI driver.
> >> 
> >> We should be doing this to ensure we're future proof as the old
> >> non-opcode mechanism has been deprecated.
> >> 
> >> Tested on X1 Carbon G10 and G11.
> >> 
> >> Signed-off-by: Mark Pearson <mpearson-lenovo@squebb.ca>
> >> ---
> >> Changes in v2: Update comment for clearer explanation of what the driver
> >> is doing
> >> Changes in v3: None. Version bump with rest of series
> >> 
> >>  drivers/platform/x86/think-lmi.c | 28 +++++++++++++++++++++++++++-
> >>  1 file changed, 27 insertions(+), 1 deletion(-)
> >> 
> >> diff --git a/drivers/platform/x86/think-lmi.c b/drivers/platform/x86/think-lmi.c
> >> index 1138f770149d..2745224f62ab 100644
> >> --- a/drivers/platform/x86/think-lmi.c
> >> +++ b/drivers/platform/x86/think-lmi.c
> >> @@ -1001,7 +1001,33 @@ static ssize_t current_value_store(struct kobject *kobj,
> >>  				tlmi_priv.pwd_admin->save_signature);
> >>  		if (ret)
> >>  			goto out;
> >> -	} else { /* Non certiifcate based authentication */
> >> +	} else if (tlmi_priv.opcode_support) {
> >> +		/*
> >> +		 * If opcode support is present use that interface.
> >> +		 * Note - this sets the variable and then the password as separate
> >> +		 * WMI calls. Function tlmi_save_bios_settings will error if the
> >> +		 * password is incorrect.
> >> +		 */
> >> +		set_str = kasprintf(GFP_KERNEL, "%s,%s;", setting->display_name,
> >> +					new_setting);
> >
> > Alignment.
> 
> OK - I assume you want the new_setting lined up under the bracket.
> I've not seen that called out as a requirement (https://www.kernel.org/doc/html/v4.10/process/coding-style.html) but I don't mind fixing....but if you can point me at the specifics it's appreciated

Yes, I meant aligning to the column following the opening parenthesis.

I guess it's not a hard requirement, however, there's a benefit from 
certain things aligning because it helps in the brains in the process of 
converting text into structure with less effort (when not specifically not 
focusing on that particular line).

> >> +		if (!set_str) {
> >> +			ret = -ENOMEM;
> >> +			goto out;
> >> +		}
> >> +
> >> +		ret = tlmi_simple_call(LENOVO_SET_BIOS_SETTINGS_GUID, set_str);
> >> +		if (ret)
> >> +			goto out;
> >> +
> >> +		if (tlmi_priv.pwd_admin->valid && tlmi_priv.pwd_admin->password[0]) {
> >> +			ret = tlmi_opcode_setting("WmiOpcodePasswordAdmin",
> >> +					tlmi_priv.pwd_admin->password);
> >
> > Align.
> 
> Ack.
> 
> >
> >> +			if (ret)
> >> +				goto out;
> >> +		}
> >> +
> >> +		ret = tlmi_save_bios_settings("");
> >> +	} else { /* old non opcode based authentication method (deprecated)*/
> >
> > non missing hyphen.
> 
> non-opcode I assume?

I think the most proper English would be non-opcode-based since "opcode 
based" belong together (but I'm not a native speaker here).
Mark Pearson May 29, 2023, 4:06 p.m. UTC | #4
On Mon, May 29, 2023, at 11:36 AM, Ilpo Järvinen wrote:
> On Mon, 29 May 2023, Mark Pearson wrote:
>> On Mon, May 29, 2023, at 7:51 AM, Ilpo Järvinen wrote:
>> > On Fri, 26 May 2023, Mark Pearson wrote:
>> >
>> >> Whilst reviewing some documentation from the FW team on using WMI on
>> >> Lenovo system I noticed that we weren't using Opcode support when
>> >> changing BIOS settings in the thinkLMI driver.
>> >> 
>> >> We should be doing this to ensure we're future proof as the old
>> >> non-opcode mechanism has been deprecated.
>> >> 
>> >> Tested on X1 Carbon G10 and G11.
>> >> 
>> >> Signed-off-by: Mark Pearson <mpearson-lenovo@squebb.ca>
>> >> ---
>> >> Changes in v2: Update comment for clearer explanation of what the driver
>> >> is doing
>> >> Changes in v3: None. Version bump with rest of series
>> >> 
>> >>  drivers/platform/x86/think-lmi.c | 28 +++++++++++++++++++++++++++-
>> >>  1 file changed, 27 insertions(+), 1 deletion(-)
>> >> 
>> >> diff --git a/drivers/platform/x86/think-lmi.c b/drivers/platform/x86/think-lmi.c
>> >> index 1138f770149d..2745224f62ab 100644
>> >> --- a/drivers/platform/x86/think-lmi.c
>> >> +++ b/drivers/platform/x86/think-lmi.c
>> >> @@ -1001,7 +1001,33 @@ static ssize_t current_value_store(struct kobject *kobj,
>> >>  				tlmi_priv.pwd_admin->save_signature);
>> >>  		if (ret)
>> >>  			goto out;
>> >> -	} else { /* Non certiifcate based authentication */
>> >> +	} else if (tlmi_priv.opcode_support) {
>> >> +		/*
>> >> +		 * If opcode support is present use that interface.
>> >> +		 * Note - this sets the variable and then the password as separate
>> >> +		 * WMI calls. Function tlmi_save_bios_settings will error if the
>> >> +		 * password is incorrect.
>> >> +		 */
>> >> +		set_str = kasprintf(GFP_KERNEL, "%s,%s;", setting->display_name,
>> >> +					new_setting);
>> >
>> > Alignment.
>> 
>> OK - I assume you want the new_setting lined up under the bracket.
>> I've not seen that called out as a requirement (https://www.kernel.org/doc/html/v4.10/process/coding-style.html) but I don't mind fixing....but if you can point me at the specifics it's appreciated
>
> Yes, I meant aligning to the column following the opening parenthesis.
>
> I guess it's not a hard requirement, however, there's a benefit from 
> certain things aligning because it helps in the brains in the process of 
> converting text into structure with less effort (when not specifically not 
> focusing on that particular line).

Not a problem. Happy to make this change along with the others. Was just curious :)

>
>> >> +		if (!set_str) {
>> >> +			ret = -ENOMEM;
>> >> +			goto out;
>> >> +		}
>> >> +
>> >> +		ret = tlmi_simple_call(LENOVO_SET_BIOS_SETTINGS_GUID, set_str);
>> >> +		if (ret)
>> >> +			goto out;
>> >> +
>> >> +		if (tlmi_priv.pwd_admin->valid && tlmi_priv.pwd_admin->password[0]) {
>> >> +			ret = tlmi_opcode_setting("WmiOpcodePasswordAdmin",
>> >> +					tlmi_priv.pwd_admin->password);
>> >
>> > Align.
>> 
>> Ack.
>> 
>> >
>> >> +			if (ret)
>> >> +				goto out;
>> >> +		}
>> >> +
>> >> +		ret = tlmi_save_bios_settings("");
>> >> +	} else { /* old non opcode based authentication method (deprecated)*/
>> >
>> > non missing hyphen.
>> 
>> non-opcode I assume?
>
> I think the most proper English would be non-opcode-based since "opcode 
> based" belong together (but I'm not a native speaker here).

I am a native speaker....and I don't know :) (English is weird...)
Let's go with non-opcode; adding the based on there feels wrong to me (somewhat arbitrarily).

>
> -- 
>  i.
Hans de Goede May 30, 2023, 10:54 a.m. UTC | #5
Hi Mark,

On 5/26/23 19:16, Mark Pearson wrote:
> Whilst reviewing some documentation from the FW team on using WMI on
> Lenovo system I noticed that we weren't using Opcode support when
> changing BIOS settings in the thinkLMI driver.
> 
> We should be doing this to ensure we're future proof as the old
> non-opcode mechanism has been deprecated.
> 
> Tested on X1 Carbon G10 and G11.
> 
> Signed-off-by: Mark Pearson <mpearson-lenovo@squebb.ca>

Thank you for this new version. Please prepare a v4 addressing Ilpo's
review remarks.

About the aligning function arguments on the next line to the '('
of the function call start at the previous line, checkpatch also
checks for this.

It is always a good idea to run checkpatch before submitting patches.

E.g.:

git format-patch -v3 HEAD~5
scripts/checkpatch.pl v3-00*.patch
<check output is clean>
git send-email v3-00*.patch

Regards,

Hans





> ---
> Changes in v2: Update comment for clearer explanation of what the driver
> is doing
> Changes in v3: None. Version bump with rest of series
> 
>  drivers/platform/x86/think-lmi.c | 28 +++++++++++++++++++++++++++-
>  1 file changed, 27 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/platform/x86/think-lmi.c b/drivers/platform/x86/think-lmi.c
> index 1138f770149d..2745224f62ab 100644
> --- a/drivers/platform/x86/think-lmi.c
> +++ b/drivers/platform/x86/think-lmi.c
> @@ -1001,7 +1001,33 @@ static ssize_t current_value_store(struct kobject *kobj,
>  				tlmi_priv.pwd_admin->save_signature);
>  		if (ret)
>  			goto out;
> -	} else { /* Non certiifcate based authentication */
> +	} else if (tlmi_priv.opcode_support) {
> +		/*
> +		 * If opcode support is present use that interface.
> +		 * Note - this sets the variable and then the password as separate
> +		 * WMI calls. Function tlmi_save_bios_settings will error if the
> +		 * password is incorrect.
> +		 */
> +		set_str = kasprintf(GFP_KERNEL, "%s,%s;", setting->display_name,
> +					new_setting);
> +		if (!set_str) {
> +			ret = -ENOMEM;
> +			goto out;
> +		}
> +
> +		ret = tlmi_simple_call(LENOVO_SET_BIOS_SETTINGS_GUID, set_str);
> +		if (ret)
> +			goto out;
> +
> +		if (tlmi_priv.pwd_admin->valid && tlmi_priv.pwd_admin->password[0]) {
> +			ret = tlmi_opcode_setting("WmiOpcodePasswordAdmin",
> +					tlmi_priv.pwd_admin->password);
> +			if (ret)
> +				goto out;
> +		}
> +
> +		ret = tlmi_save_bios_settings("");
> +	} else { /* old non opcode based authentication method (deprecated)*/
>  		if (tlmi_priv.pwd_admin->valid && tlmi_priv.pwd_admin->password[0]) {
>  			auth_str = kasprintf(GFP_KERNEL, "%s,%s,%s;",
>  					tlmi_priv.pwd_admin->password,
Mark Pearson May 30, 2023, 1:08 p.m. UTC | #6
Hi Hans

On Tue, May 30, 2023, at 6:54 AM, Hans de Goede wrote:
> Hi Mark,
>
> On 5/26/23 19:16, Mark Pearson wrote:
>> Whilst reviewing some documentation from the FW team on using WMI on
>> Lenovo system I noticed that we weren't using Opcode support when
>> changing BIOS settings in the thinkLMI driver.
>> 
>> We should be doing this to ensure we're future proof as the old
>> non-opcode mechanism has been deprecated.
>> 
>> Tested on X1 Carbon G10 and G11.
>> 
>> Signed-off-by: Mark Pearson <mpearson-lenovo@squebb.ca>
>
> Thank you for this new version. Please prepare a v4 addressing Ilpo's
> review remarks.

Will do

>
> About the aligning function arguments on the next line to the '('
> of the function call start at the previous line, checkpatch also
> checks for this.
>
> It is always a good idea to run checkpatch before submitting patches.

I always do - and checkpatch isn't complaining about the alignment here.

Mark
diff mbox series

Patch

diff --git a/drivers/platform/x86/think-lmi.c b/drivers/platform/x86/think-lmi.c
index 1138f770149d..2745224f62ab 100644
--- a/drivers/platform/x86/think-lmi.c
+++ b/drivers/platform/x86/think-lmi.c
@@ -1001,7 +1001,33 @@  static ssize_t current_value_store(struct kobject *kobj,
 				tlmi_priv.pwd_admin->save_signature);
 		if (ret)
 			goto out;
-	} else { /* Non certiifcate based authentication */
+	} else if (tlmi_priv.opcode_support) {
+		/*
+		 * If opcode support is present use that interface.
+		 * Note - this sets the variable and then the password as separate
+		 * WMI calls. Function tlmi_save_bios_settings will error if the
+		 * password is incorrect.
+		 */
+		set_str = kasprintf(GFP_KERNEL, "%s,%s;", setting->display_name,
+					new_setting);
+		if (!set_str) {
+			ret = -ENOMEM;
+			goto out;
+		}
+
+		ret = tlmi_simple_call(LENOVO_SET_BIOS_SETTINGS_GUID, set_str);
+		if (ret)
+			goto out;
+
+		if (tlmi_priv.pwd_admin->valid && tlmi_priv.pwd_admin->password[0]) {
+			ret = tlmi_opcode_setting("WmiOpcodePasswordAdmin",
+					tlmi_priv.pwd_admin->password);
+			if (ret)
+				goto out;
+		}
+
+		ret = tlmi_save_bios_settings("");
+	} else { /* old non opcode based authentication method (deprecated)*/
 		if (tlmi_priv.pwd_admin->valid && tlmi_priv.pwd_admin->password[0]) {
 			auth_str = kasprintf(GFP_KERNEL, "%s,%s,%s;",
 					tlmi_priv.pwd_admin->password,