[PATCH v2] USB: ohci-nxp: Fix error handling in ohci-hcd-nxp driver

[PATCH v2] USB: ohci-nxp: Fix error handling in ohci-hcd-nxp driver

[Ma Ke]

When obtaining the ISP1301 I2C client through the device tree, the
driver does not release the device reference in the probe failure path
or in the remove function. This could cause a reference count leak,
which may prevent the device from being properly unbound or freed,
leading to resource leakage.

Fix this by storing whether the client was obtained via device tree
and only releasing the reference in that case.

Found by code review.

Cc: stable@vger.kernel.org
Fixes: 73108aa90cbf ("USB: ohci-nxp: Use isp1301 driver")
Signed-off-by: Ma Ke <make24@iscas.ac.cn>
---
Changes in v2:
- only released the device reference when the ISP1301 client was obtained through device tree, not in the non-DT case where the global variable is used;
- removed unnecessary NULL checks as suggested by reviewer.
---
 drivers/usb/host/ohci-nxp.c | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/drivers/usb/host/ohci-nxp.c b/drivers/usb/host/ohci-nxp.c
index 24d5a1dc5056..081b8c7f21a0 100644
--- a/drivers/usb/host/ohci-nxp.c
+++ b/drivers/usb/host/ohci-nxp.c
@@ -50,6 +50,7 @@ static const char hcd_name[] = "ohci-nxp";
 static struct hc_driver __read_mostly ohci_nxp_hc_driver;
 
 static struct i2c_client *isp1301_i2c_client;
+static bool isp1301_using_dt;
 
 static void isp1301_configure_lpc32xx(void)
 {
@@ -161,6 +162,7 @@ static int ohci_hcd_nxp_probe(struct platform_device *pdev)
 	} else {
 		isp1301_node = NULL;
 	}
+	isp1301_using_dt = (isp1301_node != NULL);
 
 	isp1301_i2c_client = isp1301_get_client(isp1301_node);
 	of_node_put(isp1301_node);
@@ -223,6 +225,8 @@ static int ohci_hcd_nxp_probe(struct platform_device *pdev)
 fail_resource:
 	usb_put_hcd(hcd);
 fail_disable:
+	if (isp1301_using_dt)
+		put_device(&isp1301_i2c_client->dev);
 	isp1301_i2c_client = NULL;
 	return ret;
 }
@@ -234,6 +238,8 @@ static void ohci_hcd_nxp_remove(struct platform_device *pdev)
 	usb_remove_hcd(hcd);
 	ohci_nxp_stop_hc();
 	usb_put_hcd(hcd);
+	if (isp1301_using_dt)
+		put_device(&isp1301_i2c_client->dev);
 	isp1301_i2c_client = NULL;
 }
 
-- 
2.17.1

Re: [PATCH v2] USB: ohci-nxp: Fix error handling in ohci-hcd-nxp driver

[Alan Stern]

On Mon, Nov 17, 2025 at 09:34:28AM +0800, Ma Ke wrote:
> When obtaining the ISP1301 I2C client through the device tree, the
> driver does not release the device reference in the probe failure path
> or in the remove function. This could cause a reference count leak,
> which may prevent the device from being properly unbound or freed,
> leading to resource leakage.
> 
> Fix this by storing whether the client was obtained via device tree
> and only releasing the reference in that case.
> 
> Found by code review.
> 
> Cc: stable@vger.kernel.org
> Fixes: 73108aa90cbf ("USB: ohci-nxp: Use isp1301 driver")
> Signed-off-by: Ma Ke <make24@iscas.ac.cn>
> ---
> Changes in v2:
> - only released the device reference when the ISP1301 client was obtained through device tree, not in the non-DT case where the global variable is used;
> - removed unnecessary NULL checks as suggested by reviewer.
> ---

Acked-by: Alan Stern <stern@rowland.harvard.edu>


