devres: fix devm_ioremap_*() offset parameter kerneldoc description

The offset parameter in the devres devm_ioremap_*() functions kerneldoc
entries is erroneously defined as BUS offset whereas it is actually a
resource address.

Since it is actually misleading, fix the devres devm_ioremap_* offset
parameter kerneldoc entry by replacing BUS offset with a more suitable
description (ie Resource address).

Signed-off-by: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Cc: Tejun Heo <tj@kernel.org>
This commit is contained in:
Lorenzo Pieralisi 2017-04-19 17:48:54 +01:00 committed by Bjorn Helgaas
parent b9cdbe6e39
commit 6524754eff
1 changed files with 3 additions and 3 deletions

View File

@ -17,7 +17,7 @@ static int devm_ioremap_match(struct device *dev, void *res, void *match_data)
/** /**
* devm_ioremap - Managed ioremap() * devm_ioremap - Managed ioremap()
* @dev: Generic device to remap IO address for * @dev: Generic device to remap IO address for
* @offset: BUS offset to map * @offset: Resource address to map
* @size: Size of map * @size: Size of map
* *
* Managed ioremap(). Map is automatically unmapped on driver detach. * Managed ioremap(). Map is automatically unmapped on driver detach.
@ -45,7 +45,7 @@ EXPORT_SYMBOL(devm_ioremap);
/** /**
* devm_ioremap_nocache - Managed ioremap_nocache() * devm_ioremap_nocache - Managed ioremap_nocache()
* @dev: Generic device to remap IO address for * @dev: Generic device to remap IO address for
* @offset: BUS offset to map * @offset: Resource address to map
* @size: Size of map * @size: Size of map
* *
* Managed ioremap_nocache(). Map is automatically unmapped on driver * Managed ioremap_nocache(). Map is automatically unmapped on driver
@ -74,7 +74,7 @@ EXPORT_SYMBOL(devm_ioremap_nocache);
/** /**
* devm_ioremap_wc - Managed ioremap_wc() * devm_ioremap_wc - Managed ioremap_wc()
* @dev: Generic device to remap IO address for * @dev: Generic device to remap IO address for
* @offset: BUS offset to map * @offset: Resource address to map
* @size: Size of map * @size: Size of map
* *
* Managed ioremap_wc(). Map is automatically unmapped on driver detach. * Managed ioremap_wc(). Map is automatically unmapped on driver detach.