hw/nvram/fw_cfg: Document fw_cfg_init_mem_nodma()
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 <peter.maydell@linaro.org> Reviewed-by: Richard Henderson <richard.henderson@linaro.org> Reviewed-by: Philippe Mathieu-Daudé <philmd@oss.qualcomm.com> Reviewed-by: Philippe Mathieu-Daudé <philmd@mailo.com> Message-id: 20260529174639.451353-6-peter.maydell@linaro.org Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
Peter Maydell committed
May 29, 2026 at 18:46 UTC
a9918b183c788fc3bc5ca731c696dbfdb7daf25f
1 file changed
+18
include/hw/nvram/fw_cfg.h
+18
@@ -320,6 +320,24 @@ bool fw_cfg_add_file_from_generator(FWCfgState *s,
320
* Returns the device object.
321
*/
322
FWCfgState *fw_cfg_init_io_dma(uint32_t iobase, AddressSpace *dma_as);
323
+
324
+/**
325
+ * fw_cfg_init_mem_nodma:
326
+ *
327
+ * @ctl_addr: address of the selector register
328
+ * @data_addr: address of the data address
329
+ * @data_width: width of the data register in bytes
330
+ *
331
+ * Create a fw_cfg device without DMA support, and map its
332
+ * registers at the specified addresses.
333
+ *
334
+ * Do not use this function in code for a board type that didn't
335
+ * already support the fw_cfg device. All new board types should
336
+ * include DMA support and use the standard register layout -- use
337
+ * fw_cfg_init_mem_dma() instead.
338
+ *
339
+ * Returns the device object.
340
+ */
341
FWCfgState *fw_cfg_init_mem_nodma(hwaddr ctl_addr, hwaddr data_addr,
342
unsigned data_width);
343
/**