>  drivers/usb/host/ohci-nxp.c | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/drivers/usb/host/ohci-nxp.c b/drivers/usb/host/ohci-nxp.c
> index 24d5a1dc5056..081b8c7f21a0 100644
> --- a/drivers/usb/host/ohci-nxp.c
> +++ b/drivers/usb/host/ohci-nxp.c
> @@ -50,6 +50,7 @@ static const char hcd_name[] = "ohci-nxp";
>  static struct hc_driver __read_mostly ohci_nxp_hc_driver;
>  
>  static struct i2c_client *isp1301_i2c_client;
> +static bool isp1301_using_dt;
>  
>  static void isp1301_configure_lpc32xx(void)
>  {
> @@ -161,6 +162,7 @@ static int ohci_hcd_nxp_probe(struct platform_device *pdev)
>  	} else {
>  		isp1301_node = NULL;
>  	}
> +	isp1301_using_dt = (isp1301_node != NULL);
>  
>  	isp1301_i2c_client = isp1301_get_client(isp1301_node);
>  	of_node_put(isp1301_node);
> @@ -223,6 +225,8 @@ static int ohci_hcd_nxp_probe(struct platform_device *pdev)
>  fail_resource:
>  	usb_put_hcd(hcd);
>  fail_disable:
> +	if (isp1301_using_dt)
> +		put_device(&isp1301_i2c_client->dev);
>  	isp1301_i2c_client = NULL;
>  	return ret;
>  }
> @@ -234,6 +238,8 @@ static void ohci_hcd_nxp_remove(struct platform_device *pdev)
>  	usb_remove_hcd(hcd);
>  	ohci_nxp_stop_hc();
>  	usb_put_hcd(hcd);
> +	if (isp1301_using_dt)
> +		put_device(&isp1301_i2c_client->dev);
>  	isp1301_i2c_client = NULL;
>  }
>  
> -- 
> 2.17.1
> 

Re: [PATCH v2] USB: ohci-nxp: Fix error handling in ohci-hcd-nxp driver

[Arnd Bergmann]

On Mon, Nov 17, 2025, at 02:34, Ma Ke wrote:
> When obtaining the ISP1301 I2C client through the device tree, the
> driver does not release the device reference in the probe failure path
> or in the remove function. This could cause a reference count leak,
> which may prevent the device from being properly unbound or freed,
> leading to resource leakage.
>
> Fix this by storing whether the client was obtained via device tree
> and only releasing the reference in that case.
>
> Found by code review.
>
> Cc: stable@vger.kernel.org
> Fixes: 73108aa90cbf ("USB: ohci-nxp: Use isp1301 driver")
> Signed-off-by: Ma Ke <make24@iscas.ac.cn>

The patch looks fine in principle, however I don't see any way
this driver would be probed without devicetree, and I think
it would be better to remove all the traces of the pre-DT
logic in it.

The lpc32xx platform was converted to DT back in 2012, so
any reference to the old variant is dead code. Something like
the patch below should work here.

Other thoughts on this driver, though I I'm not sure anyone
is going to have the energy to implement these:

 - the reference to isp1301_i2c_client should be kept in
   the hcd private data, after allocating a structure, by
   setting driver->hcd_priv_size.
 - instead of looking for the i2c device, I would suppose
   it should look for a usb_phy instead, as there is no
   guarantee on the initialization being ordered at the
   moment.
 - instead of a usb_phy, the driver should probably use
   a generic phy (a much larger rework).

     Arnd

diff --git a/drivers/usb/host/ohci-nxp.c b/drivers/usb/host/ohci-nxp.c
index 24d5a1dc5056..4c072ce02f4d 100644
--- a/drivers/usb/host/ohci-nxp.c
+++ b/drivers/usb/host/ohci-nxp.c
@@ -155,22 +155,12 @@ static int ohci_hcd_nxp_probe(struct platform_device *pdev)
 	struct device_node *isp1301_node;
 	struct clk *usb_host_clk;
 
