Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Oleksii Moisieiev <Oleksii_Moisieiev@epam.com>
To:     "robh+dt@kernel.org" <robh+dt@kernel.org>
CC:     Oleksii Moisieiev <Oleksii_Moisieiev@epam.com>,
        "devicetree@vger.kernel.org" <devicetree@vger.kernel.org>,
        Sudeep Holla <sudeep.holla@arm.com>,
        Cristian Marussi <cristian.marussi@arm.com>,
        Stefano Stabellini <sstabellini@kernel.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: [RFC PATCH 1/1] dt-bindings: arm: Add scmi_devid property description
 for SCMI
Thread-Topic: [RFC PATCH 1/1] dt-bindings: arm: Add scmi_devid property
 description for SCMI
Thread-Index: AQHYJ0g0zA4b1xgTn0m4ZMeiASfcFw==
Date:   Mon, 21 Feb 2022 17:26:47 +0000
Message-ID: <c751add9b54e9661e463ae265d8d5f0314eac33e.1645460043.git.oleksii_moisieiev@epam.com>
References: <cover.1645460043.git.oleksii_moisieiev@epam.com>
In-Reply-To: <cover.1645460043.git.oleksii_moisieiev@epam.com>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-antispam-messagedata-chunkcount: 1
x-ms-exchange-antispam-messagedata-0: =?iso-8859-1?Q?73SFgQrXIr0ujPZcUCPKYOJgw2rdBmoIAOziqI8zlAkw5GI0XWDN68q6gV?=
 =?iso-8859-1?Q?fyWAR4TyVy1x121jEY2ZjdQe8uCkZRrPMQvl6VQDMo364vix7zJzTiFejO?=
 =?iso-8859-1?Q?oSXey2uLz0Eq8Cl5EG2mrOI4sybi6RAVpZ6vPttIMdy4XzTiaeLHAL1kpH?=
 =?iso-8859-1?Q?v7WB/hyG0+3PvbHMrpV+gg9NNTH75jo+FxLzowXcbNqMnELD4ZPkH/T0W7?=
 =?iso-8859-1?Q?BoUBx/FCuphNQyOMx1tmMJPF9OBcFXCQydzIIFx1wWx3VFiA5yxId+dD2F?=
 =?iso-8859-1?Q?09Q6IN3b0MqvZ7/4eX9rBoOM5/q2knzX3j3tgxbFXREBQrzXJ8z8MsnXuq?=
 =?iso-8859-1?Q?juTIY9soPs5Tgz6cBj4eQf/n2kD3uLMzgYzRVxFVjA6WKwy6HhORn9zqOh?=
 =?iso-8859-1?Q?RzLHB1N20uPLW5F6TGx16zXj6k0SopEJrrKefgdQXVoGvsIuyiUZT+0sUo?=
 =?iso-8859-1?Q?IeG3HZASJCfPoRwn+a85B4e0EoL9RylqMII4rTenSG409ZxOsrAEUdwRVd?=
 =?iso-8859-1?Q?DZvkBW6ast0Dbz+ykFkej9TfAy272YjHUpNMQYLXnCFJGZE7ld0OsapUR8?=
 =?iso-8859-1?Q?KSYPHwUmEQEnyMfXNvlCM+7to7H95eIMZOCfPxDJWHwPqq+KJPqxoUZZLX?=
 =?iso-8859-1?Q?vAZSh891LXljCoQOQilBIall2j9YKuhdSLHKwMFAowshCBPsFupyB7CzLX?=
 =?iso-8859-1?Q?FTgFAbN0UCoAaq42/VUb0JeBi001HrNGYA7pQpvH8iQM4yoOCAyE4ZGp3s?=
 =?iso-8859-1?Q?o0V62vRzs+JAG9S5h1tfxwDyR3J2vJjLVnkRzNPbx9YRfZTOFrJ4HQJKPT?=
 =?iso-8859-1?Q?TxRVFeQVRfFKTtzqL5sQ8Uxe5bNJGXjfWmcYemPEZ4hfjPid57X8K23bB7?=
 =?iso-8859-1?Q?XDe/hy9iMsRIlB02cV/AsLOhicO3URQ4W7Z7Kk8QMgUqqOBrsaUec/nVq9?=
 =?iso-8859-1?Q?5TFnhJ32GNHTTa3zIODMN1mEEiGkjiS30+UjE1QnLLR/0CF9LPhyyV7aZe?=
 =?iso-8859-1?Q?aNBZPIsYMB8LDGSJb34hlajubVjG0a01aNn57JBG2zWIMqFzsR8yblBK57?=
 =?iso-8859-1?Q?l4+yeMcBhgZ0r/HStD6csoISbWWy5q75UbWHpz7taKUa+3hVw+2LvOVb1E?=
 =?iso-8859-1?Q?GmfXeX3LkjquL0gXiWH2YF8KPs6h+aH3vfWGl5Mzy2n5WQKwfjlQib14c7?=
 =?iso-8859-1?Q?4uGSIdgkl2jBuLP/Q0+7g0mOyewyG5BX6lpteE+p3GtnMkJTNcSHew1mTt?=
 =?iso-8859-1?Q?dx83gY4F+QUPuo2EVHXtHcIbAGFzUKOiZuBtYt5wX3DSccZZ4eMQaimDXB?=
 =?iso-8859-1?Q?ImUEmW0fXIS8H/+gKmbtUq3THvnHfgDf3kcQiIXXvVzq6ILGhld3BYHgx2?=
 =?iso-8859-1?Q?b1nCFMWbQuGnvQRwiD1DLsxHBTIkiv188sDMRWy8GpzlP0GXOG6XQYFkMt?=
 =?iso-8859-1?Q?7HbAqwVkKEHuszsxtFhrtdm1t6MZq/XMsWf7uxL3ffMcyg+26euL5HAnlC?=
 =?iso-8859-1?Q?81DEq/wQ3tI8rATEARGYNUpY4FnnG6ja4KAOr98ALsADLLWgGdp2zLsJh0?=
 =?iso-8859-1?Q?YPetbq1D6xigpE0jd/+BiU5zhuIKv0xZeI0GPBGxEyXWcllE14cJMfcT9X?=
 =?iso-8859-1?Q?1VCFiMXyXDhJz49F53nBZcSRukf5OMzfhxNKdOc4RbJNPofqICaeYtH99R?=
 =?iso-8859-1?Q?cDF6PP9AV3U4QrfHvI/GURvJI8neylDIRt6BUIdnPlKhcFRuSYr1AHAT7k?=
 =?iso-8859-1?Q?mTHXlT3gngrxW/J6Ko1QemzBM=3D?=
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: epam.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: PA4PR03MB7136.eurprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 020de823-10d4-462c-ff49-08d9f55f5706
X-MS-Exchange-CrossTenant-originalarrivaltime: 21 Feb 2022 17:26:47.8535
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: b41b72d0-4e9f-4c26-8a69-f949f367c91d
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: h9TcGla/lHiN0qaYWO1XIpgxzLWiczh8v5u6qieXlgP1/9ZVVPn2D8T9ssxTQv3Ms3vVFnEmIdLpeZlvZEzucSxZ/HQsKYnmWtcZ7m/jQH4=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM7PR03MB6466
X-Proofpoint-GUID: 77YRlup52W7yP-dh0DuQSWc-ThSu1Mxg
X-Proofpoint-ORIG-GUID: 77YRlup52W7yP-dh0DuQSWc-ThSu1Mxg
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.205,Aquarius:18.0.816,Hydra:6.0.425,FMLib:17.11.62.513
 definitions=2022-02-21_08,2022-02-21_02,2021-12-02_01
X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501
 bulkscore=0 phishscore=0 lowpriorityscore=0 spamscore=0 suspectscore=0
 mlxlogscore=574 impostorscore=0 adultscore=0 malwarescore=0 clxscore=1015
 mlxscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2201110000 definitions=main-2202210102
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_NONE,
        T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Document scmi_devid property for the devices, using SCMI protocol
to work with clocks/resets/power-domains etc. This property is intended
to set the device id, which should be used to manage device permissions
in the firmware. Device permissions management is descibed in DEN 0056,
Section 4.2.2.10 [0].

This property is useful for the virtualized systems, when several agents
are running on the same platform. Agent term is descibed in Section
4.1.1 [0].

[0] https://developer.arm.com/documentation/den0056/latest

Signed-off-by: Oleksii Moisieiev <oleksii_moisieiev@epam.com>
---
 .../bindings/firmware/arm,scmi-devid.yaml     | 41 +++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/firmware/arm,scmi-dev=
id.yaml

diff --git a/Documentation/devicetree/bindings/firmware/arm,scmi-devid.yaml=
 b/Documentation/devicetree/bindings/firmware/arm,scmi-devid.yaml
new file mode 100644
index 000000000000..b0949319e00b
--- /dev/null
+++ b/Documentation/devicetree/bindings/firmware/arm,scmi-devid.yaml
@@ -0,0 +1,41 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2022 EPAM Systems.
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/firmware/arm,scmi-devid.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: System Control and Management Interface (SCMI) Device ID for permis=
sions
+    handling
+
+maintainers:
+  - Oleksii Moisieiev <oleksii_moisieiev@epam.com>
+
+description: |
+  SCMI device id property is intended to set the device id, needed to mana=
ge
+  the device permissions via SCMI protocol in the firmware. The device Id
+  should match device ids, defined in the firmware so the device permissio=
ns
+  can be requested by sending BASE_SET_DEVICE_PERMISSIONS (see 4.2.2.10 of=
 [0]).
+
+  This property is useful on the virtualized systems, when several agents =
are
+  running on the same time and permissions should be set for the devices,
+  related to different agents.
+
+  [0] https://developer.arm.com/documentation/den0056/latest
+
+properties:
+  scmi_devid:
+    description: Identifier of the device, matching device id, defined in
+      the firmware.
+    $ref: /schemas/types.yaml#/definitions/uint32
+
+additionalProperties: false
+
+examples:
+  - |
+    ohci1: usb@ee0a0000 {
+        /* ... */
+        reg =3D <0 0xee0a0000 0 0x100>;
+        scmi_devid =3D <11>;
+        clocks =3D <&scmi_clock 4>;
+    };
--=20
2.27.0