PCI: mvebu: return NULL instead of ERR_PTR(ret)

[Jingoo Han]

On Wednesday, November 27, 2013 3:10 AM, Jason Gunthorpe wrote:
> On Tue, Nov 26, 2013 at 02:31:44PM +0900, Jingoo Han wrote:
> > Previously, I sent the patch in order to fix sparse warning as below:
> > How about this?
> >
> > static void __iomem *mvebu_pcie_map_registers(struct platform_device *pdev,
> > 			struct device_node *np, struct mvebu_pcie_port *port)
> > {
> > 	struct resource regs;
> > 	int ret = 0;
> >
> > 	ret = of_address_to_resource(np, 0, &regs);
> > 	if (ret)
> > -		return ERR_PTR(ret);
> > +		return (void __iomem *)ERR_PTR(ret);
> 
> You should probably ask the sparse folks for guidance 'git grep
> iomem.*ERR_PTR' returns nothing, so this isn't an established pattern.
> 
> It seems like sparse should know that ERR_PTR functions can work with
> any pointer no matter the type? IS_ERR_PTR will have the same problem
> with implicitly dropping the iomem tag.

+cc Christopher Li, sparse mailing-list, Joe Perches, Dan Carpenter,
     Axel Lin, Julia Lawall,

Hi All,

I have some questions about handling sparse warning.

Currently, the following sparse warning happens
at Marvell Armada PCIe driver.

drivers/pci/host/pci-mvebu.c:743:31: warning: incorrect type in return expression (different address spaces)
drivers/pci/host/pci-mvebu.c:743:31:    expected void [noderef] <asn:2>*
drivers/pci/host/pci-mvebu.c:743:31:    got void *

mvebu_pcie_map_registers() returns ERR_PTR(ret),
however ERR_PTR() returns (void *), not (void __iomem *).

./drivers/pci/host/pci-mvebu.c
static void __iomem *mvebu_pcie_map_registers(struct platform_device *pdev,
		struct device_node *np, struct mvebu_pcie_port *port)
{
	struct resource regs;
	int ret = 0;

	ret = of_address_to_resource(np, 0, &regs);
	if (ret)
		return ERR_PTR(ret);

	return devm_ioremap_resource(&pdev->dev, &regs);
}
./include/linux/err.h
static inline void * __must_check ERR_PTR(long error)
{
	return (void *) error;
}


Previously, I submitted the following patch, that adds
(void __iomem *) cast.

./drivers/pci/host/pci-mvebu.c
static void __iomem *mvebu_pcie_map_registers(struct platform_device *pdev,
		struct device_node *np, struct mvebu_pcie_port *port)
{
	.....

	ret = of_address_to_resource(np, 0, &regs);
	if (ret)
-		return ERR_PTR(ret);
+		return (void __iomem *)ERR_PTR(ret);

However, other engineers said that "(void __iomem *)ERR_PTR(ret)"
is not a general pattern. I cannot find the proper method to resolve
this sparse warning.

In this case, how can I resolve this sparse warning?

Then, how about the following?

--- a/drivers/pci/host/pci-mvebu.c
+++ b/drivers/pci/host/pci-mvebu.c
@@ -740,7 +740,7 @@ static void __iomem *mvebu_pcie_map_registers(struct platform_device *pdev,

	ret = of_address_to_resource(np, 0, &regs);
	if (ret)
-		return ERR_PTR(ret);
+		return NULL;

	return devm_ioremap_resource(&pdev->dev, &regs);
 }
@@ -939,7 +939,7 @@ static int mvebu_pcie_probe(struct platform_device *pdev)
		continue;

		port->base = mvebu_pcie_map_registers(pdev, child, port);
-		if (IS_ERR(port->base)) {
+		if (IS_ERR_OR_NULL(port->base)) {
			dev_err(&pdev->dev, "PCIe%d.%d: cannot map registers\n",
				port->port, port->lane);
			port->base = NULL;

Thank you for reading this. :-)

Best regards,
Jingoo Han