-	if (pdev->dev.of_node) {
-		isp1301_node = of_parse_phandle(pdev->dev.of_node,
-						"transceiver", 0);
-	} else {
-		isp1301_node = NULL;
-	}
-
-	isp1301_i2c_client = isp1301_get_client(isp1301_node);
+	isp1301_node = of_parse_phandle(pdev->dev.of_node, "transceiver", 0);
+	isp1301_i2c_client = of_find_i2c_device_by_node(isp1301_node);
 	of_node_put(isp1301_node);
 	if (!isp1301_i2c_client)
 		return -EPROBE_DEFER;
 
-	ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
-	if (ret)
-		goto fail_disable;
-
 	dev_dbg(&pdev->dev, "%s: " DRIVER_DESC " (nxp)\n", hcd_name);
 	if (usb_disabled()) {
 		dev_err(&pdev->dev, "USB is disabled\n");
@@ -223,7 +213,7 @@ static int ohci_hcd_nxp_probe(struct platform_device *pdev)
 fail_resource:
 	usb_put_hcd(hcd);
 fail_disable:
-	isp1301_i2c_client = NULL;
+	put_device(isp1301_i2c_client);
 	return ret;
 }
 
@@ -234,24 +224,19 @@ static void ohci_hcd_nxp_remove(struct platform_device *pdev)
 	usb_remove_hcd(hcd);
 	ohci_nxp_stop_hc();
 	usb_put_hcd(hcd);
-	isp1301_i2c_client = NULL;
+	put_device(isp1301_i2c_client);
 }
 
-/* work with hotplug and coldplug */
-MODULE_ALIAS("platform:usb-ohci");
-
-#ifdef CONFIG_OF
 static const struct of_device_id ohci_hcd_nxp_match[] = {
 	{ .compatible = "nxp,ohci-nxp" },
 	{},
 };
 MODULE_DEVICE_TABLE(of, ohci_hcd_nxp_match);
