Received-SPF: pass (google.com: domain of linux-kernel+bounces-187364-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
From: Pankaj Gupta <pankaj.gupta@nxp.com>
Date: Thu, 23 May 2024 16:19:33 +0530
Subject: [PATCH v2 2/5] dt-bindings: arm: fsl: add imx-se-fw binding doc
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-Id: <20240523-imx-se-if-v2-2-5a6fd189a539@nxp.com>
References: <20240523-imx-se-if-v2-0-5a6fd189a539@nxp.com>
In-Reply-To: <20240523-imx-se-if-v2-0-5a6fd189a539@nxp.com>
To: Jonathan Corbet <corbet@lwn.net>, Rob Herring <robh+dt@kernel.org>, 
 Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, 
 Conor Dooley <conor+dt@kernel.org>, Shawn Guo <shawnguo@kernel.org>, 
 Sascha Hauer <s.hauer@pengutronix.de>, 
 Pengutronix Kernel Team <kernel@pengutronix.de>, 
 Fabio Estevam <festevam@gmail.com>, Rob Herring <robh@kernel.org>, 
 Krzysztof Kozlowski <krzk+dt@kernel.org>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, 
 devicetree@vger.kernel.org, imx@lists.linux.dev, 
 linux-arm-kernel@lists.infradead.org, Pankaj Gupta <pankaj.gupta@nxp.com>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?VGZrRFQwaFlDNHA0Vm9zelBYV3MyUTdQRFYzVU5pdXFyOFEySTFQaFlwV1Zh?=
 =?utf-8?B?OTFaZEVNWnRZOFR6dktoS0NPTE1nYXVuaHU3Y25OMWlMSlVZUUhmK25VdUFX?=
 =?utf-8?B?TFJaYlBacm1oSStwWDNoanlXcUlNWmFwSzdCRWRPbkZJOXR6K0tOUUlmS3hu?=
 =?utf-8?B?eTRWS3IyZys2MFpPTndkY0Vjc2Q3NVZBaXZhaEpyM0Mxb1VBcXJDV1U3ejF1?=
 =?utf-8?B?WU01TC9oZDZqOUFMTDlCRC9Qb3oxVVZuank4aXlmYU54eEs0VTBGL1J2VHJ5?=
 =?utf-8?B?Z2NGS2lXb0hvaURMOWRGUlJoem9vMkhxNWpRZWFjUnI4eElCdXdwcy8xRWJ5?=
 =?utf-8?B?QThxQUNSUEI5aHAzT0didUR4Z0lhc0swQjJlaEx4QU1sb3dqOGZyNFRmZ2lT?=
 =?utf-8?B?TTFKdG96aHdSbHFBR1NzNVhTNDhJd1l0YWUwS21qaU42aHBFU2VKREh1V3Vw?=
 =?utf-8?B?TW9mWDdHRklOZlZUM1JHRlBPanVSQmk1UWlKNzZHd3FPdzExVUh0VWh2Vmtv?=
 =?utf-8?B?QkdzcnIyaEdxQ2pTRFhMYkU2NDJON2R6Y2h3NDlUd0IrNDlpY3IrNUtXdnpm?=
 =?utf-8?B?UW1VbjRqWW94RkV6S1FqYm5KRndCemQ0c3RrajZ3SmNSd1dWdW9qSFMrWStq?=
 =?utf-8?B?eEFGK0tGd0pXalllT3Uvai9USnlWV080dWFUTE83Y2lOL3pWRkZJUlBTREVV?=
 =?utf-8?B?Q3BKamloMjVQOVk3ckswdWVXdDB4RXcwNHNIcWRzZm1KajErUjhyM21Md2hZ?=
 =?utf-8?B?YzhtU2RFNExpb1FTSmhGbXhaYU5Db2h5QURHdCtMTlBpMzNUSmF4ZXgrMU1B?=
 =?utf-8?B?RDRuYTRCUXFqWFdzMjR3cFJuaFR5UGpJZm52alBsc3N3UWxoa1RaQ3lpQUJP?=
 =?utf-8?B?NERxOW1vcUYrUUxhMWVMY0pOVFg3RXBlUHpiSGZ2VFkzUkRJejlIblVrVFpM?=
 =?utf-8?B?S1RJdE1CWlVPd1VQN0FXb2NOQ25uWXVCYXUwQmxRM0t2VThjWFFybnZZeDhP?=
 =?utf-8?B?VUthMDd2KzRJdlBlUXVmQUNuTXZTRFNmekR5d1U4emllcXZWVW9xYURtcmRI?=
 =?utf-8?B?dUZIYlJUcEViYXk2eU1KRU5pRVRZd2lTbkZoRFo1anVrQnNnbXd6OTdicWlG?=
 =?utf-8?B?a0p3T25CWFQyQzFCM0k5S2NiVjJKOUZFSUhPS1hRWG82cTd1eVhuYjBWcWFu?=
 =?utf-8?B?aHpRaXl2dUd5clhpbzlSNzJLcWRraWptR1JXTm1DV1BWMlhnSWo1M08xRTMr?=
 =?utf-8?B?Vy9HM3N0Q0M4R09Ld29pSTVkZW1VeE5NR3AwYnpVU0JrSTlNdXRSVm4xK1J6?=
 =?utf-8?B?V0svTzlhZUdNYzhaVld2K3Z3NU1QT0JXazRWK29lbVQ5NDRiRVNjd3JtZXYx?=
 =?utf-8?B?R0V0b3drOW5oQ25OVnBlbDQ5Umg3d01xRVhPbFU5ZmY4MU5Rcm5tN2N5QW5Z?=
 =?utf-8?B?ZGxJYVlNSlN5eUNwRlhUeHZwbjNtT0FwR0JNMzExOHBaTlJrbFFjVHVLTFk5?=
 =?utf-8?B?VTZmS2xMZ0h2NzQ3ZDdxNlNPbHJRSEhOcWRKalVOSFJNMWljdzJTSThNT3R6?=
 =?utf-8?B?ZUpsWk9ROHpieEppNllSNjFCTU55L2xld2RqYWJiRzdpSUo1OWpPNG8yOEJC?=
 =?utf-8?B?aDVxaWM2QnNhWUhIVmtNZHlEelhXTmx3UW9HeExGRmNlSnZhRHNldXdNczM2?=
 =?utf-8?B?NmlJY0liY0hVekxEYjZmRVJWUjJMUXRQR3hja3hzV3d6RXQ0M3EyMVZ1RSs0?=
 =?utf-8?B?SzBINm8zZGppcGdSUC8zK1hhWVUrMTMvYU05RDJKOENkV1MvTmNaZDhqU0xx?=
 =?utf-8?B?WTB2Wk85QVcwQjNhcmhYVm9ERnRHWHduakJGNU9MTUw1amRxU3ZLM1YvVVdW?=
 =?utf-8?B?eENWcmVxMWk0OUZRVTJ6NFV4TnhSajBhcklvK0FxcER3ck1hWlAya0ZWeUpF?=
 =?utf-8?B?UE5uWjhqbWtwMzAwbWlHSjZtZ2g5c2x3Q1FUOVp0WXUzZ3lROExqKzhZYXkz?=
 =?utf-8?B?K2tlZ1dMby9JeXJmSFFMYks0aytWYnpxTG16N3VLcXZHdVlndHlnK2VrMkk1?=
 =?utf-8?B?NkdQbzh4WnVyNUJtNzFFbUpDTmFTWTI3S1dhVWVUK1N1QmM5RjdKdFFDMFFv?=
 =?utf-8?Q?T8kGOMgeiLTeMt4h3n0kMKo/+?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 6833a1db-9e41-4bc5-8508-08dc7b167565
X-MS-Exchange-CrossTenant-AuthSource: AM9PR04MB8604.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 May 2024 10:52:37.0689
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 2DMusY5Vva3/iwmDYXbwNbiuMSru6hAmlGjR7d7lN6j4Je7jGeEcHn7V5lp/54Mu/CYJPdbWycc0vqupxFSbOw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM8PR04MB7474

The NXP security hardware IP(s) like: i.MX EdgeLock Enclave, V2X etc.,
creates an embedded secure enclave within the SoC boundary to enable
features like:
- HSM
- SHE
- V2X

Secure-Enclave(s) communication interface are typically via message
unit, i.e., based on mailbox linux kernel driver. This driver enables
communication ensuring well defined message sequence protocol between
Application Core and enclave's firmware.

Driver configures multiple misc-device on the MU, for multiple
user-space applications, to be able to communicate over single MU.

It exists on some i.MX processors. e.g. i.MX8ULP, i.MX93 etc.

Signed-off-by: Pankaj Gupta <pankaj.gupta@nxp.com>
---
 .../devicetree/bindings/firmware/fsl,imx-se.yaml   | 154 +++++++++++++++++++++
 1 file changed, 154 insertions(+)

diff --git a/Documentation/devicetree/bindings/firmware/fsl,imx-se.yaml b/Documentation/devicetree/bindings/firmware/fsl,imx-se.yaml
new file mode 100644
index 000000000000..b27f84db6f91
--- /dev/null
+++ b/Documentation/devicetree/bindings/firmware/fsl,imx-se.yaml
@@ -0,0 +1,154 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/firmware/fsl,imx-se.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP i.MX HW Secure Enclave(s) EdgeLock Enclave
+
+maintainers:
+  - Pankaj Gupta <pankaj.gupta@nxp.com>
+
+description: |
+  NXP's SoC may contain one or multiple embedded secure-enclave HW
+  IP(s) like i.MX EdgeLock Enclave, V2X etc. These NXP's HW IP(s)
+  enables features like
+    - Hardware Security Module (HSM),
+    - Security Hardware Extension (SHE), and
+    - Vehicular to Anything (V2X)
+
+  Communication interface to the secure-enclaves is based on the
+  messaging unit(s).
+
+properties:
+  $nodename:
+    pattern: "^[0-9a-z]*-if@[0-9a-f]+$"
+
+  compatible:
+    enum:
+      - fsl,imx8ulp-ele
+      - fsl,imx93-ele
+      - fsl,imx95-ele
+
+  reg:
+    maxItems: 1
+    description: Identifier of the communication interface to secure-enclave.
+
+  mboxes:
+    description: contain a list of phandles to mailboxes.
+    items:
+      - description: Specify the mailbox used to send message to se firmware
+      - description: Specify the mailbox used to receive message from se firmware
+
+  mbox-names:
+    items:
+      - const: tx
+      - const: rx
+      - const: txdb
+      - const: rxdb
+    minItems: 2
+
+  memory-region:
+    description: contains a list of phandles to reserved external memory.
+    items:
+      - description: It is used by secure-enclave firmware. It is an optional
+          property based on compatible and identifier to communication interface.
+          (see bindings/reserved-memory/reserved-memory.txt)
+
+  sram:
+    description: contains a list of phandles to sram.
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+    items:
+      - description: Phandle to the device SRAM. It is an optional property
+          based on compatible and identifier to communication interface.
+
+allOf:
+  # memory-region
+  - if:
+      properties:
+        compatible:
+          contains:
+            enum:
+              - fsl,imx8ulp-ele
+              - fsl,imx93-ele
+    then:
+      required:
+        - memory-region
+    else:
+      not:
+        required:
+          - memory-region
+
+  # sram
+  - if:
+      properties:
+        compatible:
+          contains:
+            enum:
+              - fsl,imx8ulp-ele
+    then:
+      required:
+        - sram
+    else:
+      not:
+        required:
+          - sram
+
+required:
+  - compatible
+  - reg
+  - mboxes
+  - mbox-names
+
+additionalProperties: false
+
+examples:
+  - |
+    firmware {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      ele-if@0 {
+        compatible = "fsl,imx8ulp-ele";
+        reg = <0x0>;
+        mboxes = <&s4muap 0 0>, <&s4muap 1 0>;
+        mbox-names = "tx", "rx";
+        sram = <&sram0>;
+        memory-region = <&ele_reserved>;
+      };
+    };
+  - |
+    firmware {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      ele-if@0 {
+        compatible = "fsl,imx93-ele";
+        reg = <0x0>;
+        mboxes = <&s4muap 0 0>, <&s4muap 1 0>;
+        mbox-names = "tx", "rx";
+        memory-region = <&ele_reserved>;
+      };
+    };
+  - |
+    firmware {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      v2x-if@0 {
+        compatible = "fsl,imx95-v2x";
+        reg = <0x0>;
+        mboxes = <&v2x_mu 0 0>, <&v2x_mu 1 0>;
+        mbox-names = "tx", "rx";
+      };
+      v2x-if@1 {
+        compatible = "fsl,imx95-v2x";
+        reg = <0x1>;
+        mboxes = <&v2x_mu6 0 0>, <&v2x_mu6 1 0>;
+        mbox-names = "txdb", "rxdb";
+      };
+      v2x-if@2 {
+        compatible = "fsl,imx95-v2x";
+        reg = <0x2>;
+        mboxes = <&v2x_mu7 0 0>, <&v2x_mu7 1 0>;
+        mbox-names = "tx", "rx";
+      };
+    };
+...

-- 
2.34.1