On Wed, 29 Aug 2018 17:36:10 +0200
David Hildenbrand <david@redhat.com> wrote:
> Document the functions and when to not expect errors.
>
> Signed-off-by: David Hildenbrand <david@redhat.com>
> ---
> include/hw/mem/memory-device.h | 13 +++++++++++++
> 1 file changed, 13 insertions(+)
>
> diff --git a/include/hw/mem/memory-device.h b/include/hw/mem/memory-device.h
> index 852fd8f98a..d353564faf 100644
> --- a/include/hw/mem/memory-device.h
> +++ b/include/hw/mem/memory-device.h
> @@ -29,9 +29,22 @@ typedef struct MemoryDeviceState {
> Object parent_obj;
> } MemoryDeviceState;
>
> +/**
> + * MemoryDeviceClass:
> + * @get_addr: The address of the @md in guest physical memory. "0" means that
> + * no address has been specified by the user and that no address has been
> + * assigned yet.
> + * @get_plugged_size: The amount of memory provided by this @md currently
> + * usable ("plugged") by the guest. Will not fail after the device was realized.
I'd drop 'Will not fail after the device was realized'
> + * @get_memory_region: The memory region of the @md to mapped in guest
s/to mapped/that's mapped/
> + * physical memory at @get_addr. Will not fail after the device was realized.
the same
> + * @fill_device_info: Fill out #MemoryDeviceInfo with @md specific information.
maybe:
translate current @md state into #MemoryDeviceInfo
> + */
> typedef struct MemoryDeviceClass {
> + /* private */
> InterfaceClass parent_class;
>
> + /* public */
> uint64_t (*get_addr)(const MemoryDeviceState *md);
> uint64_t (*get_plugged_size)(const MemoryDeviceState *md, Error **errp);
> MemoryRegion *(*get_memory_region)(MemoryDeviceState *md, Error **errp);