Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:3 as permitted sender) client-ip=2620:137:e000::3:3;
From:   Pankaj Gupta <pankaj.gupta@nxp.com>
To:     shawnguo@kernel.org, s.hauer@pengutronix.de, kernel@pengutronix.de,
        clin@suse.com, conor+dt@kernel.org, pierre.gondois@arm.com,
        festevam@gmail.com, linux-imx@nxp.com, davem@davemloft.net,
        robh+dt@kernel.org, krzysztof.kozlowski+dt@linaro.org,
        linux-arm-kernel@lists.infradead.org, devicetree@vger.kernel.org,
        linux-kernel@vger.kernel.org, gaurav.jain@nxp.com,
        alexander.stein@ew.tq-group.com, V.Sethi@nxp.com
Cc:     Pankaj Gupta <pankaj.gupta@nxp.com>
Subject: [PATCH v6 02/11] dt-bindings: arm: fsl: add imx-se-fw binding doc
Date:   Wed, 27 Sep 2023 23:23:52 +0530
Message-Id: <20230927175401.1962733-3-pankaj.gupta@nxp.com>
In-Reply-To: <20230927175401.1962733-1-pankaj.gupta@nxp.com>
References: <20230927175401.1962733-1-pankaj.gupta@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?P3Mgjvc7XlQhLSaN+PauMX/qFd07t/YS1xA6GHNgag7WXtyM5lR4H9qaV0Vo?=
 =?us-ascii?Q?8WvI1h2WvNOscAvToz8vUs1NyQzSa5qWTUQhQ/vS+micn9oUaE8mfIFfPIfL?=
 =?us-ascii?Q?u/LRR/WqaFSdPV4GzyCkf7tPAcAMt3/+YGQxwDOnRWJ7F8wWkVNIzRq4SUzn?=
 =?us-ascii?Q?TsZ5slxArcKC99fwk2kYiLnR3fJWW2QjilFig2rqjM3Cn03egw0qO4uSVn0d?=
 =?us-ascii?Q?5SW6DgmOdxgz27TQZeaUgLcEVZpdI/rEjjcmPi9eGmhix5iOiaOR5Vtwh761?=
 =?us-ascii?Q?BrvSWfGPnEu7F0RzKKcxwt/XfMBZVZeUdOu2l50uUl+LMXbnp25QWtxxVE9q?=
 =?us-ascii?Q?mYqbFh83Tdo7tqUUhQVpDaf0arjv/fYT10TnUZA2QbY9WB5EDx6GbV2ENl/3?=
 =?us-ascii?Q?VisbDrfkfO3jPMEf8hsRUeMv9awTJIzpjQbEJmEhTa88zNhZzBJy588S3v66?=
 =?us-ascii?Q?Zj+bhYblD2D+EbIU6kaFCmSV0mb68HxA5tK4Ay1wbBSOji3D4EGOlMTp9pho?=
 =?us-ascii?Q?Dtkv1lturg7Q10Ro+TnFFtwN+EGoMyQUEx8jXwXTEH28g9X9XFzPy5B9a9ZD?=
 =?us-ascii?Q?2niBiyxtRkoWbmSQjrUtMsfCbqnFjhDWdXoRh/PbWsk7044d4YhvxYxq8Fac?=
 =?us-ascii?Q?owrdpmyvn/oZunYHCnE1PXYsy99YkuJYQEDQe5WvGNXHM5c+HdF431YSKPMK?=
 =?us-ascii?Q?iJktvdljJI8ey5BTT/mwWLeEaKm0mI/AbOSzF8UylOfZQ4IhiLOsVdR3CnmG?=
 =?us-ascii?Q?ypAx0qEUd9CAciZxGROuPVoEioZ3SDhib7juxeVFQ6isaTmk8ITyE23YUPz8?=
 =?us-ascii?Q?L+GJnJzC4YVM2xRa487tLucnAhJ9Mn80Lcoi4rD+Kp9DUTHl/tCNgPHFeQJg?=
 =?us-ascii?Q?+/b9B51jhtAjq6Vy5fcGroc27dy/L3Pe9/RzvzuE7Ixzk1dsxBq87WLtUXwb?=
 =?us-ascii?Q?OyoKu3qlPV3JpvvImB7pK5IoDwU99QL4dWqcX+2e8F5Q9YpMBmRFA6xtk1p0?=
 =?us-ascii?Q?o4LrOWiPw2Xm1+90JE7xBJN1BibaTl72CWRKu2V4YHXjz3kG/X1eDlrgAz/3?=
 =?us-ascii?Q?gsZZXmVLc12E4SVxvlPY4LJWELxxjSC0Ldx1IzGZznBveFb5CFc4zbtsSBmr?=
 =?us-ascii?Q?xxfPZQQNtJ/YOBkI7pw8Uwc6J9mTpJ6UYobgYmgo+hzOymxBReSyf3q0Q8JN?=
 =?us-ascii?Q?6H3mYj1OuW7MZ+5yvDMH/BnToPHCowvkSOWgoRfrb0onFwGvvSMt8jocrjqn?=
 =?us-ascii?Q?zxl49i8QqdUipCzoxvcH+djLFXkrBPKdONshobNr4zRa3+6kK3Mm6uxNkOOU?=
 =?us-ascii?Q?JKCNjcdzw9lDBpULRVU1lDq9mNbzDQGDane5ICl6ZojrVLuK4qJ74OGLL/No?=
 =?us-ascii?Q?rwl+cPHo1dt7H4oaau2tFFbeZ3z6bvefmikW2qtFCIzqYq418HN4SF8VJ7y8?=
 =?us-ascii?Q?e9dEoHqa8pW7dBBuC9nkbl7JO+36pNBFswlcSkjGSkXic8xKik9aFPQWkNxx?=
 =?us-ascii?Q?DfWKbby5xadpV/X1cniyeC/xobJvRzZyakiPw4vSMrq5Px77XDRqmSRH4yLO?=
 =?us-ascii?Q?48CPU9NjHQ6C1/xcQuwQqW23TUgJmLnFK1kjubpt?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 1ba0d855-4cfa-4e31-da33-08dbbf54fe97
