The last few commits have added doc comments for all the fw_cfg_init* functions except for fw_cfg_init_mem_nodma(). Fill in the gap by adding a doc comment for it.
Signed-off-by: Peter Maydell <[email protected]> --- include/hw/nvram/fw_cfg.h | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/include/hw/nvram/fw_cfg.h b/include/hw/nvram/fw_cfg.h index be3fb5f8aa..b75858025f 100644 --- a/include/hw/nvram/fw_cfg.h +++ b/include/hw/nvram/fw_cfg.h @@ -320,6 +320,24 @@ bool fw_cfg_add_file_from_generator(FWCfgState *s, * Returns the device object. */ FWCfgState *fw_cfg_init_io_dma(uint32_t iobase, AddressSpace *dma_as); + +/** + * fw_cfg_init_mem_nodma: + * + * @ctl_addr: address of the selector register + * @data_addr: address of the data address + * @data_width: width of the data register in bytes + * + * Create a fw_cfg device without DMA support, and map its + * registers at the specified addresses. + * + * Do not use this function in code for a board type that didn't + * already support the fw_cfg device. All new board types should + * include DMA support and use the standard register layout -- use + * fw_cfg_init_mem_dma() instead. + * + * Returns the device object. + */ FWCfgState *fw_cfg_init_mem_nodma(hwaddr ctl_addr, hwaddr data_addr, unsigned data_width); /** -- 2.43.0
