diff options
Diffstat (limited to 'include/hw/loader.h')
| -rw-r--r-- | include/hw/loader.h | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/include/hw/loader.h b/include/hw/loader.h index 67a0af84ac..0a0ad808ea 100644 --- a/include/hw/loader.h +++ b/include/hw/loader.h @@ -11,7 +11,22 @@ * On error, errno is also set as appropriate. */ int64_t get_image_size(const char *filename); -int load_image(const char *filename, uint8_t *addr); /* deprecated */ +/** + * 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: |