Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 9d128ed1 authored by Rafael J. Wysocki's avatar Rafael J. Wysocki
Browse files

ACPI / OSL: Add kerneldoc comments to memory mapping functions 



Add kerneldoc comments to acpi_os_map_iomem() and acpi_os_unmap_iomem()
and explain why the latter needs the __ref annotation in one of them
(as suggested by Mathias Krause).

Signed-off-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
Acked-by: default avatarMathias Krause <minipli@googlemail.com>
parent 74bf8efb

drivers/acpi/osl.c

+27 −0
Original line number Diff line number Diff line
@@ -364,6 +364,19 @@ static void acpi_unmap(acpi_physical_address pg_off, void __iomem *vaddr) 
		iounmap(vaddr);

}



/**

 * acpi_os_map_iomem - Get a virtual address for a given physical address range.

 * @phys: Start of the physical address range to map.

 * @size: Size of the physical address range to map.

 *

 * Look up the given physical address range in the list of existing ACPI memory

 * mappings.  If found, get a reference to it and return a pointer to it (its

 * virtual address).  If not found, map it, add it to that list and return a

 * pointer to it.

 *

 * During early init (when acpi_gbl_permanent_mmap has not been set yet) this

 * routine simply calls __acpi_map_table() to get the job done.

 */

void __iomem *__init_refok

acpi_os_map_iomem(acpi_physical_address phys, acpi_size size)

{
@@ -439,6 +452,20 @@ static void acpi_os_map_cleanup(struct acpi_ioremap *map) 
	}

}



/**

 * acpi_os_unmap_iomem - Drop a memory mapping reference.

 * @virt: Start of the address range to drop a reference to.

 * @size: Size of the address range to drop a reference to.

 *

 * Look up the given virtual address range in the list of existing ACPI memory

 * mappings, drop a reference to it and unmap it if there are no more active

 * references to it.

 *

 * During early init (when acpi_gbl_permanent_mmap has not been set yet) this

 * routine simply calls __acpi_unmap_table() to get the job done.  Since

 * __acpi_unmap_table() is an __init function, the __ref annotation is needed

 * here.

 */

void __ref acpi_os_unmap_iomem(void __iomem *virt, acpi_size size)

{

	struct acpi_ioremap *map;