[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 007/113] dma: Document address_space_map/address_space_unmap() pro
From: |
Paolo Bonzini |
Subject: |
[PULL 007/113] dma: Document address_space_map/address_space_unmap() prototypes |
Date: |
Wed, 2 Dec 2020 03:07:03 -0500 |
From: Philippe Mathieu-Daudé <philmd@redhat.com>
Add documentation based on address_space_map / address_space_unmap.
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Reviewed-by: Edgar E. Iglesias <edgar.iglesias@xilinx.com>
Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-Id: <20201023151923.3243652-4-philmd@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
include/sysemu/dma.h | 29 ++++++++++++++++++++++++++++-
1 file changed, 28 insertions(+), 1 deletion(-)
diff --git a/include/sysemu/dma.h b/include/sysemu/dma.h
index 80c5bc3e02..c6e12b4c24 100644
--- a/include/sysemu/dma.h
+++ b/include/sysemu/dma.h
@@ -1,7 +1,7 @@
/*
* DMA helper functions
*
- * Copyright (c) 2009 Red Hat
+ * Copyright (c) 2009, 2020 Red Hat
*
* This work is licensed under the terms of the GNU General Public License
* (GNU GPL), version 2 or later.
@@ -125,6 +125,19 @@ static inline int dma_memory_write(AddressSpace *as,
dma_addr_t addr,
int dma_memory_set(AddressSpace *as, dma_addr_t addr, uint8_t c, dma_addr_t
len);
+/**
+ * address_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
+ * the mapping are exhausted.
+ * Use only for reads OR writes - not for read-modify-write operations.
+ *
+ * @as: #AddressSpace to be accessed
+ * @addr: address within that address space
+ * @len: pointer to length of buffer; updated on return
+ * @dir: indicates the transfer direction
+ */
static inline void *dma_memory_map(AddressSpace *as,
dma_addr_t addr, dma_addr_t *len,
DMADirection dir)
@@ -138,6 +151,20 @@ static inline void *dma_memory_map(AddressSpace *as,
return p;
}
+/**
+ * address_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
+ * by the caller.
+ *
+ * @as: #AddressSpace used
+ * @buffer: host pointer as returned by address_space_map()
+ * @len: buffer length as returned by address_space_map()
+ * @dir: indicates the transfer direction
+ * @access_len: amount of data actually transferred
+ */
static inline void dma_memory_unmap(AddressSpace *as,
void *buffer, dma_addr_t len,
DMADirection dir, dma_addr_t access_len)
--
2.26.2
- [PULL 000/113] First batch of misc (i386, kernel-doc, memory, vl.c) changes for QEMU 6.0, Paolo Bonzini, 2020/12/02
- [PULL 003/113] target/i386: seg_helper: Correct segement selector nullification in the RET/IRET helper, Paolo Bonzini, 2020/12/02
- [PULL 002/113] target/i386: Support up to 32768 CPUs without IRQ remapping, Paolo Bonzini, 2020/12/02
- [PULL 005/113] docs/devel/loads-stores: Add regexp for DMA functions, Paolo Bonzini, 2020/12/02
- [PULL 008/113] dma: Let dma_memory_set() propagate MemTxResult, Paolo Bonzini, 2020/12/02
- [PULL 001/113] target/i386: fix operand order for PDEP and PEXT, Paolo Bonzini, 2020/12/02
- [PULL 009/113] dma: Let dma_memory_rw() propagate MemTxResult, Paolo Bonzini, 2020/12/02
- [PULL 004/113] WHPX: support for the kernel-irqchip on/off, Paolo Bonzini, 2020/12/02
- [PULL 007/113] dma: Document address_space_map/address_space_unmap() prototypes,
Paolo Bonzini <=
- [PULL 013/113] pci: Let pci_dma_read() propagate MemTxResult, Paolo Bonzini, 2020/12/02
- [PULL 014/113] pci: Let pci_dma_write() propagate MemTxResult, Paolo Bonzini, 2020/12/02
- [PULL 006/113] qom: eliminate identical functions, Paolo Bonzini, 2020/12/02
- [PULL 012/113] pci: Let pci_dma_rw() propagate MemTxResult, Paolo Bonzini, 2020/12/02
- [PULL 010/113] dma: Let dma_memory_read() propagate MemTxResult, Paolo Bonzini, 2020/12/02
- [PULL 011/113] dma: Let dma_memory_write() propagate MemTxResult, Paolo Bonzini, 2020/12/02
- [PULL 015/113] hw/ssi/aspeed_smc: Rename 'max_slaves' variable as 'max_peripherals', Paolo Bonzini, 2020/12/02
- [PULL 019/113] hw/dma/xilinx_axidma: Rename StreamSlave as StreamSink, Paolo Bonzini, 2020/12/02
- [PULL 022/113] arm: remove bios_name, Paolo Bonzini, 2020/12/02
- [PULL 021/113] alpha: remove bios_name, Paolo Bonzini, 2020/12/02