[PATCH v2] platform/x86: lenovo-yoga-tab2-pro-1380-fastcharger: fix race condition

[PATCH v2] platform/x86: lenovo-yoga-tab2-pro-1380-fastcharger: fix race condition

[Chenyuan Yang]

The yt2_1380_fc_serdev_probe() function calls devm_serdev_device_open()
before setting the client ops via serdev_device_set_client_ops(). This
ordering can trigger a NULL pointer dereference in the serdev controller's
receive_buf handler, as it assumes serdev->ops is valid when
SERPORT_ACTIVE is set.

This is similar to the issue fixed in commit 5e700b384ec1
("platform/chrome: cros_ec_uart: properly fix race condition") where
devm_serdev_device_open() was called before fully initializing the
device.

Fix the race by ensuring client ops are set before enabling the port via
devm_serdev_device_open().

Note, serdev_device_set_baudrate() and serdev_device_set_flow_control()
calls should be after the devm_serdev_device_open() call.

Fixes: b2ed33e8d486 ("platform/x86: Add lenovo-yoga-tab2-pro-1380-fastcharger driver")
Signed-off-by: Chenyuan Yang <chenyuan0y@gmail.com>
CC: Hans de Goede <hdegoede@redhat.com>
---
 drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c b/drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c
index d2699ca24f34..a96b215cd2c5 100644
--- a/drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c
+++ b/drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c
@@ -199,14 +199,15 @@ static int yt2_1380_fc_serdev_probe(struct serdev_device *serdev)
 	if (ret)
 		return ret;
 
+	serdev_device_set_drvdata(serdev, fc);
+	serdev_device_set_client_ops(serdev, &yt2_1380_fc_serdev_ops);
+
 	ret = devm_serdev_device_open(dev, serdev);
 	if (ret)
 		return dev_err_probe(dev, ret, "opening UART device\n");
 
 	serdev_device_set_baudrate(serdev, 600);
 	serdev_device_set_flow_control(serdev, false);
-	serdev_device_set_drvdata(serdev, fc);
-	serdev_device_set_client_ops(serdev, &yt2_1380_fc_serdev_ops);
 
 	ret = devm_extcon_register_notifier_all(dev, fc->extcon, &fc->nb);
 	if (ret)
-- 
2.34.1

Re: [PATCH v2] platform/x86: lenovo-yoga-tab2-pro-1380-fastcharger: fix race condition

[Hans de Goede]

Hi,

On 11-Jan-25 7:09 PM, Chenyuan Yang wrote:
> The yt2_1380_fc_serdev_probe() function calls devm_serdev_device_open()
> before setting the client ops via serdev_device_set_client_ops(). This
> ordering can trigger a NULL pointer dereference in the serdev controller's
> receive_buf handler, as it assumes serdev->ops is valid when
> SERPORT_ACTIVE is set.
> 
> This is similar to the issue fixed in commit 5e700b384ec1
> ("platform/chrome: cros_ec_uart: properly fix race condition") where
> devm_serdev_device_open() was called before fully initializing the
> device.
> 
> Fix the race by ensuring client ops are set before enabling the port via
> devm_serdev_device_open().
> 
> Note, serdev_device_set_baudrate() and serdev_device_set_flow_control()
> calls should be after the devm_serdev_device_open() call.
> 
> Fixes: b2ed33e8d486 ("platform/x86: Add lenovo-yoga-tab2-pro-1380-fastcharger driver")
> Signed-off-by: Chenyuan Yang <chenyuan0y@gmail.com>
> CC: Hans de Goede <hdegoede@redhat.com>

Thanks, patch looks good to me:

Reviewed-by: Hans de Goede <hdegoede@redhat.com>

Regards,

Hans



> ---
>  drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c b/drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c
> index d2699ca24f34..a96b215cd2c5 100644
> --- a/drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c
> +++ b/drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c
> @@ -199,14 +199,15 @@ static int yt2_1380_fc_serdev_probe(struct serdev_device *serdev)
>  	if (ret)
>  		return ret;
>  
> +	serdev_device_set_drvdata(serdev, fc);
> +	serdev_device_set_client_ops(serdev, &yt2_1380_fc_serdev_ops);
> +
>  	ret = devm_serdev_device_open(dev, serdev);
>  	if (ret)
>  		return dev_err_probe(dev, ret, "opening UART device\n");
>  
>  	serdev_device_set_baudrate(serdev, 600);
>  	serdev_device_set_flow_control(serdev, false);
> -	serdev_device_set_drvdata(serdev, fc);
> -	serdev_device_set_client_ops(serdev, &yt2_1380_fc_serdev_ops);
>  
>  	ret = devm_extcon_register_notifier_all(dev, fc->extcon, &fc->nb);
>  	if (ret)

Re: [PATCH v2] platform/x86: lenovo-yoga-tab2-pro-1380-fastcharger: fix race condition

[Ilpo Järvinen]

On Sat, 11 Jan 2025, Chenyuan Yang wrote:

> The yt2_1380_fc_serdev_probe() function calls devm_serdev_device_open()
> before setting the client ops via serdev_device_set_client_ops(). This
> ordering can trigger a NULL pointer dereference in the serdev controller's
> receive_buf handler, as it assumes serdev->ops is valid when
> SERPORT_ACTIVE is set.
> 
> This is similar to the issue fixed in commit 5e700b384ec1
> ("platform/chrome: cros_ec_uart: properly fix race condition") where
> devm_serdev_device_open() was called before fully initializing the
> device.
> 
> Fix the race by ensuring client ops are set before enabling the port via
> devm_serdev_device_open().
> 
> Note, serdev_device_set_baudrate() and serdev_device_set_flow_control()
> calls should be after the devm_serdev_device_open() call.
> 
> Fixes: b2ed33e8d486 ("platform/x86: Add lenovo-yoga-tab2-pro-1380-fastcharger driver")
> Signed-off-by: Chenyuan Yang <chenyuan0y@gmail.com>
> CC: Hans de Goede <hdegoede@redhat.com>

I've applied this and the other similar patch into the review-ilpo-fixes 
branch.

I altered the shortlogs to: "platform/x86: xx: fix serdev race".

-- 
 i.

> ---
>  drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c b/drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c
> index d2699ca24f34..a96b215cd2c5 100644
> --- a/drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c
> +++ b/drivers/platform/x86/lenovo-yoga-tab2-pro-1380-fastcharger.c
> @@ -199,14 +199,15 @@ static int yt2_1380_fc_serdev_probe(struct serdev_device *serdev)
>  	if (ret)
>  		return ret;
>  
> +	serdev_device_set_drvdata(serdev, fc);
> +	serdev_device_set_client_ops(serdev, &yt2_1380_fc_serdev_ops);
> +
>  	ret = devm_serdev_device_open(dev, serdev);
>  	if (ret)
>  		return dev_err_probe(dev, ret, "opening UART device\n");
>  
>  	serdev_device_set_baudrate(serdev, 600);
>  	serdev_device_set_flow_control(serdev, false);
> -	serdev_device_set_drvdata(serdev, fc);
> -	serdev_device_set_client_ops(serdev, &yt2_1380_fc_serdev_ops);
>  
>  	ret = devm_extcon_register_notifier_all(dev, fc->extcon, &fc->nb);
>  	if (ret)
>