Commit 7ae731a8 authored by Dan Carpenter's avatar Dan Carpenter Committed by Greg Kroah-Hartman

lib: devres: add a comment about the devm_of_iomap() function

We recently introduced a bug when we tried to convert of_iomap() to
devm_of_iomap().  The problem was that there were two drivers mapping
the same io region.  The first driver was using of_iomap() and the
second driver was using devm_of_iomap() and the kernel booted fine.
When we converted the first drive to use devm_of_iomap() then the second
driver failed with -EBUSY and the kernel couldn't boot.

Let's add a comment to prevent this sort of mistake in the future.
Signed-off-by: default avatarDan Carpenter <dan.carpenter@oracle.com>
Acked-by: default avatarArnd Bergmann <arnd@arndb.de>
Link: https://lore.kernel.org/r/20200609104642.GA43074@mwandaSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 35bd8c07
...@@ -213,6 +213,12 @@ void __iomem *devm_ioremap_resource_wc(struct device *dev, ...@@ -213,6 +213,12 @@ void __iomem *devm_ioremap_resource_wc(struct device *dev,
* base = devm_of_iomap(&pdev->dev, node, 0, NULL); * base = devm_of_iomap(&pdev->dev, node, 0, NULL);
* if (IS_ERR(base)) * if (IS_ERR(base))
* return PTR_ERR(base); * return PTR_ERR(base);
*
* Please Note: This is not a one-to-one replacement for of_iomap() because the
* of_iomap() function does not track whether the region is already mapped. If
* two drivers try to map the same memory, the of_iomap() function will succeed
* but the the devm_of_iomap() function will return -EBUSY.
*
*/ */
void __iomem *devm_of_iomap(struct device *dev, struct device_node *node, int index, void __iomem *devm_of_iomap(struct device *dev, struct device_node *node, int index,
resource_size_t *size) resource_size_t *size)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment