[PATCH 1/6] dt-bindings: iio: xilinx: Add Documentation for Sysmon

Michal Simek
2025-09-05T08:42:24Z

From: Salih Erim <salih.erim@amd.com>

Add devicetree documentation for Xilinx Sysmon IP which is used for
internal chip monitoring on Xilinx Versal SOCs.

Co-developed-by: Anand Ashok Dumbre <anand.ashok.dumbre@xilinx.com>
Signed-off-by: Anand Ashok Dumbre <anand.ashok.dumbre@xilinx.com>
Co-developed-by: Anish Kadamathikuttiyil Karthikeyan Pillai <anish.kadamathikuttiyil-karthikeyan-pillai@amd.com>
Signed-off-by: Anish Kadamathikuttiyil Karthikeyan Pillai <anish.kadamathikuttiyil-karthikeyan-pillai@amd.com>
Signed-off-by: Salih Erim <salih.erim@amd.com>
Signed-off-by: Michal Simek <michal.simek@amd.com>
---

.../bindings/iio/adc/xlnx,versal-sysmon.yaml | 235 ++++++++++++++++++
1 file changed, 235 insertions(+)
create mode 100644 Documentation/devicetree/bindings/iio/adc/xlnx,versal-sysmon.yaml

diff --git a/Documentation/devicetree/bindings/iio/adc/xlnx,versal-sysmon.yaml b/Documentation/devicetree/bindings/iio/adc/xlnx,versal-sysmon.yaml
new file mode 100644
index 000000000000..a768395cade7
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/xlnx,versal-sysmon.yaml
@@ -0,0 +1,235 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/xlnx,versal-sysmon.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Xilinx Versal Sysmon
+
+maintainers:
+ - Salih Erim <salih.erim@amd.com>
+
+description:
+ The Xilinx Sysmon provides on-chip monitoring and control for the supply
+ voltages and temperatures across the chip. Since there are only 160 supply
+ voltage registers and 184 measurement points, there is no constant mapping
+ of supply voltage registers and the measurement points. User has to select
+ the voltages to monitor in design tool. Depending on the selection, a voltage
+ supply gets mapped to one of the supply registers. So, this mapping information
+ is provided via description which contain the information of name of
+ the supply enabled and the supply register it maps to.
+
+properties:
+ compatible:
+ items:
+ - const: xlnx,versal-sysmon
+
+ reg:
+ maxItems: 1
+ description: Sysmon Registers.
+
+ interrupts:
+ maxItems: 1
+ description: Interrupt line for Sysmon.
+
+ '#address-cells':
+ const: 1
+
+ '#size-cells':
+ const: 0
+
+ '#io-channel-cells':
+ const: 0
+
+ xlnx,hbm:
+ type: boolean
+ description:
+ Exists if node refers to a HBM (High Bandwidth Memory) SLR (Super Logic Region).
+
+ xlnx,nodeid:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description:
+ PLM specified sysmon node id.
+
+ xlnx,numaiechannels:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ minimum: 1
+ maximum: 64
+ description:
+ Total number of sysmon satellites close to AI Engine exposed as channels.
+
+ xlnx,numchannels:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ minimum: 1
+ maximum: 160
+ description:
+ Number of supply channels enabled in the design.
+
+patternProperties:
+ "^supply@([0-9]{1,2}|1[0-5][0-9])$":
+ type: object
+ description:
+ Represents the supplies configured in the design.
+
+ properties:
+ reg:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ minimum: 0
+ maximum: 159
+ description:
+ The supply number associated with the voltage.
+
+ xlnx,name:
+ $ref: /schemas/types.yaml#/definitions/string
+ description:
+ Name of the supply enabled
+
+ xlnx,bipolar:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description:
+ If the supply has a bipolar type and the output will be signed.
+
+ required:
+ - reg
+ - xlnx,name
+
+ additionalProperties: false
+
+ "^temp@([1-9]|[1-5][0-9]|6[0-4])$":
+ type: object
+ description:
+ Represents the sysmon temperature satellites.
+
+ properties:
+ reg:
+ minimum: 1
+ maximum: 64
+ description:
+ The sysmon temperature satellite number.
+
+ xlnx,aie-temp:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description:
+ If present it indicates the temperature satellite is in
+ close proximity with AI Engine
+
+ xlnx,name:
+ $ref: /schemas/types.yaml#/definitions/string
+ description:
+ Name of temperature satellite exposed
+
+ required:
+ - reg
+ - xlnx,name
+
+ additionalProperties: false
+
+required:
+ - compatible
+ - reg
+ - xlnx,numchannels
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+ sysmon@f1270000 {
+ compatible = "xlnx,versal-sysmon";
+ reg = <0xf1270000 0x4000>;
+ interrupts = <0 0x90 IRQ_TYPE_LEVEL_HIGH>;
+ xlnx,numchannels = <8>;
+ xlnx,numaiechannels = <8>;
+ xlnx,nodeid = <0x18224055>;
+ #address-cells = <1>;
+ #size-cells = <0>;
+ supply@0 {
+ reg = <0>;
+ xlnx,name = "vccint";
+ };
+
+ supply@31 {
+ reg = <31>;
+ xlnx,name = "vccsoc";
+ };
+
+ supply@32 {
+ reg = <32>;
+ xlnx,bipolar;
+ xlnx,name = "vccram";
+ };
+
+ supply@63 {
+ reg = <63>;
+ xlnx,bipolar;
+ xlnx,name = "vccaux";
+ };
+
+ supply@64 {
+ reg = <64>;
+ xlnx,name = "vccbram";
+ };
+
+ supply@95 {
+ reg = <95>;
+ xlnx,name = "gt_avaux";
+ };
+
+ supply@96 {
+ reg = <96>;
+ xlnx,name = "gt_vccaux";
+ };
+
+ supply@159 {
+ reg = <159>;
+ xlnx,name = "vccint_ir";
+ };
+
+ temp@7 {
+ reg = <7>;
+ xlnx,aie-temp;
+ xlnx,name = "aie-temp-ch0";
+ };
+
+ temp@8 {
+ reg = <8>;
+ xlnx,aie-temp;
+ xlnx,name = "aie-temp-ch1";
+ };
+
+ temp@14 {
+ reg = <14>;
+ xlnx,aie-temp;
+ xlnx,name = "aie-temp-ch2";
+ };
+
+ temp@15 {
+ reg = <15>;
+ xlnx,aie-temp;
+ xlnx,name = "aie-temp-ch3";
+ };
+
+ temp@16 {
+ reg = <16>;
+ xlnx,aie-temp;
+ xlnx,name = "aie-temp-ch4";
+ };
+
+ temp@30 {
+ reg = <30>;
+ xlnx,aie-temp;
+ xlnx,name = "aie-temp-ch5";
+ };
+
+ temp@33 {
+ reg = <33>;
+ xlnx,aie-temp;
+ xlnx,name = "aie-temp-ch6";
+ };
+
+ temp@34 {
+ reg = <34>;
+ xlnx,aie-temp;
+ xlnx,name = "aie-temp-ch7";
+ };
+ };
--
2.43.0