Received-SPF: pass (google.com: domain of linux-kernel+bounces-187362-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
From: Pankaj Gupta <pankaj.gupta@nxp.com>
Subject: [PATCH v2 0/5] Communication Interface to NXP secure-enclave HW IP
 like Edgelock Enclave
Date: Thu, 23 May 2024 16:19:31 +0530
Message-Id: <20240523-imx-se-if-v2-0-5a6fd189a539@nxp.com>
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
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?ZHE2MmpZaElxUGJMU3FqTk1DVnBieGtIeUNJckJzeHpyclo0NWlVZ0VxT2lP?=
 =?utf-8?B?SUZxTG9LVCtST1kwVWVXb1RTUjV4YktMLzlGakI5cW81L1lHa0MxLzJkampF?=
 =?utf-8?B?ZGl5RHdrUTRjWHhjZEdoSzY2TE82aFRLaHpFU3FkZkhuWllrZjZFNlFjL3U1?=
 =?utf-8?B?OUJhaWJwM3RhQTY0RU5QS3IxNmtCZXRsbUpOU0Y0OFR5ZllXRlQxejl6amFt?=
 =?utf-8?B?TWUyMkdvWW9haVRBdm5PK3h2M0UzdjJMNWVTSWVXc1NRRWVKeTlLOVdUTndV?=
 =?utf-8?B?VnNhbHpDU3dGbjNVK1ZXU0RwNEJ3RURaUEk3VEJVOHVncVFmb0R6eFZRNWF5?=
 =?utf-8?B?QitaQXVpWUhSQXNNNXQwRnRUOVB1TkcxK0hlTmRYekpFQVU4UVFPR051SFlp?=
 =?utf-8?B?Z0o5NW1YQlp0VE9mRVZ5aXpiWHNWdFBsaDFNcStjNlVVV0xhUzJRUVZNQWRv?=
 =?utf-8?B?elhJeHJraE1jaUtrZjRRYThQc3hqWUdFTCtFUTdGSGZIZjdYL2U1UjZoVXQz?=
 =?utf-8?B?NTYydWh1UnpqcklIRlFDbGpRbTNDV0JiUUd2alNJMERUU2lZZDc4OXRNbUVj?=
 =?utf-8?B?TVowQlJQUzJSNlhpR1hES1gvTHNvd2FIUlRLa2JKYzhwNWgzM0FMZlh6UElx?=
 =?utf-8?B?QTcvNm9XRjI3NmFSNlR5NHFwYndIOUk0cUNvV3g1Zm1DLy9tYzRpZGZyYXA3?=
 =?utf-8?B?cHN3djFvL3dsNDUyN2NlbXdtTDJwVW00WS96SktpUXI4cERSY1hPcmxJbFE0?=
 =?utf-8?B?ZUNGbHMvRW51SE5ScHBPbEx3OXYyNEExclpEdHFqK3ZmcFF0Y2hUaUt4MnZV?=
 =?utf-8?B?eW8yRVFtUmx2UzhzMW1tNDNmNGdub3hFSEUxV0NoVWMzOXBMaHpiUk1ieW8w?=
 =?utf-8?B?SlpyZU5XTkRBRW9CMlFHLy84V2VvTUh4cGRGOTR2bldQUUtoWHk1VCtVQkhU?=
 =?utf-8?B?YzlVNjZLR25JR2wyTTljZVVycE5nbjBITjNFeG1kclJuWnZuNHloKzBqSXJO?=
 =?utf-8?B?MFJxd1REbzRnNG1YdDAwZEIyMTFET0E2d0E1Wnl5bXQ4Unc1ZlF3YjEzeXM1?=
 =?utf-8?B?T29ZVU50M2l0WXY1Qjlsbkp2WnBsblJzWm1xNmNOc0ZQVCt6N2hjY0tPTmpp?=
 =?utf-8?B?ajhqRGZzdUJIUnNoS3lZYkluTkg1ZW0vTlZmUGovMWoxS2VnalVyZGJnU29Z?=
 =?utf-8?B?RWErQVRYU1I3d081bThRR0V4T3hIQ2xHUEQxTk5xaGxLbnl0ME9pVW0vQzJn?=
 =?utf-8?B?cFdJK3ZocGV3cXpTK0JZTHpncFcyMHQzekNGTzI4Ymd3UTY4cVdaY1FKNDMw?=
 =?utf-8?B?Wm1IMktCaWtaT25HbndQMUk1WUoreWhVOGlteGlZUk1YZnovT21vRVA4OTZ5?=
 =?utf-8?B?RXdqbjhSZ21USHNqSHF2TWxBTW5PNk1jVkR6Y1hCQXZDYWQ3eHIrUE9oL1Ru?=
 =?utf-8?B?dFBiVDdWSUZRNW5RTHBBRTBMMlVTWk1WTEYzNnc5R3BxNXVEcHZIeHF5U0dp?=
 =?utf-8?B?SDBMUVlmMVE0K3ZNZGRBSWRFZ3ozMERTVE1nVHJQS3FqMHFtV1hQa3hoSmFP?=
 =?utf-8?B?Z0RwdGNOdzRHekxnSlhqWkRVNisrQ2t3Tm5pZHNhQW5MTlZXSWRtNlBKWXhX?=
 =?utf-8?B?a0Ura0NmQ1A5NGdMQmtVM2VwQkF5bGxHNHFiS09FL0JQaWFrQjljY0tWM2dB?=
 =?utf-8?B?WWY3WmtOV0FMNzkyVk1iWjdnRG1zRHBpdkNYU3dRYVQ2cHVxYWVYSDJNT0VU?=
 =?utf-8?B?NnNpYlUzdEV4a04rbWF4MENtRUsvd0hSdkdMZEUrOEdVT3ZNbDZ3cGRjV0JY?=
 =?utf-8?B?aGQwQUlXUlFpMFZoUjVGeEVqbEczT09HV2dkOEsvVkVESm9makhjcGlnaDlK?=
 =?utf-8?B?ejBKYjFWeGpuWk1Wa1k2TXJhTVR4ellFOUtYa0YyNDhKYk45K0hycmZaaCti?=
 =?utf-8?B?L04wTm1hS2xxRzQ2YWtaNmh2UThkZUpTOUZGOHZoM1VMdTVhQnNaQWZ2ZXND?=
 =?utf-8?B?bytJTmdCck9OQ2phY0JPWUVtbm1rV1N3dUdXa2p2Nk5EckJjYXZqQUVJUmpj?=
 =?utf-8?B?QTdveVBYQVl5SGlHc0FyQ20yaWRhMVZVVjc3em9qOWh0UFFvdm9WYS9Ebndk?=
 =?utf-8?Q?OuH2RctqDfWdKSDRZ+y4M7Mr3?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 77380095-8989-4b8a-d218-08dc7b166e4c
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:25.2063
 (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: IOaKRTl52q+dU7kbCG0xTpMFRwkup3b1g/lMDul35hbtHmPb/ifBLm3W3CMgAMXDTSHetGiTXZAcsX7JUfZw8g==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PAXPR04MB9571

Hardware interface of the NXP Secure Enclave  HW IP(s) like EdgeLock Enclave,
V2X, SHE etc, is based on the Messaging Unit module that enables processing
elements like ARMv8 core, RISC V core, within the SoC to communicate and
coordinate by passing messages (e.g., data, status and control) through 
these interfaces.

The NXP i.MX secure enclaves hardware interface kernel driver, is specifically
targeted for use between application core and NXP secure-enclave(s) HW. It allows
to send/receive messages to/from the secure-enclave.

Patch-set adds the kernel driver for communication interface to secure-enclave,
for exchanging messages with NXP secure enclave HW IP(s) like EdgeLock Enclave,
both from:
- User-Space Applications via character driver.
- Kernel-space, used by kernel management layers like DM-Crypt.

To: Jonathan Corbet <corbet@lwn.net>
To: Rob Herring <robh+dt@kernel.org>
To: Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
To: Conor Dooley <conor+dt@kernel.org>
To: Shawn Guo <shawnguo@kernel.org>
To: Sascha Hauer <s.hauer@pengutronix.de>
To: Pengutronix Kernel Team <kernel@pengutronix.de>
To: Fabio Estevam <festevam@gmail.com>
To: Rob Herring <robh@kernel.org>
To: Krzysztof Kozlowski <krzk+dt@kernel.org>
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Cc: devicetree@vger.kernel.org
Cc: imx@lists.linux.dev
Cc: linux-arm-kernel@lists.infradead.org
Signed-off-by: Pankaj Gupta <pankaj.gupta@nxp.com>

Changes in v2:

4/4
- Split this patch into two: 1. base driver & 2. Miscdev
- Initialize the return variable "err" as 0, before calling 'return err', in the file ele_common.c
- Fix the usage of un-iniitialized pointer variable, by initializing them with NULL, in ele_base_msg.c.
- Fix initializing the ret variable, to return the correct error code in case of issue.
- replaced dmam_alloc_coherent with dma_alloc_coherent.
- Replace the use of ELE_GET_INFO_READ_SZ, with sizeof(soc_info).
- Replaced -1 with -EPERM
- Removed the safety check on func-input param, in ele_get_info().
- fix the assigning data[1] with lower 32 address, rather than zero, for ele_fw_authenticate API.
- Correctly initializing the function's return error code, for file  ele_base_msg.c.
- replaced 'return' with 'goto'.
- Use length in bytes.
- Corrected the structure se_msg_hdr.
- Moved setting of rx_msg  to priv, into the function imx_ele_msg_send_rcv
- Will add lockdep_assert_held, to receive path, in v2.
- corrected the spacing at "ret  = validate_rsp_hdr"
- FIELD_GET() used for RES_STATUS
- Re-write the structure soc_info, matching the information provided in response to this api.
- The "|" goes to the end of the previous line. 
- Moved the locking and unlocking of the command lock to the caller of the function.
- removed the safety check for device private data.
- Structure memory reference, used to read message header.
- In the interrupt call back function, remove assigning waiting_rsp_dev to NULL, in case of response message rcv from FW.
- do while removed.
- replaced BIT(1) for RESERVED_DMA_POOL, to BIT(0)
- The backslash is removed while assigning the file name with absolute path to structure variable.fw_name_in_rfs =.
- Update the 'if' condition by removing "idx < 0".
- mbox_request_channel_byname() uses a "char" for the name not a u8. Corrected.
- devm managed resources, are not cleaned now, in function se_probe_if_cleanup
- Used dev_err_probe().
- Used %pe to print error string.
- remove "__maybe_unused" for "struct platform_device *enum_plat_dev __maybe_unused;"
- used FIELD_GET(), for  RES_STATUS. Removed the use of MSG_TAG, MSG_COMMAND, MSG_SIZE, MSG_VER.
- Depricated the used of member of struct se_if_priv, bool no_dev_ctx_used;
- Moved the text explaing the synchronization logic via mutexes, from patch 1/4 to se_ctrl.h.
- removed the type casting of info_list = (struct imx_se_node_info_list *) device_get_match_data(dev->parent);
- Used static variable priv->soc_rev in the se_ctrl.c, replaced the following condition: if (info_list->soc_rev) to if (priv->soc_rev) for checking if this flow is already executed or not.
- imx_fetch_soc_info will return failure if the get_info function fails.
- Removed devm_free from imx_fetch_soc_info too.

3/3
- Made changes to move all the properties to parent node, without any child node.

2/4
- Use Hex pattern string.
- Move the properties to parent node, with no child node.
- Add i.MX95-ele to compatible nodes to fix the warning "/example-2/v2x: failed to match any schema with compatible: ['fsl,imx95-v2x']"

1/1
- Corrected the spelling from creats to creates.
- drop the braces around the plural 's' for interfaces
- written se in upper case SE.
- Replace "multiple message(s)" with messages.
- Removed too much details about locks.

Testing
- make CHECK_DTBS=y freescale/imx8ulp-evk.dtb;
- make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- -j8  dt_binding_check DT_SCHEMA_FILES=fsl,imx-se.yaml
- make C=1 CHECK=scripts/coccicheck drivers/firmware/imx/*.* W=1 > r.txt
- ./scripts/checkpatch.pl --git <>..HEAD
- Tested the Image and .dtb, on the i.MX8ULP.

Reference
- Link to v1: https://lore.kernel.org/r/20240510-imx-se-if-v1-0-27c5a674916d@nxp.com

---
Pankaj Gupta (5):
      Documentation/firmware: add imx/se to other_interfaces
      dt-bindings: arm: fsl: add imx-se-fw binding doc
      arm64: dts: imx8ulp-evk: add nxp secure enclave firmware
      firmware: imx: add driver for NXP EdgeLock Enclave
      firmware: imx: adds miscdev

 Documentation/ABI/testing/se-cdev                  |   42 +
 .../devicetree/bindings/firmware/fsl,imx-se.yaml   |  154 +++
 .../driver-api/firmware/other_interfaces.rst       |  119 ++
 arch/arm64/boot/dts/freescale/imx8ulp-evk.dts      |   17 +-
 arch/arm64/boot/dts/freescale/imx8ulp.dtsi         |   14 +-
 drivers/firmware/imx/Kconfig                       |   12 +
 drivers/firmware/imx/Makefile                      |    2 +
 drivers/firmware/imx/ele_base_msg.c                |  286 +++++
 drivers/firmware/imx/ele_base_msg.h                |   92 ++
 drivers/firmware/imx/ele_common.c                  |  343 ++++++
 drivers/firmware/imx/ele_common.h                  |   46 +
 drivers/firmware/imx/se_ctrl.c                     | 1220 ++++++++++++++++++++
 drivers/firmware/imx/se_ctrl.h                     |  145 +++
 include/linux/firmware/imx/se_api.h                |   14 +
 include/uapi/linux/se_ioctl.h                      |   88 ++
 15 files changed, 2591 insertions(+), 3 deletions(-)
---
base-commit: b63ff26648537a5600cf79bd62f916792c53e015
change-id: 20240507-imx-se-if-a40055093dc6

Best regards,
-- 
Pankaj Gupta <pankaj.gupta@nxp.com>