[PATCH v1 1/2] dt-binding: soc: nuvoton: Add NPCM BPC LPC documentation

From: Tomer Maimon
Date: Tue Nov 22 2022 - 15:12:54 EST


Added device tree binding documentation for Nuvoton BMC NPCM BIOS Post
Code (BPC).

The NPCM BPC monitoring two configurable I/O addresses written by the
host on Low Pin Count (LPC) bus.

Signed-off-by: Tomer Maimon <tmaimon77@xxxxxxxxx>
---
.../bindings/soc/nuvoton/npcm-lpc-bpc.yaml | 112 ++++++++++++++++++
1 file changed, 112 insertions(+)
create mode 100644 Documentation/devicetree/bindings/soc/nuvoton/npcm-lpc-bpc.yaml

diff --git a/Documentation/devicetree/bindings/soc/nuvoton/npcm-lpc-bpc.yaml b/Documentation/devicetree/bindings/soc/nuvoton/npcm-lpc-bpc.yaml
new file mode 100644
index 000000000000..2c8e66546891
--- /dev/null
+++ b/Documentation/devicetree/bindings/soc/nuvoton/npcm-lpc-bpc.yaml
@@ -0,0 +1,112 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/soc/nuvoton/npcm-lpc-bpc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Nuvoton Low Pin Count (LPC) Bus Controller
+
+maintainers:
+ - Tomer Maimon <tmaimon77@xxxxxxxxx>
+
+description:
+ The Low Pin Count (LPC) is a low bandwidth bus that is used to connect
+ peripherals around the CPU and to replace the Industry Standard Architecture
+ (ISA) bus.
+
+ The Nuvoton NPCM LPC bus is a bridge of host CPU to a several of peripheral
+ devices.
+
+properties:
+ compatible:
+ items:
+ - enum:
+ - nuvoton,npcm750-lpc
+ - nuvoton,npcm845-lpc
+ - const: simple-mfd
+ - const: syscon
+
+ reg:
+ maxItems: 1
+
+ "#address-cells":
+ const: 1
+
+ "#size-cells":
+ const: 1
+
+ ranges: true
+
+patternProperties:
+ "^lpc_bpc@[0-9a-f]+$":
+ type: object
+ additionalProperties: false
+
+ description:
+ Nuvoton BMC NPCM BIOS Post Code (BPC) monitoring two configurable I/O
+ addresses written by the host on the Low Pin Count (LPC) bus, the capure
+ data stored in 128-word FIFO.
+
+ NPCM BPC supports capture double words, when using capture
+ double word only I/O address 1 is monitored.
+
+ properties:
+ compatible:
+ items:
+ - enum:
+ - nuvoton,npcm750-lpc-bpc
+ - nuvoton,npcm845-lpc-bpc
+
+ reg:
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+ nuvoton,monitor-ports:
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+ description:
+ Contain monitor I/O addresses, at least one monitor I/O address
+ required.
+
+ nuvoton,bpc-en-dwcapture:
+ description: If present, Enable capture double words support.
+ type: boolean
+
+ required:
+ - compatible
+ - reg
+ - interrupts
+ - nuvoton,monitor-ports
+
+required:
+ - compatible
+ - reg
+ - "#address-cells"
+ - "#size-cells"
+ - ranges
+
+additionalProperties:
+ type: object
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/irq.h>
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+ lpc: lpc@f0007000 {
+ compatible = "nuvoton,npcm750-lpc", "simple-mfd", "syscon";
+ reg = <0xf0007000 0x1000>;
+
+ #address-cells = <1>;
+ #size-cells = <1>;
+ ranges = <0x0 0xf0007000 0x1000>;
+
+ lpc_snoop: lpc-snoop@40 {
+ compatible = "nuvoton,npcm750-lpc-bpc";
+ reg = <0x40 0x20>;
+ interrupts = <GIC_SPI 9 IRQ_TYPE_LEVEL_HIGH>;
+ nuvoton,monitor-ports = <0x80>;
+ };
+ };
+...
--
2.33.0