[PATCH 1/6] dt-bindings: aspeed: Add eSPI controller

From: Chia-Wei, Wang
Date: Wed Jan 06 2021 - 01:01:58 EST

Add dt-bindings and the inclusion header for Aspeed eSPI controller.

Signed-off-by: Chia-Wei, Wang <chiawei_wang@xxxxxxxxxxxxxx>
---
.../devicetree/bindings/soc/aspeed/espi.yaml | 252 ++++++++++++++++++
.../interrupt-controller/aspeed-espi-ic.h | 15 ++
2 files changed, 267 insertions(+)
create mode 100644 Documentation/devicetree/bindings/soc/aspeed/espi.yaml
create mode 100644 include/dt-bindings/interrupt-controller/aspeed-espi-ic.h

diff --git a/Documentation/devicetree/bindings/soc/aspeed/espi.yaml b/Documentation/devicetree/bindings/soc/aspeed/espi.yaml
new file mode 100644
index 000000000000..ee92b66fe15b
--- /dev/null
+++ b/Documentation/devicetree/bindings/soc/aspeed/espi.yaml
@@ -0,0 +1,252 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# # Copyright (c) 2020 Aspeed Technology Inc.
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/soc/aspeed/espi.yaml#";
+$schema: "http://devicetree.org/meta-schemas/core.yaml#";
+
+title: Aspeed eSPI Controller
+
+maintainers:
+ - Chia-Wei Wang <chiawei_wang@xxxxxxxxxxxxxx>
+ - Ryan Chen <ryan_chen@xxxxxxxxxxxxxx>
+
+description:
+ Aspeed eSPI controller implements a slave side eSPI endpoint device
+ supporting the four eSPI channels, namely peripheral, virtual wire,
+ out-of-band, and flash.
+
+properties:
+ compatible:
+ items:
+ - enum:
+ - aspeed,ast2600-espi
+ - const: simple-mfd
+ - const: syscon
+
+ reg:
+ maxItems: 1
+
+ "#address-cells":
+ const: 1
+
+ "#size-cells":
+ const: 1
+
+ ranges: true
+
+ espi-ic:
+ type: object
+
+ properties:
+ compatible:
+ const: aspeed,ast2600-espi-ic
+
+ interrupts:
+ maxItems: 2
+
+ interrupt-controller: true
+
+ "#interrupt-cells":
+ const: 1
+ description:
+ The cell is a SW-encoded number for IRQ dispatching to eSPI channels
+
+ required:
+ - compatible
+ - interrupts
+ - interrupt-controller
+ - "#interrupt-cells"
+
+ espi-ctrl:
+ type: object
+
+ properties:
+ compatible:
+ const: aspeed,ast2600-espi-ctrl
+
+ interrupts:
+ maxItems: 2
+
+ clocks:
+ maxItems: 1
+
+ resets:
+ maxItems: 1
+
+ required:
+ - compatible
+ - interrupts
+ - clocks
+ - resets
+
+ espi-peripheral-channel:
+ type: object
+
+ properties:
+ compatible:
+ const: aspeed,ast2600-espi-peripheral
+
+ interrupts:
+ maxItems: 2
+
+ dma-mode:
+ type: boolean
+
+ memcyc,map-src-addr:
+ $ref: "/schemas/types.yaml#/definitions/uint32"
+ description: The host side address to be decoded into the memory cycle over eSPI peripheral channel
+
+ memcyc,map-size:
+ $ref: "/schemas/types.yaml#/definitions/uint32"
+ description: The size of the memory region allocated for the memory cycle over eSPI peripheral channel
+ minimum: 65536
+
+ required:
+ - compatible
+ - interrupts
+ - memcyc,map-src-addr
+ - memcyc,map-size
+
+ espi-vw-channel:
+ type: object
+
+ properties:
+ compatible:
+ const: aspeed,ast2600-espi-vw
+
+ interrupts:
+ maxItems: 2
+
+ required:
+ - compatible
+ - interrupts
+
+ espi-oob-channel:
+ type: object
+
+ properties:
+ compatible:
+ const: aspeed,ast2600-espi-oob
+
+ interrupts:
+ maxItems: 2
+
+ dma-mode:
+ type: boolean
+
+ dma-tx-desc-num:
+ $ref: "/schemas/types.yaml#/definitions/uint32"
+ minimum: 2
+ maximum: 1023
+
+ dma-rx-desc-num:
+ $ref: "/schemas/types.yaml#/definitions/uint32"
+ minimum: 2
+ maximum: 1023
+
+ required:
+ - compatible
+ - interrupts
+
+ espi-flash-channel:
+ type: object
+
+ properties:
+ compatible:
+ const: aspeed,ast2600-espi-flash
+
+ interrupts:
+ maxItems: 2
+
+ dma-mode:
+ type: boolean
+
+ safs-mode:
+ description: Slave-Attached-Sharing-Flash mode, 0->Mix, 1->SW, 2->HW
+ enum: [ 0, 1, 2 ]
+
+ required:
+ - compatible
+ - interrupts
+
+required:
+ - compatible
+ - reg
+ - "#address-cells"
+ - "#size-cells"
+ - ranges
+ - espi-ic
+ - espi-ctrl
+ - espi-peripheral-channel
+ - espi-vw-channel
+ - espi-oob-channel
+ - espi-flash-channel
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+ #include <dt-bindings/interrupt-controller/aspeed-espi-ic.h>
+ #include <dt-bindings/clock/ast2600-clock.h>
+ #include <dt-bindings/gpio/aspeed-gpio.h>
+
+ espi: espi@1e6ee000 {
+ compatible = "aspeed,ast2600-espi", "simple-mfd", "syscon";
+ reg = <0x1e6ee000 0x1000>;
+
+ #address-cells = <1>;
+ #size-cells = <1>;
+ ranges = <0x0 0x1e6ee000 0x1000>;
+
+ espi_ic: espi-ic {
+ #interrupt-cells = <1>;
+ compatible = "aspeed,ast2600-espi-ic";
+ interrupts-extended = <&gic GIC_SPI 42 IRQ_TYPE_LEVEL_HIGH>,
+ <&gpio0 ASPEED_GPIO(W, 7) IRQ_TYPE_EDGE_FALLING>;
+ interrupt-controller;
+ };
+
+ espi_ctrl: espi-ctrl {
+ compatible = "aspeed,ast2600-espi-ctrl";
+ interrupts-extended = <&espi_ic ASPEED_ESPI_IC_CTRL_EVENT>,
+ <&espi_ic ASPEED_ESPI_IC_CTRL_RESET>;
+ clocks = <&syscon ASPEED_CLK_GATE_ESPICLK>;
+ resets = <&syscon ASPEED_RESET_ESPI>;
+ };
+
+ espi_peripheral: espi-peripheral-channel {
+ compatible = "aspeed,ast2600-espi-peripheral";
+ interrupts-extended = <&espi_ic ASPEED_ESPI_IC_PERIF_EVENT>,
+ <&espi_ic ASPEED_ESPI_IC_CHAN_RESET>;
+ dma-mode;
+ memcyc,map-src-addr = <0x98000000>;
+ memcyc,map-size = <0x10000>;
+ };
+
+ espi_vw: espi-vw-channel {
+ compatible = "aspeed,ast2600-espi-vw";
+ interrupts-extended = <&espi_ic ASPEED_ESPI_IC_VW_EVENT>,
+ <&espi_ic ASPEED_ESPI_IC_CHAN_RESET>;
+ };
+
+ espi_oob: espi-oob-channel {
+ compatible = "aspeed,ast2600-espi-oob";
+ interrupts-extended = <&espi_ic ASPEED_ESPI_IC_OOB_EVENT>,
+ <&espi_ic ASPEED_ESPI_IC_CHAN_RESET>;
+ dma-mode;
+ dma-tx-desc-num = <2>;
+ dma-rx-desc-num = <2>;
+ };
+
+ espi_flash: espi-flash-channel {
+ compatible = "aspeed,ast2600-espi-flash";
+ interrupts-extended = <&espi_ic ASPEED_ESPI_IC_FLASH_EVENT>,
+ <&espi_ic ASPEED_ESPI_IC_CHAN_RESET>;
+ dma-mode;
+ safs-mode = <2>;
+ };
+ };
+
+...
diff --git a/include/dt-bindings/interrupt-controller/aspeed-espi-ic.h b/include/dt-bindings/interrupt-controller/aspeed-espi-ic.h
new file mode 100644
index 000000000000..85faa198350d
--- /dev/null
+++ b/include/dt-bindings/interrupt-controller/aspeed-espi-ic.h
@@ -0,0 +1,15 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
+
+#ifndef _DT_BINDINGS_INTERRUPT_CONTROLLER_ASPEED_ESPI_IC_H_
+#define _DT_BINDINGS_INTERRUPT_CONTROLLER_ASPEED_ESPI_IC_H_
+
+/* SW-decoded IRQs for eSPI host HW reset and channel events */
+#define ASPEED_ESPI_IC_CTRL_RESET 0
+#define ASPEED_ESPI_IC_CHAN_RESET 1
+#define ASPEED_ESPI_IC_CTRL_EVENT 2
+#define ASPEED_ESPI_IC_PERIF_EVENT 3
+#define ASPEED_ESPI_IC_VW_EVENT 4
+#define ASPEED_ESPI_IC_OOB_EVENT 5
+#define ASPEED_ESPI_IC_FLASH_EVENT 6
+
+#endif
--
2.17.1