hw/register: Document register_init_block @memory_size
authorPhilippe Mathieu-Daudé <f4bug@amsat.org>
Tue, 7 Jul 2020 06:23:08 +0000 (08:23 +0200)
committerLaurent Vivier <laurent@vivier.eu>
Mon, 31 Aug 2020 17:41:58 +0000 (19:41 +0200)
Document the 'memory_size' argument of register_init_block().

Fixes: a74229597e ("register: Add block initialise helper")
Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Reviewed-by: Alistair Francis <alistair.francis@wdc.com>
Reviewed-by: Laurent Vivier <laurent@vivier.eu>
Message-Id: <20200707062308.4531-1-f4bug@amsat.org>
Signed-off-by: Laurent Vivier <laurent@vivier.eu>
include/hw/register.h

index 5d2c565ae02eb3d776f97ffadd0af7efcf27f545..fdac5e69b545136c616fa894f97b2752ffeefad5 100644 (file)
@@ -181,6 +181,7 @@ uint64_t register_read_memory(void *opaque, hwaddr addr, unsigned size);
  * @data: Array to use for register data, must already be allocated
  * @ops: Memory region ops to access registers.
  * @debug enabled: turn on/off verbose debug information
+ * @memory_size: Size of the memory region
  * returns: A structure containing all of the registers and an initialized
  *          memory region (r_array->mem) the caller should add to a container.
  */