From patchwork Wed Oct 16 16:18:57 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Pankaj Gupta X-Patchwork-Id: 13838638 Received: from EUR05-DB8-obe.outbound.protection.outlook.com (mail-db8eur05on2044.outbound.protection.outlook.com [40.107.20.44]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id F3EC61DAC9C for ; Wed, 16 Oct 2024 16:23:25 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=fail smtp.client-ip=40.107.20.44 ARC-Seal: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1729095809; cv=fail; b=d/Kpk+Ql98m8JlAtYqaVcagLl5WpPNvNbcMVkb1fTQU18U3A2IV0fW1hqHMGRMu3jVXxc1yfivEh6Ku5NKVlQ4rNSPnu/Qf19gH8zX7BHQ75uChK/zQTFlO1aDZj07OpWvtHPE97ajQbRXCcz8H5aB3liCFqFUtmehcpdY9CNtU= ARC-Message-Signature: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1729095809; c=relaxed/simple; bh=+dpiySDz8vsFXVv0IQq3AL4vjQRI9ghq2INCCWn3234=; h=From:Subject:Date:Message-Id:Content-Type:To:Cc:MIME-Version; b=MNF9VgI7+0TOqFQJDVq6ssULC7syn2ZsuA4exwyP6BtfoqrB6cXxYKVvHhjDGZA2lV2xPFaFYfKfKvAnPoW0Mj2MvXVO6vMK30N6EMfO+sf/JTabE/XDzpomfuCchcG4GVrLj1ef7o6jBi9Ra8ln1qqmQaN9CPCr3FHBbFeV1GM= ARC-Authentication-Results: i=2; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=nxp.com; spf=pass smtp.mailfrom=nxp.com; dkim=pass (2048-bit key) header.d=nxp.com header.i=@nxp.com header.b=domwBhOO; arc=fail smtp.client-ip=40.107.20.44 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=nxp.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=nxp.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=nxp.com header.i=@nxp.com header.b="domwBhOO" ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=DkknVPsCQLZg9v0VGXox85guwY8b+Z06CZyTuS88TZKBJ563t027q4XhicJP+8z0Kzh2Vx6aYN8anVJQCRf7WU/9TenjQBgQ2xXUdqlByDsy1ovGPzb/Azwj7Ia9mkycNC5OpownlcRNGzG9G7fBB3dwYcPvfmqgCkaJKwCyXg09NNSNUucaiyjZ2wYqUh205S0tPipdodaUJ6SVI5GH24VxqokmuTnls1yYjOK/4q93U0tnQEcezzQ4/6fOULxD+cuIGItnmXMedycL+Ox4uhLknQeChHuVF04QVTFZip+y0DiRfMXWw/hYI1Iiy0bi6zxZQorim5IyYg/7xlbVhA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=30um4cK80ybjAYbvEgl6yVrxzP11FlGtfBIwNz16t4c=; b=OuMnrkBn4j44AEFDCkGgyouHsJkHBslm1JrCOZR2UPqpWo7rmLWLopGOpEKilx6nR0WDQkjv+Wo2699wWJUiYX+XB3zajupS82+PoOSaMDgQfbpXvpzk9mMj2+IcliJ95vkcA1HSR4RKctOg7/6TLgjmxpgkFe96sJADnPNUbdU+42Q7s9vMYpkHl6thJqZNHViZGGkPd0V1PQr70bE9Y3zOiwyiC53PmX9DGRlS/VmWzi5473FlqoVJxSNwo8nfkyIX6WmJn8+QvuEYW+FIMnml0kzsBHyw5my5XdDXfsVUOn0sc6xGUBsHYSZp5lzUJafjsQAMIvXdao5Hm7pbhw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=nxp.com; dmarc=pass action=none header.from=nxp.com; dkim=pass header.d=nxp.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nxp.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=30um4cK80ybjAYbvEgl6yVrxzP11FlGtfBIwNz16t4c=; b=domwBhOO+x0qQWlJZVguKjiWae49WoBZAlyQ6jpvvqfOf7S48lQ9SVFCNuvFppbHJuVTX4R2pB1VOP6wc0MveOa0NrvXBUqGC7VBZ1dkgXQSrpF3tQVGHUp6NoCmoFMsD3aX9GpO/x8DWwKvyaEIH9v7eILedlGHfBoB35EhLmiJfguyoSh8M0j8QJ3Dt3mQH+4vnCVovUHXd0zQAGZmKV8YCTze7ZMyLPaWazoddpktsX2wQhkzjR1CZEWLEa75KFPqeVb5zzf4wydUctWYep4u2Ky6PlEAMHs/fFtxi2wXZLA4s1N00WzWXdB8LGwkUfwWI/sk9KXQ89ZWYLBc5Q== Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=nxp.com; Received: from DU2PR04MB8599.eurprd04.prod.outlook.com (2603:10a6:10:2da::7) by AM0PR04MB7043.eurprd04.prod.outlook.com (2603:10a6:208:19b::20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8048.27; Wed, 16 Oct 2024 16:23:22 +0000 Received: from DU2PR04MB8599.eurprd04.prod.outlook.com ([fe80::763:eb3b:6607:1e72]) by DU2PR04MB8599.eurprd04.prod.outlook.com ([fe80::763:eb3b:6607:1e72%5]) with mapi id 15.20.8069.016; Wed, 16 Oct 2024 16:23:22 +0000 From: Pankaj Gupta Subject: [PATCH v9 0/5] v9: firmware: imx: driver for NXP secure-enclave Date: Wed, 16 Oct 2024 21:48:57 +0530 Message-Id: <20241016-imx-se-if-v9-0-fd8fa0c04eab@nxp.com> X-B4-Tracking: v=1; b=H4sIAHHnD2cC/13QzU7DMAwH8FeZcibIdr458R6IQ9akLId1U4uqo qnvjlshmuxoK7+/7TzElMeSJ/F2eogxz2Uqt4GL8HIS3SUOX1mWxLUgIA0GnCzXRU7c7WXUAMZ AUKmzgt/fx9yXZc/6+OT6Uqbv2/izR8+4df9SEKqUGSVIcp2J1umANr0Py/21u13FljFT5UjVj tgx6hP6EI0KrVOHs1hvPSt20SXyKUfT6dg6fTgHpnZ6m0cJADL6iE97msoh1c6wsza6EEBF76h 1tnLUOMsuZ7Jszp6e93SHC6Br5/Z/6RPFs9Nkdev8v0PA5j7PLqDRyvNQl9Th1nX9BdWq1a0oA gAA To: Jonathan Corbet , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Shawn Guo , Sascha Hauer , Pengutronix Kernel Team , Fabio Estevam , Pankaj Gupta 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, Conor Dooley X-Mailer: b4 0.13.0 X-Developer-Signature: v=1; a=ed25519-sha256; t=1729095547; l=19552; i=pankaj.gupta@nxp.com; s=20240523; h=from:subject:message-id; bh=+dpiySDz8vsFXVv0IQq3AL4vjQRI9ghq2INCCWn3234=; b=r+UMdcaMmWCCR5iEK2XqSaQzheRbvJVozmIAeZ88MH9t3dRpUHl8A+7TwyVWN+zFfqfIZfEiK zCTYMP2PwR6AYyfSy6ijlfaRkh5eB6WlMRelMX5LnGeVVYNB+PMBKPQ X-Developer-Key: i=pankaj.gupta@nxp.com; a=ed25519; pk=OA0pBQoupy5lV0XfKzD8B0OOBVB6tpAoIf+0x1bYGRg= X-ClientProxiedBy: SG2PR02CA0037.apcprd02.prod.outlook.com (2603:1096:3:18::25) To DU2PR04MB8599.eurprd04.prod.outlook.com (2603:10a6:10:2da::7) Precedence: bulk X-Mailing-List: imx@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DU2PR04MB8599:EE_|AM0PR04MB7043:EE_ X-MS-Office365-Filtering-Correlation-Id: 5dc06512-4217-4391-4e0c-08dcedfeda86 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0;ARA:13230040|1800799024|7416014|376014|366016|52116014|38350700014; X-Microsoft-Antispam-Message-Info: =?utf-8?q?fw7CH/OJlUUxXRG/DTpjXFvogT7m1s6?= =?utf-8?q?dRO4Sd8riWrCk+FtfVQaEgcE8kJiFEunXEwRZ/1UJXadPeD3eu17tTxY5puRX6HgA?= =?utf-8?q?LqvjNbuT9s648bywvyKsIcCArTIsc2wPWUD5AKnOeJpNJWgs1NusxbO17qNqP23sb?= =?utf-8?q?un4eLRYISwbxY2gy3jsrdUZFjtbzHBx643atZDhaDvGwP/TQEYr7Xmtdqs2CcUldT?= =?utf-8?q?SNMNW9ND5OO6PaSfwlxT67YT29m9qwzZdd34nlMYnWexReeJbf1Sx47PNHjp6XFUY?= =?utf-8?q?0qg92CgBFJFGd3Qu0UeaHMIqQbxeR0DmHabEBrKjH/3mPS7Od3B9zj1kWTXMJd5fg?= =?utf-8?q?VUgmRsd6xOyjPuvEgY6bgAwrS7i5lOaCvhEdvIKhRlR9yVM8R85rpRYY/n4bEdJwB?= =?utf-8?q?29Jg+10p41aKUeJXZlJAKFnjclHnfniMk8Q/1v34Ica0wwkXjzPr1lggJnO7cS43A?= =?utf-8?q?LESM30uc7iM3WGdmjDKOIrZaOYOHxtoTBDpn1uWL4stfM4pkaiGOIBx7HZI8vZm+o?= =?utf-8?q?xDjkgFRZ4zS76G5WfYbp9BPs7KTu6m/wJyp/PKB1RkpqFmDr+qNjllIFrT2M16Vyg?= =?utf-8?q?eMjwuqKKWlL5GTox9imDOWL7RysGGXlSHBl7+hTO94n9m4yCcg/seD6MWMBE4KWti?= =?utf-8?q?hlaaxaejXFBji16iguT2MRi2Smm2r/czXJxP/Fx/0u7XDBng/cnH7B3qt0E8DIAqj?= =?utf-8?q?TRwbc7wV24pco4nym8yDI3BrjGgccTg0+5Cn7Q3uNzKLULLXKsRYj66uj1kbtPtac?= =?utf-8?q?Xl49YaDDRhjhhfSOXhfxpXRM2HsAk1TBcTSzbbq6F5LFNQdyjlqMd/0JLZMcFg6ML?= =?utf-8?q?QNGzGncXr9x+2V8U9A4eXcNIJvvMNfmLIyiU5MMCU0FP+Nfq8QjD4t9TshndQ2LWB?= =?utf-8?q?fZuSGZWWm2rBaIxTJ6zbrMxPPBWEauDYXpKe1PYOGR0wPsUX+DxXVN99I5XTPebDO?= =?utf-8?q?1RMuexvYhVlhewYK6BVW4penkwn6xpuWlIt+0ntBOMK5Tw45M8ukJRoJ1awuzKHAP?= =?utf-8?q?+HXcukrcwOEQG2JO2+8QborvFUlvlPx12MIQi/cakyAS9g0zUDU81Nr0Jaif82EoY?= =?utf-8?q?8Kj3Bnqu1djx13TLEX4sWa9XwzOx2smMtGDgxqtdWEMEv5qu/MLSBSQPJMKg/Jjfu?= =?utf-8?q?mXHsDFWsBefca2ZhcZsNij5jUjk/9FywxnaSaa4iI25JA0MIEqfkS5Sm8bn044rGk?= =?utf-8?q?MicIcCPwA1EPIkLe9zQeCjpR92gOR26NZ7bNTqS6oYz45T/9O62Ptg+Iuq7PzHX72?= =?utf-8?q?ft6AII2esakNU0tt8XKMN9NDHm4vKxxz98A=3D=3D?= X-Forefront-Antispam-Report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:DU2PR04MB8599.eurprd04.prod.outlook.com;PTR:;CAT:NONE;SFS:(13230040)(1800799024)(7416014)(376014)(366016)(52116014)(38350700014);DIR:OUT;SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?q?C56oGx2eqEt0J8KSlwHjtn+tk2r8?= =?utf-8?q?kxQKgEbJ/5O3FYewhy4u3YBvXjXMDaDatQSDe9dXQahNKNToWYWz0NUg55Izh4Rw0?= =?utf-8?q?CGQlr87cGsOBHczkXjWTk/z3M8iGWfrWLWKVNWocyOG6IPgZXJHR6uXJxJT6yS/5i?= =?utf-8?q?XX0QvItt/t/ng8eXBttw9a8Y8J9z+NrGGnkCh6T6+Hd2ZRDeQJdpeRT96O67s8Lkt?= =?utf-8?q?/btpES9sBfJLd/NvjiAa3+0ymPTmqrULgk2MtUGtT3KugJgc0nc7AlukjsL1p2dia?= =?utf-8?q?olVfydz8o5pzxcO1YsjZoAFrfWDnbc53q+I4Bp7QGr9htDhiY09iYvN4/B5CVO+XN?= =?utf-8?q?X/jijS+Kqtlz7BD28qikFNP5wolcuQUI4vcECdinMFZUb1lzlj6QsPl1WwSjSmfQK?= =?utf-8?q?u2teydX6dsKiX6Mo9Alg7DGWbw+ZMWLR435WYEbzBHLosRfTDMht3ecMFE4N5vknV?= =?utf-8?q?BQo3vFoGhsfvf3dXm0WvFWMBEqDJOU1KinoNtxhFQiQ1RGOlWwmA6xUOos0hszyUb?= =?utf-8?q?JylGbDJ64hBjrkgCLYb894VSnYy77BP8XHfT3mt09hxGbq/MQiLTdCGFk1CvCroEe?= =?utf-8?q?5LSozGU54DoZzhP7kIsMjh1nb3gfZf3BvXGN24UvDZOHI9k2npR2uH30g96ePMbGa?= =?utf-8?q?ZtCj6+LXQf1Lg8EAQQ5L2XnPcpJdfvX9euOUM0vujEynuDncpCGwxdp3nAv9lLgTy?= =?utf-8?q?xqZ6w8A8D1ADwsBcqXxql0yZsmxv411KFPpHezaylk/N8nMIj/+4gmcqyVI+qI940?= =?utf-8?q?G6RPzHg56DEXAP05TtFuU3FQBWXOZudi0Q6UaswgVGEB/nCXP+0oYMaTBdN2rDw5x?= =?utf-8?q?AXyzvm3fu0waAk2rfnSnDl6jcaSc9wMxbmHTzlMEXgJLil0DbX2mbmk6szIdn2Fl4?= =?utf-8?q?Hw/aS8CD56PzJJufiPFKdPOPxbGuXPgz0GnD6xdcTbNPFNepv8U/1UsT80td11Ua1?= =?utf-8?q?WKYS3PBW+RIZ/OZ6MV3EExzc8uUepIAJBHhNr/ETGCKQoth6PpZIoSAIAurOPX/hS?= =?utf-8?q?NMkbwGKTcLbDYXd6w/P6wIdozknvN8MhEC5F730w9r0pbzO+K8eV7ZyOfiD6ENSGb?= =?utf-8?q?Kk+ymHrJDdL23oAEc63YZ+sl9f9PZbszcOjZfvrQlze6xWvPlaNGwHVS/7L+33EAq?= =?utf-8?q?jxnoETtSwFDcvlc3fFAjmeVaetd3BOkPGKat1V6GZY3zbm7TuRntR2z/gdpgZZyNH?= =?utf-8?q?MoRau6CclhIeIKMVSQaQ1wvANg9UvDvh78zJSWSNtJMm2LwAuDAxgR/pZKEpF5ggv?= =?utf-8?q?f3Bqtb7+cEEVLdy2Sgs6nSP/ly1wsEveOoGPvn6T5LS4kbKJBwC9QGe98ok7c5ZN0?= =?utf-8?q?GYEpRjQ2xqudykjM4OQSFM1MSmyB7lDRqZI1gIqDnc8RQjhcUZCdmRve1cW1jlYty?= =?utf-8?q?vxV71MSKV8pRE0CEwryx1YLtMb98bRuT3efYVNMpmrSO0vyiiHx/MI6gBeVE80si1?= =?utf-8?q?fDdPQ0vY7IX84M+1liVS8uGBpWfAZi3gMQHXROZcLGuPn2JGlVwtFTgnguFsZbsdb?= =?utf-8?q?aQKaBupcDiDl?= X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: 5dc06512-4217-4391-4e0c-08dcedfeda86 X-MS-Exchange-CrossTenant-AuthSource: DU2PR04MB8599.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 16 Oct 2024 16:23:22.7916 (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: AMiCEIkEDxURSpOsDynWdSVKuRmjJKf1LFYLCZEMw1/8w/qlVPRqBr0S9oAqW3F7iAf2uYzYgi4qxNoef7+eWA== X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM0PR04MB7043 4/5 - change se_if_remove function signature, required after rebase to v6.12-rc1. - move the info->macros to a structure "struct se_if_defines if_defs". - Removed "info" from "struct se_if_defines if_defs". - Moved "mem_pool" from "struct se_if_defines if_defs" to "priv". - Fetching "info" using container-of. 5/5 - Fetching "info" using container-of. - Fixed issue reported by sparse. Reference: - Link to v8: https://lore.kernel.org/r/20241015-imx-se-if-v8-0-915438e267d3@nxp.com Changes in v8: 5/5 - Remove the check for SE_IF_CTX_OPENED. - replaced dev_ctx->priv-dev, priv->dev, whereever possible. - func "if_misc_deregister" moved before func "init_device_context". - func "init_device_context" before func "se_ioctl_cmd_snd_rcv_rsp_handler". - func "se_if_fops_write" and "se_if_fops_read", are moved after func "se_ioctl_get_mu_info". - non static functions "se_dev_ctx_cpy_out_data, se_dev_ctx_shared_mem_cleanup & init_device_context" are moved static and local scope. - Removed back & forth between the two structs "struct se_if_device_ctx *dev_ctx" and "struct se_shared_mem_mgmt_info *se_shared_mem_mgmt" - removed the NULL check for bdesc. - fops_open, is corrected for acquiring the fops_lock. - Fops_close, mutex unlock is removed. Infact check for waiting_rsp_clbk_hdl.dev_ctx, is removed. - sema_init(&dev_ctx->fops_lock, 1);, replaced with Mutex. - structure member se_notify, is removed. 4/5 - removed initializing err to zero in func ele_fetch_soc_info(), - replaced 'return 0', with 'goto exit', if the condition (!priv->mem_pool) is true. - replaced "struct *dev" with "struct se_if_priv *priv", in base_message API(s) and others. - Created a separate structure "struct se_if_defines" to maintain interface's fixed values like cmd_tag, rsp_tag, success_tag etc. - removed the macros "WORD_SZ", "SOC_VER_MASK", "DEFAULT_IMX_SOC_VER", "RESERVED_DMA_POOL". - Added handling for "ctrl+c", by postponing the interrupt, till the response to the "command in flight" is received. - Removed the mutext lock "se_if_lock". - furnction prototype for "se_save_imem_state" and "se_restore_imem_state", is changed to pass "imem" by reference. - Added a new structure "struct se_fw_load_info", dedicated to contain FW loading relevant info. It is a member of struct info_list. - split "imem_mgmt_file_in_rfs" into two "prim_fw_nm_in_rfs" and "seco_fw_nm_in_rfs", to be part of "struct se_fw_load_info". - moved the function "se_load_firmware" prior to func "if_mbox_free_channel". - function "se_load_firmware" is updated to use "request_firmware", instead of "request_firmware_no_wait". - function "se_load_firmware" is updated to load "primary" fw image, if the imem_state is not BAD. Then load the "secondary FW" image. - Added a new mutex_lock in the function "se_load_firmware", for ensuring FW loading done once, when there are multiple application are in play. - instead of "wait_queue_head_t wq", used "sruct completion". - add devm_add_action with action as se_if_probe_cleanup. Reference: - Link to v7: https://lore.kernel.org/r/20240904-imx-se-if-v7-0-5afd2ab74264@nxp.com Changes in v7: 5/5 - struct se_clbk_handle, is added with a member struct se_if_device_ctx *dev_ctx. - func call to ele_miscdev_msg_rcv() & ele_miscdev_msg_send(), are removed. - func se_ioctl_cmd_snd_rcv_rsp_handler(), is modified to remove the func call to ele_miscdev_msg_rcv() & ele_miscdev_msg_send() - func se_ioctl_cmd_snd_rcv_rsp_handler is callig func ele_msg_send_rcv(), instead. - Mutext "se_cmd_if_lock", handling is removed from this patch. - func ele_miscdev_msg_send() is replaced with func ele_msg_send(), in fops_write. - func ele_miscdev_msg_rcv() is replaced with func ele_msg_rcv(), in fops_read. - fops_open is modified to create the new dev_ctx instance (using func init_device_context()), which is not registered as miscdev. - Only one dev_ctx is registered as miscdev and its reference is stored in the struct se_if_priv, as priv_dev_ctx. - Separate func cleanup_se_shared_mem() & func init_se_shared_mem(), for shared memory handling part of struct dev_ctx. - Input param for func(s) ele_msg_rcv(), ele_msg_send() & ele_msg_send_rcv(), is replaced from struct se_if_priv to struct se_if_device_ctx. 4/5 - A new structure is defined name struct "se_clbk_handle", to contain members processed in mailbox call-back function. - "struct se_if_priv" is modified to contain the two structures of "se_clbk_handle" - waiting_rsp_clbk_hdl & cmd_receiver_clbk_hdl. - func ele_msg_rcv() is modified to take a new additional input reference param "struct se_clbk_handle *se_clbk_hdl". - func ele_msg_send() is modified to take a new additional input tx_msg_sz. - func ele_msg_send_rcv(), is modified to take 2 more inputs - tx_msg_sz & exp_rx_msg_sz. - func se_val_rsp_hdr_n_status(), is modified to take input of rx_msg buffer, instead of header value, as input param. - each caller of the func ele_msg_send_rcv(), is sending these two additional input params. - func se_if_callback(), is modified to work on two structures of "se_clbk_handle" - waiting_rsp_clbk_hdl & cmd_receiver_clbk_hdl. - Variable "max_dev_ctx", is removed from info & priv struture, as well its usage. - New member variable "se_img_file_to_load", is added to structure "priv". - Other member variables - rx_msg(ptr), rx_msg_sz, completion done & list of dev_ctxs, is removed from priv struture, along with their usage. - func se_resume(), updated to wakeup the two "wq", part of "struct se_clbk_handle": priv->waiting_rsp_clbk_hdl & priv->cmd_receiver_clbk_hdl. 3/5 - Node name is changed from senclave-firmware@0 to "secure-enclave" 2/5 - Node name is changed to "secure-enclave". Reference: - Link to v6: https://lore.kernel.org/r/20240722-imx-se-if-v6-0-ee26a87b824a@nxp.com Changes in v6: 5/5 - replaced scope_gaurd with gaurd. 4/5 - replaced scope_gaurd with gaurd. - remove reading the regs property from dtb. - Added NULL check for priv data fetched from device, as a sanity check, for ele_base_msg apis) 3/5 - replace firmware with senclave-firmware. 2/5 - replace firmware with senclave-firmware. - drop description for mbox - Replaced "items:" with maxItems:1 for "memory-region" - Replaced "items:" with maxItems:1 for "sram" - remove regs property. - remove "$nodename" Reference: - Link to v5: https://lore.kernel.org/r/20240712-imx-se-if-v5-0-66a79903a872@nxp.com Changes in v5: 2/5 - updated the description of mboxes - updated the description & items for mbox-names. - updated the description of memory-region - move "additional properties: false" after allOf block. - removed other example except one. 4/5 - Corrected the indentation in Kconfig. - info members:mbox_tx_name & mbox_rx_name, are replaced with macros. 5/5 - Replaced "for secure enclaves", with "for secure enclaves" - Replaced "user space" with "userspace". - End the line "[include]" with a period. Reference: - Link to v4: https://lore.kernel.org/r/20240705-imx-se-if-v4-0-52d000e18a1d@nxp.com Changes in v4: 1/5 a. Removed - from EdgeLock Enclave. b. Removed , after "Each of the above feature," c. replace "can exists" with "can exist". d. -messaging units(MU) per SE. Each co-existing 'se' can have one or multiple exclusive -MU(s), dedicated to itself. None of the MU is shared between two SEs. +messaging units(MU) per SE. Each co-existing SE can have one or multiple exclusive +MUs, dedicated to itself. None of the MU is shared between two SEs. Communication of the MU is realized using the Linux mailbox driver. e. -All those SE interfaces 'se-if' that is/are dedicated to a particular SE, will be -enumerated and provisioned under the very single 'SE' node. +Although MU(s) is/are not shared between SE(s). But for SoC like i.MX95 which has +multiple SE(s) like HSM, V2X-HSM, V2X-SHE; all the SE(s) and their interfaces 'se-if' +that is/are dedicated to a particular SE will be enumerated and provisioned using the +single compatible node("fsl,imx95-se"). f. Removed ",". Replaced for "Each 'se-if'," with "Each se-if'. g. removed "," - This layer is responsible for ensuring the communication protocol, that is defined + This layer is responsible for ensuring the communication protocol that is defined h. removed "-" - - FW can handle one command-message at a time. + - FW can handle one command message at a time. i. - Using these multiple device contexts, that are getting multiplexed over a single MU, - user-space application(s) can call fops like write/read to send the command-message, - and read back the command-response-message to/from Firmware. - fops like read & write uses the above defined service layer API(s) to communicate with + Using these multiple device contexts that are getting multiplexed over a single MU, + userspace application(s) can call fops like write/read to send the command message, + and read back the command response message to/from Firmware. + fops like read & write use the above defined service layer API(s) to communicate with Firmware. j. Uppercase for word "Linux". 2/5 a. Rephrased the description to remove list of phandles. b. Moved required before allOf: +required: + - compatible + - reg + - mboxes + - mbox-names + +additionalProperties: false + allOf: c. replaced not: required: with properties: : false. # memory-region - not: - required: - - memory-region + properties: + memory-region: false # sram - else: - not: - required: - - sram d. Reduced examples. keeping example of i.MX95. e. node-name is changed to "firmware@" 3/5 - node name changed to "firmware@". 4/5 - used sizeof(*s_info) - return early, rather than doing goto exit, in ele_get_info(). - Use upper_32_bits() and lower_32_bits() - use rx_msg here instead of priv->rx_msg - Moved the status check to validate_rsp_hdr. Rename the function to "se_val_rsp_hdr_n_status" - typecasting removed header = (struct se_msg_hdr *) msg; - Converted the API name with prefix imx_ele_* or imx_se_*, to ele_* and se_*, respectively. - Removed the functions definition & declaration for: free_phybuf_mem_pool() & get_phybuf_mem_pool() - removed the mbox_free_channel() calls from clean-up. - Flag "priv->flags" is removed. - Converted the int se_if_probe_cleanup() to void se_if_probe_cleanup(). - Replaced NULL initialization of structure members: priv->cmd_receiver_dev & priv->waiting_rsp_dev , with comments. - Removed the function's declaration get_phy_buf_mem_pool1 5/5 Changes to Documentation/ABI/testing/se-cdev. a. Removed "-" from "secure-enclave" and "file-descriptor". b. Removed "-" from "shared-library" c. Replaced "get" with "getting". d. Added description for the new IOCTL "send command and receive command response" e. Replaced "wakeup_intruptible" with "wait_event_interruptible" f. Removed ";" g. Removd "," from "mailbox_lock," h. Replaced "free" with "frees" i. In mailbox callback function, checking the buffer size before copying. Reference: - Link to v3: https://lore.kernel.org/r/20240617-imx-se-if-v3-0-a7d28dea5c4a@nxp.com Changes in v3: 5/5: - Initialize tx_msg with NULL. - memdup_user() returns an error pointer, not NULL. correct it by adding check for err_ptr. - new IOCTL is added to send & recieve the message. - replaced the while loop till list is empty, with list_for_each_entry. - replaced __list_del_entry, with list_del. - Removed the dev_err message from copy to user. - Removed the casting of void *. - corrected the typcasting in copy to user. - removed un-necessary goto statement. - Removed dead code for clean-up of memory. - Removed un-mapping of secured memory - Passing se_if_priv structure to init_device_context. - Updated the below check to replace io.length with round_up(io.length). if (shared_mem->size < shared_mem->pos|| io.length >= shared_mem->size - shared_mem->pos) - Created a function to cleanup the list of shared memory buffers. - Used list_for_each_entry_safe(). created a separate functions: se_dev_ctx_cpy_out_data() & se_dev_ctx_shared_mem_cleanup() 4/5 - Changed the compatible string to replace "-ele", to "-se". - Declaration of imx_se_node_info, is done as const in the whole file - Remove the unused macros from ele_base_msg.h - Remove the function declaration get_phy_buf_mem_pool1, from the header file. - Replace the use of dmam_alloc_coherent to dma_alloc_coherent - Check for function pointer, before calling the fucntion pointer in imx_fetch_se_soc_info - Removed the unused flag for SE_MU_IO_FLAGS_USE_SEC_MEM. - Removed the unused macros WORD_SZ - instead of struct device *dev, struct se_if_priv *priv, is used as argument to the funtions:se_save_imem_state, se_restore_imem_state, imx_fetch_se_soc_info - Removed ret from validate_rsp_hdr. - changed the prefix of the funtion: plat_add_msg_crc and plat_fill_cmd_msg_hdr. - indentation correction for info structures. - remove the check for priv not null from se_if_probe_cleanup - Removed the casting of void *. - se_load_firmware function is corrected for not freeing the buffer when allocation fails. - Checking if get_imx_se_node_info() can return NULL, in se_if_probe() - imem.size has type u32. return value from se_save_imem_state() will be assigned to imem.size in case of success only. - removed the flag un-setting in case of failure. priv->flags &= (~RESERVED_DMA_POOL); - removed the function call for devm_of_platform_populate(dev); - Checking for not-NULL, before calling the funtion pointer se_fetch_soc_info. - Removed the checking for reserved memory flag, before freeing up the reserved memory, in se_probe_if_cleanup. 3/5 - Changed the compatible string to replace "-ele", to "-se". 2/5 - to fix the warning error, replaced the "-ele" & "-v2x" in compatible string, to "-se". - Added an example for ele@0 for compatible string "fsl,imx95-se" Reference - Link to v2: https://lore.kernel.org/r/20240523-imx-se-if-v2-0-5a6fd189a539@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 | 43 + .../devicetree/bindings/firmware/fsl,imx-se.yaml | 91 ++ .../driver-api/firmware/other_interfaces.rst | 121 ++ arch/arm64/boot/dts/freescale/imx8ulp-evk.dts | 17 +- arch/arm64/boot/dts/freescale/imx8ulp.dtsi | 13 +- drivers/firmware/imx/Kconfig | 13 + drivers/firmware/imx/Makefile | 2 + drivers/firmware/imx/ele_base_msg.c | 279 ++++ drivers/firmware/imx/ele_base_msg.h | 94 ++ drivers/firmware/imx/ele_common.c | 333 +++++ drivers/firmware/imx/ele_common.h | 51 + drivers/firmware/imx/se_ctrl.c | 1331 ++++++++++++++++++++ drivers/firmware/imx/se_ctrl.h | 134 ++ include/linux/firmware/imx/se_api.h | 14 + include/uapi/linux/se_ioctl.h | 94 ++ 15 files changed, 2627 insertions(+), 3 deletions(-) --- base-commit: 9852d85ec9d492ebef56dc5f229416c925758edc change-id: 20240507-imx-se-if-a40055093dc6 Best regards,