X-MS-Exchange-CrossTenant-AuthSource: DU2PR04MB8630.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 27 Sep 2023 12:26:37.5420
 (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: 3UG50l9EN275sqtbZJUqMAAOJHGrFMC/xqReDZsBLqUjFgDoeVUp1SSSoRfdyVhrI3WrAUYMYfL8Afl76y1Sqg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AS8PR04MB7704
X-Spam-Status: No, score=1.6 required=5.0 tests=DATE_IN_FUTURE_03_06,
	DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=no
	autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lipwig.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (lipwig.vger.email [0.0.0.0]); Wed, 27 Sep 2023 05:27:18 -0700 (PDT)
X-Spam-Level: *

The NXP's i.MX EdgeLock Enclave, a HW IP creating an embedded
secure enclave within the SoC boundary to enable features like
- HSM
- SHE
- V2X

Communicates via message unit with linux kernel. This driver
is 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 can communicate on 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>
---
 .../bindings/firmware/fsl,imx-se-fw.yaml      | 73 +++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/firmware/fsl,imx-se-fw.yaml

diff --git a/Documentation/devicetree/bindings/firmware/fsl,imx-se-fw.yaml b/Documentation/devicetree/bindings/firmware/fsl,imx-se-fw.yaml
new file mode 100644
index 000000000000..d250794432b3
--- /dev/null
+++ b/Documentation/devicetree/bindings/firmware/fsl,imx-se-fw.yaml
@@ -0,0 +1,73 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/firmware/fsl,imx-se-fw.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP i.MX EdgeLock Enclave Firmware (ELEFW)
+
+maintainers:
+  - Pankaj Gupta <pankaj.gupta@nxp.com>
+
+description:
+  The NXP's i.MX EdgeLock Enclave, a HW IP creating an embedded
+  secure enclave within the SoC boundary to enable features like
+  - HSM
+  - SHE
+  - V2X
+
+  It uses message unit to communicate and coordinate to pass messages
+  (e.g., data,  status and control) through its interfaces.
+
+properties:
+  compatible:
+    enum:
+      - fsl,imx8ulp-se-fw
+      - fsl,imx93-se-fw
+
+  mboxes:
+    description:
+      All MU channels must be within the same MU instance. Cross instances are
+      not allowed. Users need to ensure that used MU instance does not conflict
+      with other execution environments.
+    items:
+      - description: TX0 MU channel
+      - description: RX0 MU channel
+
+  mbox-names:
+    items:
+      - const: tx
+      - const: rx
+
+  fsl,mu-id:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      Identifier to the message-unit among the multiple message-unit that exists on SoC.
+      Per message-unit, multiple misc-devices are created, that are  used by userspace
+      application as logical-waiter and logical-receiver.
+
+  memory-region:
+    items:
+      - description: Reserved memory region that can be accessed by firmware. Used for
+          exchanging the buffers between driver and firmware.
+
+  fsl,sram:
+    description: Phandle to the device SRAM
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+
+required:
+  - compatible
+  - mboxes
+  - mbox-names
+  - fsl,mu-id
+
+additionalProperties: false
+
+examples:
+  - |
+    ele_fw: se-fw {
+      compatible = "fsl,imx8ulp-se-fw";
+      mbox-names = "tx", "rx";
+      mboxes = <&s4muap 0 0>, <&s4muap 1 0>;
+      fsl,mu-id = <2>;
+    };
-- 
2.34.1