From: Peter Maydell <peter.maydell@linaro.org>
Date: Fri, 2 Jul 2021 10:40:12 +0000 (+0100)
Subject: hw/gpio/pl061: Document the interface of this device
X-Git-Tag: v6.1.0-rc0~31^2~8
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=455736df2cfd3a980782986d597132776d630823;p=thirdparty%2Fqemu.git

hw/gpio/pl061: Document the interface of this device

Add a comment documenting the "QEMU interface" of this device:
which MMIO regions, IRQ lines, GPIO lines, etc it exposes.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
---

diff --git a/hw/gpio/pl061.c b/hw/gpio/pl061.c
index 42f6e6c4891..a3c13862212 100644
--- a/hw/gpio/pl061.c
+++ b/hw/gpio/pl061.c
@@ -6,6 +6,13 @@
  * Written by Paul Brook
  *
  * This code is licensed under the GPL.
+ *
+ * QEMU interface:
+ *  + sysbus MMIO region 0: the device registers
+ *  + sysbus IRQ: the GPIOINTR interrupt line
+ *  + unnamed GPIO inputs 0..7: inputs to connect to the emulated GPIO lines
+ *  + unnamed GPIO outputs 0..7: the emulated GPIO lines, considered as
+ *    outputs
  */
 
 #include "qemu/osdep.h"