drm/aperture: Fix some kerneldoc comments

Reword some kerneldoc comments for the DRM aperture handling code.

Signed-off-by: Thierry Reding <treding@nvidia.com>
Signed-off-by: Thomas Zimmermann <tzimmermann@suse.de>
Acked-by: Thomas Zimmermann <tzimmermann@suse.de>
Link: https://patchwork.freedesktop.org/patch/msgid/20220905162241.391226-1-thierry.reding@gmail.com
This commit is contained in:
Thierry Reding
2022-09-05 18:22:41 +02:00
committed by Thomas Zimmermann
parent 4a85b0b51e
commit f2912237eb

View File

@@ -74,7 +74,7 @@
* given framebuffer memory. Ownership of the framebuffer memory is achieved * given framebuffer memory. Ownership of the framebuffer memory is achieved
* by calling devm_aperture_acquire_from_firmware(). On success, the driver * by calling devm_aperture_acquire_from_firmware(). On success, the driver
* is the owner of the framebuffer range. The function fails if the * is the owner of the framebuffer range. The function fails if the
* framebuffer is already by another driver. See below for an example. * framebuffer is already owned by another driver. See below for an example.
* *
* .. code-block:: c * .. code-block:: c
* *
@@ -112,7 +112,7 @@
* *
* The generic driver is now subject to forced removal by other drivers. This * The generic driver is now subject to forced removal by other drivers. This
* only works for platform drivers that support hot unplug. * only works for platform drivers that support hot unplug.
* When a driver calls drm_aperture_remove_conflicting_framebuffers() et al * When a driver calls drm_aperture_remove_conflicting_framebuffers() et al.
* for the registered framebuffer range, the aperture helpers call * for the registered framebuffer range, the aperture helpers call
* platform_device_unregister() and the generic driver unloads itself. It * platform_device_unregister() and the generic driver unloads itself. It
* may not access the device's registers, framebuffer memory, ROM, etc * may not access the device's registers, framebuffer memory, ROM, etc
@@ -164,7 +164,7 @@ EXPORT_SYMBOL(devm_aperture_acquire_from_firmware);
* @primary: also kick vga16fb if present * @primary: also kick vga16fb if present
* @req_driver: requesting DRM driver * @req_driver: requesting DRM driver
* *
* This function removes graphics device drivers which use memory range described by * This function removes graphics device drivers which use the memory range described by
* @base and @size. * @base and @size.
* *
* Returns: * Returns:
@@ -182,8 +182,8 @@ EXPORT_SYMBOL(drm_aperture_remove_conflicting_framebuffers);
* @pdev: PCI device * @pdev: PCI device
* @req_driver: requesting DRM driver * @req_driver: requesting DRM driver
* *
* This function removes graphics device drivers using memory range configured * This function removes graphics device drivers using the memory range configured
* for any of @pdev's memory bars. The function assumes that PCI device with * for any of @pdev's memory bars. The function assumes that a PCI device with
* shadowed ROM drives a primary display and so kicks out vga16fb. * shadowed ROM drives a primary display and so kicks out vga16fb.
* *
* Returns: * Returns: