[PATCH] dma: Fix dma_memory_map/dma_memory_unmap documentation

[PATCH] dma: Fix dma_memory_map/dma_memory_unmap documentation

[Akihiko Odaki]

Ensure the function names match.

Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
---
 include/sysemu/dma.h | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/include/sysemu/dma.h b/include/sysemu/dma.h
index a1ac5bc1b543..e132ece4510d 100644
--- a/include/sysemu/dma.h
+++ b/include/sysemu/dma.h
@@ -189,7 +189,7 @@ MemTxResult dma_memory_set(AddressSpace *as, dma_addr_t addr,
                            uint8_t c, dma_addr_t len, MemTxAttrs attrs);
 
 /**
- * address_space_map: Map a physical memory region into a host virtual address.
+ * dma_space_map: Map a physical memory region into a host virtual address.
  *
  * May map a subset of the requested range, given by and returned in @plen.
  * May return %NULL and set *@plen to zero(0), if resources needed to perform
@@ -216,8 +216,7 @@ static inline void *dma_memory_map(AddressSpace *as,
 }
 
 /**
- * address_space_unmap: Unmaps a memory region previously mapped
- *                      by dma_memory_map()
+ * dma_space_unmap: Unmaps a memory region previously mapped by dma_memory_map()
  *
  * Will also mark the memory as dirty if @dir == %DMA_DIRECTION_FROM_DEVICE.
  * @access_len gives the amount of memory that was actually read or written

---
base-commit: 31669121a01a14732f57c49400bc239cf9fd505f
change-id: 20241008-dma-0221f9ce8898

Best regards,
-- 
Akihiko Odaki <akihiko.odaki@daynix.com>

Re: [PATCH] dma: Fix dma_memory_map/dma_memory_unmap documentation

[Peter Maydell]

On Tue, 8 Oct 2024 at 07:54, Akihiko Odaki <akihiko.odaki@daynix.com> wrote:
>
> Ensure the function names match.
>
> Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
> ---
>  include/sysemu/dma.h | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/include/sysemu/dma.h b/include/sysemu/dma.h
> index a1ac5bc1b543..e132ece4510d 100644
> --- a/include/sysemu/dma.h
> +++ b/include/sysemu/dma.h
> @@ -189,7 +189,7 @@ MemTxResult dma_memory_set(AddressSpace *as, dma_addr_t addr,
>                             uint8_t c, dma_addr_t len, MemTxAttrs attrs);
>
>  /**
> - * address_space_map: Map a physical memory region into a host virtual address.
> + * dma_space_map: Map a physical memory region into a host virtual address.

The function is dma_memory_map ...

>   *
>   * May map a subset of the requested range, given by and returned in @plen.
>   * May return %NULL and set *@plen to zero(0), if resources needed to perform
> @@ -216,8 +216,7 @@ static inline void *dma_memory_map(AddressSpace *as,
>  }
>
>  /**
> - * address_space_unmap: Unmaps a memory region previously mapped
> - *                      by dma_memory_map()
> + * dma_space_unmap: Unmaps a memory region previously mapped by dma_memory_map()

...and this one is dma_memory_unmap.

>   *
>   * Will also mark the memory as dirty if @dir == %DMA_DIRECTION_FROM_DEVICE.
>   * @access_len gives the amount of memory that was actually read or written

thanks
-- PMM