[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 16/22] include/hw/loader.h: Document load_image_size(
From: |
Peter Maydell |
Subject: |
[Qemu-devel] [PULL 16/22] include/hw/loader.h: Document load_image_size() |
Date: |
Fri, 14 Dec 2018 14:42:08 +0000 |
Add a documentation comment for load_image_size().
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Richard Henderson <address@hidden>
Reviewed-by: Stefan Hajnoczi <address@hidden>
Reviewed-by: Michael S. Tsirkin <address@hidden>
Reviewed-by: Eric Blake <address@hidden>
Message-id: address@hidden
---
include/hw/loader.h | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/include/hw/loader.h b/include/hw/loader.h
index 3766559bc24..0a0ad808ea3 100644
--- a/include/hw/loader.h
+++ b/include/hw/loader.h
@@ -11,6 +11,22 @@
* On error, errno is also set as appropriate.
*/
int64_t get_image_size(const char *filename);
+/**
+ * load_image_size: load an image file into specified buffer
+ * @filename: Path to the image file
+ * @addr: Buffer to load image into
+ * @size: Size of buffer in bytes
+ *
+ * Load an image file from disk into the specified buffer.
+ * If the image is larger than the specified buffer, only
+ * @size bytes are read (this is not considered an error).
+ *
+ * Prefer to use the GLib function g_file_get_contents() rather
+ * than a "get_image_size()/g_malloc()/load_image_size()" sequence.
+ *
+ * Returns the number of bytes read, or -1 on error. On error,
+ * errno is also set as appropriate.
+ */
ssize_t load_image_size(const char *filename, void *addr, size_t size);
/**load_image_targphys_as:
--
2.19.2
- [Qemu-devel] [PULL 09/22] hw/smbios/smbios.c: Don't use load_image(), (continued)
- [Qemu-devel] [PULL 09/22] hw/smbios/smbios.c: Don't use load_image(), Peter Maydell, 2018/12/14
- [Qemu-devel] [PULL 08/22] hw/ppc/ppc405_boards: Don't use load_image(), Peter Maydell, 2018/12/14
- [Qemu-devel] [PULL 11/22] hw/i386/pc.c: Don't use load_image(), Peter Maydell, 2018/12/14
- [Qemu-devel] [PULL 10/22] hw/pci/pci.c: Don't use load_image(), Peter Maydell, 2018/12/14
- [Qemu-devel] [PULL 12/22] hw/i386/multiboot.c: Don't use load_image(), Peter Maydell, 2018/12/14
- [Qemu-devel] [PULL 13/22] hw/block/tc58128.c: Don't use load_image(), Peter Maydell, 2018/12/14
- [Qemu-devel] [PULL 14/22] device_tree.c: Don't use load_image(), Peter Maydell, 2018/12/14
- [Qemu-devel] [PULL 15/22] hw/core/loader.c: Remove load_image(), Peter Maydell, 2018/12/14
- [Qemu-devel] [PULL 19/22] hw/sd/sdhci: Don't leak memory region in sdhci_sysbus_realize(), Peter Maydell, 2018/12/14
- [Qemu-devel] [PULL 17/22] target/arm: Free name string in ARMCPRegInfo hashtable entries, Peter Maydell, 2018/12/14
- [Qemu-devel] [PULL 16/22] include/hw/loader.h: Document load_image_size(),
Peter Maydell <=
- [Qemu-devel] [PULL 21/22] target/arm: Create timers in realize, not init, Peter Maydell, 2018/12/14
- [Qemu-devel] [PULL 22/22] virt: Fix broken indentation, Peter Maydell, 2018/12/14
- [Qemu-devel] [PULL 18/22] hw/arm/mps2-tz.c: Free mscname string in make_dma(), Peter Maydell, 2018/12/14
- [Qemu-devel] [PULL 20/22] tests/test-arm-mptimer: Don't leak string memory, Peter Maydell, 2018/12/14
- Re: [Qemu-devel] [PULL 00/22] misc queue, Peter Maydell, 2018/12/16
- Re: [Qemu-devel] [PULL 00/22] misc queue, Peter Maydell, 2018/12/16
- Re: [Qemu-devel] [PULL 00/22] misc queue, no-reply, 2018/12/23