-#endif
 
 static struct platform_driver ohci_hcd_nxp_driver = {
 	.driver = {
-		.name = "usb-ohci",
-		.of_match_table = of_match_ptr(ohci_hcd_nxp_match),
+		.name = "usb-ohci-lpc32xx",
+		.of_match_table = ohci_hcd_nxp_match,
 	},
 	.probe = ohci_hcd_nxp_probe,
 	.remove = ohci_hcd_nxp_remove,
diff --git a/drivers/usb/phy/phy-isp1301.c b/drivers/usb/phy/phy-isp1301.c
index f9b5c411aee4..3a8fa333a4f7 100644
--- a/drivers/usb/phy/phy-isp1301.c
+++ b/drivers/usb/phy/phy-isp1301.c
@@ -24,20 +24,12 @@ struct isp1301 {
 
 #define phy_to_isp(p)		(container_of((p), struct isp1301, phy))
 
-static const struct i2c_device_id isp1301_id[] = {
-	{ "isp1301" },
-	{ }
-};
-MODULE_DEVICE_TABLE(i2c, isp1301_id);
-
 static const struct of_device_id isp1301_of_match[] = {
 	{.compatible = "nxp,isp1301" },
 	{ },
 };
 MODULE_DEVICE_TABLE(of, isp1301_of_match);
 
-static struct i2c_client *isp1301_i2c_client;
-
 static int __isp1301_write(struct isp1301 *isp, u8 reg, u8 value, u8 clear)
 {
 	return i2c_smbus_write_byte_data(isp->client, reg | clear, value);
@@ -114,8 +106,6 @@ static int isp1301_probe(struct i2c_client *client)
 	i2c_set_clientdata(client, isp);
 	usb_add_phy_dev(phy);
 
-	isp1301_i2c_client = client;
-
 	return 0;
 }
 
@@ -124,7 +114,6 @@ static void isp1301_remove(struct i2c_client *client)
 	struct isp1301 *isp = i2c_get_clientdata(client);
 
 	usb_remove_phy(&isp->phy);
-	isp1301_i2c_client = NULL;
 }
 
 static struct i2c_driver isp1301_driver = {
@@ -134,25 +123,10 @@ static struct i2c_driver isp1301_driver = {
 	},
 	.probe = isp1301_probe,
 	.remove = isp1301_remove,
-	.id_table = isp1301_id,
 };
 
 module_i2c_driver(isp1301_driver);
 
-struct i2c_client *isp1301_get_client(struct device_node *node)
-{
-	struct i2c_client *client;
-
-	/* reference of ISP1301 I2C node via DT */
-	client = of_find_i2c_device_by_node(node);
-	if (client)
-		return client;
-
-	/* non-DT: only one ISP1301 chip supported */
-	return isp1301_i2c_client;
-}
-EXPORT_SYMBOL_GPL(isp1301_get_client);
-
 MODULE_AUTHOR("Roland Stigge <stigge@antcom.de>");
 MODULE_DESCRIPTION("NXP ISP1301 USB transceiver driver");
 MODULE_LICENSE("GPL");
diff --git a/include/linux/usb/isp1301.h b/include/linux/usb/isp1301.h
index fa986b926a12..135dd785d984 100644
--- a/include/linux/usb/isp1301.h
+++ b/include/linux/usb/isp1301.h
@@ -66,6 +66,4 @@
 
 #define ISP1301_I2C_REG_CLEAR_ADDR	1	/* Register Address Modifier */
 
-struct i2c_client *isp1301_get_client(struct device_node *node);
-
 #endif /* __LINUX_USB_ISP1301_H */

Re: [PATCH v2] USB: ohci-nxp: Fix error handling in ohci-hcd-nxp driver

[Alan Stern]

On Mon, Nov 17, 2025 at 09:53:21AM +0100, Arnd Bergmann wrote:
> On Mon, Nov 17, 2025, at 02:34, Ma Ke wrote:
> > When obtaining the ISP1301 I2C client through the device tree, the
> > driver does not release the device reference in the probe failure path
> > or in the remove function. This could cause a reference count leak,
> > which may prevent the device from being properly unbound or freed,
> > leading to resource leakage.
> >
> > Fix this by storing whether the client was obtained via device tree
> > and only releasing the reference in that case.
> >
> > Found by code review.
> >
> > Cc: stable@vger.kernel.org
> > Fixes: 73108aa90cbf ("USB: ohci-nxp: Use isp1301 driver")
> > Signed-off-by: Ma Ke <make24@iscas.ac.cn>
> 
> The patch looks fine in principle, however I don't see any way
> this driver would be probed without devicetree, and I think
> it would be better to remove all the traces of the pre-DT
> logic in it.
> 
> The lpc32xx platform was converted to DT back in 2012, so
> any reference to the old variant is dead code. Something like
> the patch below should work here.
> 
> Other thoughts on this driver, though I I'm not sure anyone
> is going to have the energy to implement these:
> 
>  - the reference to isp1301_i2c_client should be kept in
>    the hcd private data, after allocating a structure, by
>    setting driver->hcd_priv_size.
>  - instead of looking for the i2c device, I would suppose
>    it should look for a usb_phy instead, as there is no
>    guarantee on the initialization being ordered at the
>    moment.
>  - instead of a usb_phy, the driver should probably use
>    a generic phy (a much larger rework).

Considering what the comments at the start of the file say:

 * Currently supported OHCI host devices:
 * - NXP LPC32xx

 * NOTE: This driver does not have suspend/resume functionality
 * This driver is intended for engineering development purposes only

I wonder whether any existing systems actually use this driver.

Alan Stern

Re: [PATCH v2] USB: ohci-nxp: Fix error handling in ohci-hcd-nxp driver

[Vladimir Zapolskiy]

On 11/17/25 16:56, Alan Stern wrote:
> On Mon, Nov 17, 2025 at 09:53:21AM +0100, Arnd Bergmann wrote:
>> On Mon, Nov 17, 2025, at 02:34, Ma Ke wrote:
>>> When obtaining the ISP1301 I2C client through the device tree, the
>>> driver does not release the device reference in the probe failure path
>>> or in the remove function. This could cause a reference count leak,
>>> which may prevent the device from being properly unbound or freed,
>>> leading to resource leakage.
>>>
>>> Fix this by storing whether the client was obtained via device tree
>>> and only releasing the reference in that case.
>>>
>>> Found by code review.
>>>
>>> Cc: stable@vger.kernel.org
>>> Fixes: 73108aa90cbf ("USB: ohci-nxp: Use isp1301 driver")
>>> Signed-off-by: Ma Ke <make24@iscas.ac.cn>
>>
>> The patch looks fine in principle, however I don't see any way
>> this driver would be probed without devicetree, and I think
>> it would be better to remove all the traces of the pre-DT
>> logic in it.
>>
>> The lpc32xx platform was converted to DT back in 2012, so
>> any reference to the old variant is dead code. Something like
>> the patch below should work here.
>>
>> Other thoughts on this driver, though I I'm not sure anyone
>> is going to have the energy to implement these:
>>
>>   - the reference to isp1301_i2c_client should be kept in
>>     the hcd private data, after allocating a structure, by
>>     setting driver->hcd_priv_size.
>>   - instead of looking for the i2c device, I would suppose
>>     it should look for a usb_phy instead, as there is no
>>     guarantee on the initialization being ordered at the
>>     moment.
>>   - instead of a usb_phy, the driver should probably use
>>     a generic phy (a much larger rework).

Since I'm one of the remaining users and holders of the LPC32xx powered
boards, I should take this task.

> 
> Considering what the comments at the start of the file say:
> 
>   * Currently supported OHCI host devices:
>   * - NXP LPC32xx
> 
>   * NOTE: This driver does not have suspend/resume functionality
>   * This driver is intended for engineering development purposes only
> 
> I wonder whether any existing systems actually use this driver.
> 

The LPC32xx OHCI host device works fine with the driver, noteworthy
there were some issues with the LPC32xx UDC though.

Any pre-dt leftovers should be removed from the driver, as Arnd suggested.

-- 
Best wishes,
Vladimir

Re: [PATCH v2] USB: ohci-nxp: Fix error handling in ohci-hcd-nxp driver

[Greg KH]

On Mon, Nov 17, 2025 at 09:34:28AM +0800, Ma Ke wrote:
> When obtaining the ISP1301 I2C client through the device tree, the
> driver does not release the device reference in the probe failure path
> or in the remove function. This could cause a reference count leak,
> which may prevent the device from being properly unbound or freed,
> leading to resource leakage.
> 
> Fix this by storing whether the client was obtained via device tree
> and only releasing the reference in that case.
> 
> Found by code review.
> 
> Cc: stable@vger.kernel.org
> Fixes: 73108aa90cbf ("USB: ohci-nxp: Use isp1301 driver")
> Signed-off-by: Ma Ke <make24@iscas.ac.cn>
> ---
> Changes in v2:
> - only released the device reference when the ISP1301 client was obtained through device tree, not in the non-DT case where the global variable is used;
> - removed unnecessary NULL checks as suggested by reviewer.
> ---
>  drivers/usb/host/ohci-nxp.c | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/drivers/usb/host/ohci-nxp.c b/drivers/usb/host/ohci-nxp.c
> index 24d5a1dc5056..081b8c7f21a0 100644
> --- a/drivers/usb/host/ohci-nxp.c
> +++ b/drivers/usb/host/ohci-nxp.c
> @@ -50,6 +50,7 @@ static const char hcd_name[] = "ohci-nxp";
>  static struct hc_driver __read_mostly ohci_nxp_hc_driver;
>  
>  static struct i2c_client *isp1301_i2c_client;
> +static bool isp1301_using_dt;

This will not work for multiple devices in the system :(

Please add this to the device-specific structure instead.

thanks,

greg k-h