From nobody Fri Dec 19 16:04:30 2025 Received: from EUR05-AM6-obe.outbound.protection.outlook.com (mail-am6eur05on2070.outbound.protection.outlook.com [40.107.22.70]) (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 310E323A9A4; Mon, 7 Apr 2025 10:57:51 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=fail smtp.client-ip=40.107.22.70 ARC-Seal: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1744023475; cv=fail; b=Ek5Nf3CrFknsMlKtfSaOy908vMMULuDFtp8n203+4T2oUq8zoRHPQtDzroF60G37Z/I1UNhGHwaCOPmKpRpCtK870exXYwK7aZAOWeMRM1JRGlFyfF+zbWkBVFPHwEHFADlDiMri2yQAONCZfgHx99u7coqCR1CuUo/6GuEBuMo= ARC-Message-Signature: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1744023475; c=relaxed/simple; bh=3zVtLVpvhIWlfE8dV7jYgNQm0QqcrGS2loqltezixY0=; h=From:Date:Subject:Content-Type:Message-Id:References:In-Reply-To: To:Cc:MIME-Version; b=r1ch5tAD3fs0lF60SfFP8NFk8lUh9QstO0v3k0bhsUKfhEa487wYv9GyMINy6wuN6e72p3w/lxzO++kKcVBeQ2Z1M1fxEANNmII9SdZWtPhrpndeJAiVxCtfv4tud1GGmeTeY8rq7v/4wspSxSEZpusEMbvC3sGSx1a1F0l73Kc= 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=nQ3EILKI; arc=fail smtp.client-ip=40.107.22.70 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="nQ3EILKI" ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=iKglZl4vqgL3FaavxIcJj9LN5FefZMADEOnu34fjyh8CdJqMeV5HSDG5a8aDBfuFzB2pLuJdhaYhF1chEps3difxrNnHdbR4CxmP7ZJIk124UbzmoXXnO+sNGalk9FePP2siQ7z3P60FCS3KfGI5xyTf1vYZe8WWnA4PlMQN6IRk+9bi8At8L6BGLEv6Wznq931aE2TnRn2VzfcCInYBLyDbvETn24zc+LqibsfhlFYEB9gjE9XcDNSop/tE9IA+VThFdYnc8izd4R3kaiND0rq6uPb7o/AUTX+8PUxB5xLnRv2AvBVmvXbRs5nAHCHn9VTNOD2mQyFjUiNfszrjEg== 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=/3JTA/mlZjqi2WntsJVCbgWq4HYz5mYd0SICHyv7Nyk=; b=FByPnx0xKr3ZxUbBUgyQgq24HnEa7KlVGHZSwQ2zKgY4Q2BpRuT8JQKibr96JMfJibKJTZrVjTL1rY3Y7sGyfLX5fn3cITiYsoHY4Ou5yd4ID6p1bdOFomEnTM4QxrWnKyGmg/1yA0HuRrIS/uiEWxX/REOd79y9CmeBf1MgKcTZgDCpMpeCYedwXdu1zjS7DYhdlmwBLslPDqqcz2rYKvJW0LQddqR9SAevyFlHTJGy3V6gGEmchKv291XeY6/6NJr0TgRbhm5EmN6DcBoFqR8U5kRAdJS2Kf/tT1JFVd4AAA1NldgKCiMvs2zPT+M4fY8wyrt73GG6jfTmoaxkAA== 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=/3JTA/mlZjqi2WntsJVCbgWq4HYz5mYd0SICHyv7Nyk=; b=nQ3EILKIpWg95AGKYBQOmt2rfRY2MLhGL/seIAK55mLWwZ5lOEYidAANliYnBDsIZfH07UFJZ3ZUf+zD7Isd1OoAZu79K6wigTONuxqukXG9eBLnE3bj6Bx8kgxcdRyxUeVJMM7WY1vL3ljQAJdVAZtdAizgOAoSiXZsyJLw9/IvsG3I6N0FTp/12/W/ucOeUF7WjqckvUKslU2YUFKISrATBau5M7UeW+8NlRoMO6930xY3n57nwzVhCUuJ1U8TkqsSaM6V9YZpoOqU8F7v4u832wNixaog7gCG8ByEW9yRhzJZVz3EaZtSiq1IyJeKj1LAfyruXAIiIK5txnjQxA== Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=nxp.com; Received: from AM9PR04MB8604.eurprd04.prod.outlook.com (2603:10a6:20b:43b::21) by DB9PR04MB8493.eurprd04.prod.outlook.com (2603:10a6:10:2c5::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8583.43; Mon, 7 Apr 2025 10:57:49 +0000 Received: from AM9PR04MB8604.eurprd04.prod.outlook.com ([fe80::e751:223e:aa3d:5827]) by AM9PR04MB8604.eurprd04.prod.outlook.com ([fe80::e751:223e:aa3d:5827%6]) with mapi id 15.20.8583.045; Mon, 7 Apr 2025 10:57:49 +0000 From: Pankaj Gupta Date: Mon, 07 Apr 2025 21:50:23 +0530 Subject: [PATCH v15 7/7] firmware: drivers: imx: adds miscdev Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Message-Id: <20250407-imx-se-if-v15-7-e3382cecda01@nxp.com> References: <20250407-imx-se-if-v15-0-e3382cecda01@nxp.com> In-Reply-To: <20250407-imx-se-if-v15-0-e3382cecda01@nxp.com> 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 X-Mailer: b4 0.13.0 X-Developer-Signature: v=1; a=ed25519-sha256; t=1744042844; l=34246; i=pankaj.gupta@nxp.com; s=20240523; h=from:subject:message-id; bh=3zVtLVpvhIWlfE8dV7jYgNQm0QqcrGS2loqltezixY0=; b=gkODOQpNwC8DtYI6vwak4XOOQKtnTSaVElGS9hlsBo1khHQx3VjBnEgDZq+6vyavT6WrjiB6n ypIthUOq7/kAZqEewPSV4xJqJJHzoCAv93MV3xs9WYErtFOwPw4KnNF X-Developer-Key: i=pankaj.gupta@nxp.com; a=ed25519; pk=OA0pBQoupy5lV0XfKzD8B0OOBVB6tpAoIf+0x1bYGRg= X-ClientProxiedBy: SI2PR01CA0036.apcprd01.prod.exchangelabs.com (2603:1096:4:192::22) To AM9PR04MB8604.eurprd04.prod.outlook.com (2603:10a6:20b:43b::21) Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: AM9PR04MB8604:EE_|DB9PR04MB8493:EE_ X-MS-Office365-Filtering-Correlation-Id: b5f69ad5-a549-4848-cc41-08dd75c3093b X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0;ARA:13230040|1800799024|52116014|366016|7416014|376014|13003099007|38350700014; X-Microsoft-Antispam-Message-Info: =?utf-8?B?ZEN1UzJ3NGcxYTJrMldldi9NcjNjRFFWdmdhK2tneTh0alVtUFBzV0pjUyth?= =?utf-8?B?YVhNdVAvYnZNVXlHNFVFTGJzQ3d6MldDUGVoNVllTWhFdnhlQVU0UWY3VHR3?= =?utf-8?B?cENNUlFXQ1d5SXYvOE11eXJBNXlRTGcrVG02alR4b0NHdDdLMk1Bb21UTlFE?= =?utf-8?B?TklLVk1acGRmbzI0K1AvcHFVcE5iVzR6cm9pZEJjblk1Szh2VkNCUHR0UHEy?= =?utf-8?B?NisrdVhGNndURWJWQ2h1N05kd0kzaUlrcGJHNnJodnZiQThUR1E5V2crSnNj?= =?utf-8?B?T2lFUW9xQmFhdXBENm5VU2xNTzFtQVBSZ2tiL0tGWnJRb3gveExqT0RsdjVs?= =?utf-8?B?U2ZPU21TM0RUSjl2T0I0eGxuMkpFWkt3VXNQbE5rcXhDMCtreC80SlVjT29P?= =?utf-8?B?Q1VHSC9uRmpmaUVvQ3Bod0tnUTY5YStkYnlWeGdOTnNkU1hqT2tmR0EyZENx?= =?utf-8?B?ME84Mk1NUzBEK0FlcEpmcGU0SHVrTUF1SmJ2WkZIUmtxeU12enN3cHh1N2Zy?= =?utf-8?B?OUtkZ29nMFVZRDR1OGVoVW81cC9ibWxZRkErbWdmZ0JLL2cycW1RSzJJeG04?= =?utf-8?B?NVhCYXN3Z2RVTTNySE13YnRabTVJdWtCMTRzRy8rUkhKc0Z4bVU2WlZYeUIr?= =?utf-8?B?d2laUjlYb3pWUVA4Q1RVU3NZRU15U2NNL01hbVVOVmlKcERKOHhCcEY3Nngv?= =?utf-8?B?aUJpb05xRlFMZitXKy8xYlBLUmthSE5ONTZPajRZejU2U0RNc2JRWG1ObkE4?= =?utf-8?B?L2ljLzVySTMyL05lT0c2Z05lc25GeUJsczZxUTVwc21YNWF0VFczNXNqdTZs?= =?utf-8?B?c2syNTA2NzRwTzkzR3VrLzg0dnhDWHJOeVVOSVV2Z3M0SHhKQlFmc0grSytt?= =?utf-8?B?Ymg3RDRVNVQ5cFU5TWVzak9JaUg3TktnazU3alhHc2dySkJPbWlBM0VwVEY2?= =?utf-8?B?b01aemR6ZjJkeTRIQ3pXZGVUYXphUHdrTENLTmc0MUl6OFpUQmtnZ25EbGFD?= =?utf-8?B?Y093WThoUTVuTEVRUWNSWlFlUWdMTGdOUTNyaVhpeWN4MjVsZGxGK2ZWS3ps?= =?utf-8?B?cklkZUhpY1VBUHVZYmFNSlJ0ZGtKcUNydDVUSE5udDFmRkxYUitWa2FRRVpv?= =?utf-8?B?MG8vRkVMeEdSRjZVSkEyVHlFL0lCVVdXcHdSWHB1UWMrYkVlaTFYTnRSb1N0?= =?utf-8?B?Z1RSckQrNk9pWmsyTVgvaEdabkpiU29XT3BDTGUrZGVsTjhqcmN1Y1IraXAy?= =?utf-8?B?WDJxdk82SzB2UytMMVJCUzFmS0p0UFJTOEt3VTdnRTFkNVdnQVQrSGt2dDh1?= =?utf-8?B?Mm1KeWpOKzZuaVBDaXp1V0kwSjY1K25OR0E1ajlEc2VsQWZobHF4N2x5Qk01?= =?utf-8?B?Qlc2bld3dEtZbURVMzhRaXNrWDZXRHFTY3ZLZzVDZTg4Q0JtT25Kd20vL05Z?= =?utf-8?B?Ty9iQlhpTGFWekNJOWJwVlU5aUZtdEsyeDNXM3hVYjFqQXVOQXVaVDl4b2Q3?= =?utf-8?B?NnhaUVBxL3N2NldIaHFIYU1WNGFlY3JWWDRoNWpHdExGU3VwemNnMG0yZHFk?= =?utf-8?B?VHNpZ3d3RnF0QnUwYk1jVUlscG93YndxdEhPUHhXZlkrenI5b0RCUEhQeVpu?= =?utf-8?B?eTgrakdHV2tNU3dPV1VCcG1GVFh6UkVFdkdkYjlyVjRDQ2Z6UEh3T2NHVnFK?= =?utf-8?B?RCtMSHhJS3Rwa1dpU3BMdFJiQ0s3ZzFlWDJSdi93Z3Fib2JXNFVVYTc2VGl1?= =?utf-8?B?L2dJMjRaTlI2NXhsdDNFVVRzTFZtSU9hKzBiSWhWaVM0NU5mcTloeUgyeStz?= =?utf-8?B?azNodit0T25ydkhjSnBrZ0d5WEs1RitvcGpMMXRwdEdMWEJ3djBkek9yeTc1?= =?utf-8?B?bTlvVHNqRHRJc3NGMUhIL2JxNVhUQ1NKT1pnOUNTTGs1WkRWS2J3WHRyNWVF?= =?utf-8?B?Y2lldDgvbit3QStmU3hVQWJhQzdiQzI2ck5nSWc0ZGlYSU4rN3BwTWVqNmRQ?= =?utf-8?Q?Pm7jXvCn30T+vHriCYupq07Ce7d0YM=3D?= X-Forefront-Antispam-Report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:AM9PR04MB8604.eurprd04.prod.outlook.com;PTR:;CAT:NONE;SFS:(13230040)(1800799024)(52116014)(366016)(7416014)(376014)(13003099007)(38350700014);DIR:OUT;SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?eCthVjBPSXAvb1dBVFovcW02VkM2MHNveldCdXkwbW1IWXJSL0pKa1E1bjVY?= =?utf-8?B?SkhmZ2NDNjBJYnFIZG1RbFBvMDNGS0hqc2x1b1JMcmpYNlRJV3Q5Si9uWVIz?= =?utf-8?B?RjZtOEcrQUhPRDV1eldtM2lzSWhTdDJpN1VpcHBWRERxbmZnZ0VsTW5LKzNJ?= =?utf-8?B?bmQ5NldNREFxTzkxOURBcGlxQTRJakhZMldSYTRpODg2UVpWTkxNZ3FTeUpJ?= =?utf-8?B?Y2liQVVMNEIxclFiMnZlZXNSb2lZSGpDYm5WUEttaGRIUGI0NkpIMXFlcXFF?= =?utf-8?B?MHFUdEppaG9JNDV3dmwzdVAxY1QrL0ZuNEhjVmJQTXdJWlNhUHBaandSZ2tL?= =?utf-8?B?Ti9rL3BwZWdnTHFEU044K3QvVm00cnVQcFBXZVo0NE9HQzAyM3d1ZUtSQzcr?= =?utf-8?B?MmpkQlc3Vkx2RGtRVjNUQzVZNUxpV3FUWUI5NnpPVGJsckV6VUFIS1p6b20x?= =?utf-8?B?cG1oTHJnVXpadXBXd3k0WXJNS0VuWUNTc3h1VVlLS09QVkJCNjRZV3A4RDJr?= =?utf-8?B?T0tCVmxOUHY3d09mK3lwZjlrNStaanNhbTgyNnh5NVgwYnZ0NFJqWUtlVm1x?= =?utf-8?B?L3hMNkRUMzhleXBBb1FtQ0E4eXVzRFZ3SUN1b1lCZk4ydE12YTA0VHlMT3p3?= =?utf-8?B?MDMvM0laUFRMdGlNVXg2eFVQS0Y4RmIvbG1hRHRWdUdJb2ZnazZhbUtwS3RN?= =?utf-8?B?WlYxMjhiKzViMUEwd3ZSMkhaL1hMb2ljTmY2em9JeGJOMHk4d2h3WVpiYmxr?= =?utf-8?B?dXlDRXVDTVdSZ09pK044ajI4Nkh2cUpNWWoxbkVwaTRJR3labnZoRmQ0Qmh4?= =?utf-8?B?VmVzYytpd2R4MDZjUGtsZW5iVWlBeExMYUhRbU9VcCsvc2FqUWRqZnBuT0RP?= =?utf-8?B?QVdUaGZHR2lnWnp6TStkNUUxRnM5djdrYUM0djAzMENrRURpblE3TllzRElh?= =?utf-8?B?WEluRzBiTzJmTGErRW1XWWVWUlRVenJIRElWYTU2Q3dGK1F4bGxVZkFSZHpk?= =?utf-8?B?UTd4WkVsVk0yQ0F6a1U1UWZHMC8xSnp1WmhpMzYySUdkL0wwRVRwNDFuYjg4?= =?utf-8?B?SlNWZkIwakFkM3ZiaVNQalRvamJPMjFhMEJWbXg1RENzeE82bDR4OGhnMjYy?= =?utf-8?B?ZFlWbmJlYXVHY2F1M2I1QkFGOXZxbVk2SkR2MDRMN1pkbXhxVlFLQzgvSzJ1?= =?utf-8?B?RGdZRlBWbUg5VlcyaFlzT2NGTEsrc2Rsc1BuZis5WWZtZTNzQ2E4T1BTMEQ3?= =?utf-8?B?WlpIWjI0aE94MnAxS0RUcVV3cjhncVpYUlpvUWVJZ1ZPL09qYUk4TS9oMHdx?= =?utf-8?B?T2hpM1k1dDRpNnVROG40dmROWUljMFFhQ1llZy9HOFpiMUxualVaenNkUzRo?= =?utf-8?B?ZDZWdE15UHpTV3liQ1FqSGdiRFFSNVJ2aUppb25JTHlsQVVCZlBPU0JLVkVr?= =?utf-8?B?UGV4bXErTW5uc3dVQnRJRU8wd2ROd3AwOENLSStVL0UyVW05TzUrVHJIY2FU?= =?utf-8?B?RzhHRlFUYUovb2o2aC8zTlVLMXAyL2F3K3MxQTFQUTZTQnUzeFdWMURXVTFr?= =?utf-8?B?WlQzVjJGUE8rTlk1ZTh4ejRNL2dYbVhDSmowRFlrd3RrQ3Y5SWY3Ri8vUkpI?= =?utf-8?B?TkJUakZoeXFyWnlSLzdaSWZzRm9Xc1czZVFtcGJMcE56ZkdTR2txbW41TzhL?= =?utf-8?B?Qm9acndmeWVwMndEQndnclYrUHhLNy8vZ2pCVmN4QTlEMm9salQrcmJaandn?= =?utf-8?B?T3ZJMXJoMzc2SkxCMWsrZUFPYnVoYTBmTm9GbkphWXNWU2pleWNjWVZRR08v?= =?utf-8?B?U1dIc0hqL01HblhvYUtrWlRJM2Q0K3BJY2lCMEtHazBVRWc4NDVOYWhna01n?= =?utf-8?B?dnBIUzYvd0RlbkRjMUYwM3NVT2s0bDZEOWdKSUZENmtINEF1Yy9aNFdyVWIr?= =?utf-8?B?dHhnbmJJMmw4LzcxTG9URW9HdTZJb041a1Q5WDNFT0lsWk9lbEZ6L0d6UFdx?= =?utf-8?B?NmtpMXUyQ2xIbk55Qis4dzFjbU1HUUNiTlEvcU00T2pKdDBNb0VoMmo3SnNC?= =?utf-8?B?TGkzVVI0SkI2bUxWSksrME9XVUk4OUV2clBERGQyWEZPVXdwR0ZqeS9aYTVP?= =?utf-8?Q?Irc9vkjNrmCoNBg9ek44BJyiE?= X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: b5f69ad5-a549-4848-cc41-08dd75c3093b X-MS-Exchange-CrossTenant-AuthSource: AM9PR04MB8604.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Apr 2025 10:57:49.2848 (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: v2gRKDQiDz3HXdmKexZr0B/coYQS8fTnsfbZ24qapbJkATR/08l8Og0aGzSTIq9ufKX8YFVhfLofz5s8ay1R+g== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB9PR04MB8493 Adds the driver for communication interface to secure-enclave, for exchanging messages with NXP secure enclave HW IP(s) like EdgeLock Enclave from: - User-Space Applications via character driver. ABI documentation for the NXP secure-enclave driver. User-space library using this driver: - i.MX Secure Enclave library: -- URL: https://github.com/nxp-imx/imx-secure-enclave.git, - i.MX Secure Middle-Ware: -- URL: https://github.com/nxp-imx/imx-smw.git Signed-off-by: Pankaj Gupta --- changes from v14 to v15 - removed the se_intance_id structure member variable. - replace variable name from wait to timeout. - used 'goto' to follow the common exit path calling "release_firmware(fw);= " in case of error path. - removed TBD string. - Used ARRAY_SIZE(pending_lists). - moved init_device_context after init_misc_device_context. - defined err as long to avoid force convert in func - added se_rcv_msg_timeout to priv, to control probe/suspend/resume per int= erface. Note: copied the change logs for v13 to v14, to cover letter. --- Documentation/ABI/testing/se-cdev | 43 +++ drivers/firmware/imx/ele_common.c | 14 + drivers/firmware/imx/ele_common.h | 4 + drivers/firmware/imx/se_ctrl.c | 785 ++++++++++++++++++++++++++++++++++= +++- drivers/firmware/imx/se_ctrl.h | 33 ++ include/uapi/linux/se_ioctl.h | 101 +++++ 6 files changed, 972 insertions(+), 8 deletions(-) diff --git a/Documentation/ABI/testing/se-cdev b/Documentation/ABI/testing/= se-cdev new file mode 100644 index 000000000000..dad39ffd245a --- /dev/null +++ b/Documentation/ABI/testing/se-cdev @@ -0,0 +1,43 @@ +What: /dev/_mu[0-9]+_ch[0-9]+ +Date: Mar 2025 +KernelVersion: 6.8 +Contact: linux-imx@nxp.com, pankaj.gupta@nxp.com +Description: + NXP offers multiple hardware IP(s) for secure enclaves like EdgeLock- + Enclave(ELE), SECO. The character device file descriptors + /dev/_mu*_ch* are the interface between userspace NXP's secure- + enclave shared library and the kernel driver. + + The ioctl(2)-based ABI is defined and documented in + [include]. + ioctl(s) are used primarily for: + - shared memory management + - allocation of I/O buffers + - getting mu info + - setting a dev-ctx as receiver to receive all the commands from FW + - getting SoC info + - send command and receive command response + + The following file operations are supported: + + open(2) + Currently the only useful flags are O_RDWR. + + read(2) + Every read() from the opened character device context is waiting on + wait_event_interruptible, that gets set by the registered mailbox call= back + function, indicating a message received from the firmware on message- + unit. + + write(2) + Every write() to the opened character device context needs to acquire + mailbox_lock before sending message on to the message unit. + + close(2) + Stops and frees up the I/O contexts that were associated + with the file descriptor. + +Users: https://github.com/nxp-imx/imx-secure-enclave.git, + https://github.com/nxp-imx/imx-smw.git + crypto/skcipher, + drivers/nvmem/imx-ocotp-ele.c diff --git a/drivers/firmware/imx/ele_common.c b/drivers/firmware/imx/ele_c= ommon.c index baf83f03c1a0..5e61fc68fbaa 100644 --- a/drivers/firmware/imx/ele_common.c +++ b/drivers/firmware/imx/ele_common.c @@ -42,6 +42,11 @@ u32 se_get_msg_chksum(u32 *msg, u32 msg_len) return chksum; } =20 +void set_se_rcv_msg_timeout(struct se_if_priv *priv, u32 val) +{ + priv->se_rcv_msg_timeout =3D val; +} + int ele_msg_rcv(struct se_if_device_ctx *dev_ctx, struct se_clbk_handle *s= e_clbk_hdl) { unsigned long timeout; @@ -49,6 +54,8 @@ int ele_msg_rcv(struct se_if_device_ctx *dev_ctx, struct = se_clbk_handle *se_clbk =20 do { timeout =3D MAX_SCHEDULE_TIMEOUT; + if (dev_ctx->priv->cmd_receiver_clbk_hdl.dev_ctx !=3D dev_ctx) + timeout =3D msecs_to_jiffies(dev_ctx->priv->se_rcv_msg_timeout); =20 ret =3D wait_for_completion_interruptible_timeout(&se_clbk_hdl->done, ti= meout); if (ret =3D=3D -ERESTARTSYS) { @@ -59,6 +66,13 @@ int ele_msg_rcv(struct se_if_device_ctx *dev_ctx, struct= se_clbk_handle *se_clbk ret =3D -EINTR; break; } + if (ret =3D=3D 0) { + ret =3D -ETIMEDOUT; + dev_err(dev_ctx->priv->dev, + "Fatal Error: SE interface: %s0, hangs indefinitely.\n", + get_se_if_name(dev_ctx->priv->if_defs->se_if_type)); + break; + } ret =3D se_clbk_hdl->rx_msg_sz; break; } while (ret < 0); diff --git a/drivers/firmware/imx/ele_common.h b/drivers/firmware/imx/ele_c= ommon.h index 62c75e149d95..35543b1cdab3 100644 --- a/drivers/firmware/imx/ele_common.h +++ b/drivers/firmware/imx/ele_common.h @@ -12,6 +12,10 @@ =20 #define IMX_ELE_FW_DIR "imx/ele/" =20 +#define SE_RCV_MSG_DEFAULT_TIMEOUT 5000 +#define SE_RCV_MSG_LONG_TIMEOUT 5000000 + +void set_se_rcv_msg_timeout(struct se_if_priv *priv, u32 val); u32 se_get_msg_chksum(u32 *msg, u32 msg_len); int ele_msg_rcv(struct se_if_device_ctx *dev_ctx, struct se_clbk_handle *se_clbk_hdl); diff --git a/drivers/firmware/imx/se_ctrl.c b/drivers/firmware/imx/se_ctrl.c index a326e07ae547..5b8447c8c8da 100644 --- a/drivers/firmware/imx/se_ctrl.c +++ b/drivers/firmware/imx/se_ctrl.c @@ -23,6 +23,7 @@ #include #include #include +#include =20 #include "ele_base_msg.h" #include "ele_common.h" @@ -32,12 +33,6 @@ #define MBOX_TX_NAME "tx" #define MBOX_RX_NAME "rx" =20 -#define SE_TYPE_STR_DBG "dbg" -#define SE_TYPE_STR_HSM "hsm" - -#define SE_TYPE_ID_DBG 0x1 -#define SE_TYPE_ID_HSM 0x2 - struct se_fw_img_name { const u8 *prim_fw_nm_in_rfs; const u8 *seco_fw_nm_in_rfs; @@ -130,6 +125,14 @@ char *get_se_if_name(u8 se_if_id) return NULL; } =20 +static uint32_t get_se_soc_id(struct se_if_priv *priv) +{ + const struct se_soc_info *se_info =3D + device_get_match_data(priv->dev); + + return se_info->soc_id; +} + static struct se_fw_load_info *get_load_fw_instance(struct se_if_priv *pri= v) { return &var_se_info.load_fw; @@ -204,8 +207,223 @@ static int get_se_soc_info(struct se_if_priv *priv, c= onst struct se_soc_info *se return 0; } =20 +static int load_firmware(struct se_if_priv *priv, const u8 *se_img_file_to= _load) +{ + const struct firmware *fw =3D NULL; + phys_addr_t se_fw_phyaddr; + u8 *se_fw_buf; + int ret; + + if (!se_img_file_to_load) { + dev_err(priv->dev, "FW image is not provided."); + return -EINVAL; + } + ret =3D request_firmware(&fw, se_img_file_to_load, priv->dev); + if (ret) + return ret; + + dev_info(priv->dev, "loading firmware %s\n", se_img_file_to_load); + + /* allocate buffer to store the SE FW */ + se_fw_buf =3D dma_alloc_coherent(priv->dev, fw->size, + &se_fw_phyaddr, GFP_KERNEL); + if (!se_fw_buf) { + ret =3D -ENOMEM; + goto exit; + } + + memcpy(se_fw_buf, fw->data, fw->size); + ret =3D ele_fw_authenticate(priv, se_fw_phyaddr); + if (ret < 0) { + dev_err(priv->dev, + "Error %pe: Authenticate & load SE firmware %s.\n", + ERR_PTR(ret), + se_img_file_to_load); + ret =3D -EPERM; + } +exit: + dma_free_coherent(priv->dev, + fw->size, + se_fw_buf, + se_fw_phyaddr); + + release_firmware(fw); + + return ret; +} + +static int se_load_firmware(struct se_if_priv *priv) +{ + struct se_fw_load_info *load_fw =3D get_load_fw_instance(priv); + int ret =3D 0; + + if (!load_fw->is_fw_tobe_loaded) + return 0; + + if (load_fw->imem.state =3D=3D ELE_IMEM_STATE_BAD) { + ret =3D load_firmware(priv, load_fw->se_fw_img_nm->prim_fw_nm_in_rfs); + if (ret) { + dev_err(priv->dev, "Failed to load boot firmware."); + return -EPERM; + } + } + + ret =3D load_firmware(priv, load_fw->se_fw_img_nm->seco_fw_nm_in_rfs); + if (ret) { + dev_err(priv->dev, "Failed to load runtime firmware."); + return -EPERM; + } + + load_fw->is_fw_tobe_loaded =3D false; + + return ret; +} + +static int init_se_shared_mem(struct se_if_device_ctx *dev_ctx) +{ + struct se_shared_mem_mgmt_info *se_shared_mem_mgmt =3D &dev_ctx->se_share= d_mem_mgmt; + struct se_if_priv *priv =3D dev_ctx->priv; + + INIT_LIST_HEAD(&se_shared_mem_mgmt->pending_out); + INIT_LIST_HEAD(&se_shared_mem_mgmt->pending_in); + + /* + * Allocate some memory for data exchanges with S40x. + * This will be used for data not requiring secure memory. + */ + se_shared_mem_mgmt->non_secure_mem.ptr =3D + dma_alloc_coherent(priv->dev, + MAX_DATA_SIZE_PER_USER, + &se_shared_mem_mgmt->non_secure_mem.dma_addr, + GFP_KERNEL); + if (!se_shared_mem_mgmt->non_secure_mem.ptr) + return -ENOMEM; + + se_shared_mem_mgmt->non_secure_mem.size =3D MAX_DATA_SIZE_PER_USER; + se_shared_mem_mgmt->non_secure_mem.pos =3D 0; + + return 0; +} + +static void cleanup_se_shared_mem(struct se_if_device_ctx *dev_ctx) +{ + struct se_shared_mem_mgmt_info *se_shared_mem_mgmt =3D &dev_ctx->se_share= d_mem_mgmt; + struct se_if_priv *priv =3D dev_ctx->priv; + + /* Free non-secure shared buffer. */ + dma_free_coherent(priv->dev, MAX_DATA_SIZE_PER_USER, + se_shared_mem_mgmt->non_secure_mem.ptr, + se_shared_mem_mgmt->non_secure_mem.dma_addr); + + se_shared_mem_mgmt->non_secure_mem.ptr =3D NULL; + se_shared_mem_mgmt->non_secure_mem.dma_addr =3D 0; + se_shared_mem_mgmt->non_secure_mem.size =3D 0; + se_shared_mem_mgmt->non_secure_mem.pos =3D 0; +} + +/* Need to copy the output data to user-device context. + */ +static int se_dev_ctx_cpy_out_data(struct se_if_device_ctx *dev_ctx) +{ + struct se_shared_mem_mgmt_info *se_shared_mem_mgmt =3D &dev_ctx->se_share= d_mem_mgmt; + struct se_if_priv *priv =3D dev_ctx->priv; + struct se_buf_desc *b_desc, *temp; + bool do_cpy =3D true; + + list_for_each_entry_safe(b_desc, temp, &se_shared_mem_mgmt->pending_out, = link) { + if (b_desc->usr_buf_ptr && b_desc->shared_buf_ptr && do_cpy) { + dev_dbg(priv->dev, + "Copying output data to user."); + if (do_cpy && copy_to_user(b_desc->usr_buf_ptr, + b_desc->shared_buf_ptr, + b_desc->size)) { + dev_err(priv->dev, + "Failure copying output data to user."); + do_cpy =3D false; + } + } + + if (b_desc->shared_buf_ptr) + memset(b_desc->shared_buf_ptr, 0, b_desc->size); + + list_del(&b_desc->link); + kfree(b_desc); + } + + return do_cpy ? 0 : -EFAULT; +} + +/* + * Clean the used Shared Memory space, + * whether its Input Data copied from user buffers, or + * Data received from FW. + */ +static void se_dev_ctx_shared_mem_cleanup(struct se_if_device_ctx *dev_ctx) +{ + struct se_shared_mem_mgmt_info *se_shared_mem_mgmt =3D &dev_ctx->se_share= d_mem_mgmt; + struct list_head *pending_lists[] =3D {&se_shared_mem_mgmt->pending_in, + &se_shared_mem_mgmt->pending_out}; + struct se_buf_desc *b_desc, *temp; + int i; + + for (i =3D 0; i < ARRAY_SIZE(pending_lists); i++) { + list_for_each_entry_safe(b_desc, temp, + pending_lists[i], link) { + if (b_desc->shared_buf_ptr) + memset(b_desc->shared_buf_ptr, 0, b_desc->size); + + list_del(&b_desc->link); + kfree(b_desc); + } + } + se_shared_mem_mgmt->non_secure_mem.pos =3D 0; +} + +static int add_b_desc_to_pending_list(void *shared_ptr_with_pos, + struct se_ioctl_setup_iobuf *io, + struct se_if_device_ctx *dev_ctx) +{ + struct se_shared_mem_mgmt_info *se_shared_mem_mgmt =3D &dev_ctx->se_share= d_mem_mgmt; + struct se_buf_desc *b_desc =3D NULL; + + b_desc =3D kzalloc(sizeof(*b_desc), GFP_KERNEL); + if (!b_desc) + return -ENOMEM; + + b_desc->shared_buf_ptr =3D shared_ptr_with_pos; + b_desc->usr_buf_ptr =3D io->user_buf; + b_desc->size =3D io->length; + + if (io->flags & SE_IO_BUF_FLAGS_IS_INPUT) { + /* + * buffer is input: + * add an entry in the "pending input buffers" list so + * that copied data can be cleaned from shared memory + * later. + */ + list_add_tail(&b_desc->link, &se_shared_mem_mgmt->pending_in); + } else { + /* + * buffer is output: + * add an entry in the "pending out buffers" list so data + * can be copied to user space when receiving Secure-Enclave + * response. + */ + list_add_tail(&b_desc->link, &se_shared_mem_mgmt->pending_out); + } + + return 0; +} + +/* interface for managed res to unregister a character device */ +static void if_misc_deregister(void *miscdevice) +{ + misc_deregister(miscdevice); +} + static int init_misc_device_context(struct se_if_priv *priv, int ch_id, - struct se_if_device_ctx **new_dev_ctx) + struct se_if_device_ctx **new_dev_ctx, + const struct file_operations *se_if_fops) { struct se_if_device_ctx *dev_ctx; int ret =3D 0; @@ -221,12 +439,552 @@ static int init_misc_device_context(struct se_if_pri= v *priv, int ch_id, if (!dev_ctx->devname) return -ENOMEM; =20 + mutex_init(&dev_ctx->fops_lock); + + dev_ctx->priv =3D priv; + *new_dev_ctx =3D dev_ctx; + + dev_ctx->miscdev =3D devm_kzalloc(priv->dev, sizeof(*dev_ctx->miscdev), G= FP_KERNEL); + if (!dev_ctx->miscdev) { + *new_dev_ctx =3D NULL; + return -ENOMEM; + } + + dev_ctx->miscdev->name =3D dev_ctx->devname; + dev_ctx->miscdev->minor =3D MISC_DYNAMIC_MINOR; + dev_ctx->miscdev->fops =3D se_if_fops; + dev_ctx->miscdev->parent =3D priv->dev; + ret =3D misc_register(dev_ctx->miscdev); + if (ret) + return dev_err_probe(priv->dev, ret, "Failed to register misc device."); + + ret =3D devm_add_action_or_reset(priv->dev, if_misc_deregister, + dev_ctx->miscdev); + if (ret) + return dev_err_probe(priv->dev, ret, + "Failed to add action to the misc-dev."); + return ret; +} + +static int init_device_context(struct se_if_priv *priv, int ch_id, + struct se_if_device_ctx **new_dev_ctx) +{ + struct se_if_device_ctx *dev_ctx; + int ret =3D 0; + + dev_ctx =3D kzalloc(sizeof(*dev_ctx), GFP_KERNEL); + + if (!dev_ctx) + return -ENOMEM; + + dev_ctx->devname =3D kasprintf(GFP_KERNEL, "%s0_ch%d", + get_se_if_name(priv->if_defs->se_if_type), + ch_id); + if (!dev_ctx->devname) { + kfree(dev_ctx); + return -ENOMEM; + } + + mutex_init(&dev_ctx->fops_lock); dev_ctx->priv =3D priv; *new_dev_ctx =3D dev_ctx; =20 + list_add_tail(&dev_ctx->link, &priv->dev_ctx_list); + priv->active_devctx_count++; + + ret =3D init_se_shared_mem(dev_ctx); + if (ret < 0) { + kfree(dev_ctx->devname); + kfree(dev_ctx); + *new_dev_ctx =3D NULL; + } + return ret; } =20 +static int se_ioctl_cmd_snd_rcv_rsp_handler(struct se_if_device_ctx *dev_c= tx, + u64 arg) +{ + struct se_ioctl_cmd_snd_rcv_rsp_info cmd_snd_rcv_rsp_info =3D {0}; + struct se_api_msg *tx_msg __free(kfree) =3D NULL; + struct se_api_msg *rx_msg __free(kfree) =3D NULL; + struct se_if_priv *priv =3D dev_ctx->priv; + int err =3D 0; + + if (copy_from_user(&cmd_snd_rcv_rsp_info, (u8 __user *)arg, + sizeof(cmd_snd_rcv_rsp_info))) { + dev_err(priv->dev, + "%s: Failed to copy cmd_snd_rcv_rsp_info from user\n", + dev_ctx->devname); + err =3D -EFAULT; + goto exit; + } + + if (cmd_snd_rcv_rsp_info.tx_buf_sz < SE_MU_HDR_SZ) { + dev_err(priv->dev, + "%s: User buffer too small(%d < %d)\n", + dev_ctx->devname, + cmd_snd_rcv_rsp_info.tx_buf_sz, + SE_MU_HDR_SZ); + err =3D -ENOSPC; + goto exit; + } + + rx_msg =3D kzalloc(cmd_snd_rcv_rsp_info.rx_buf_sz, GFP_KERNEL); + if (!rx_msg) { + err =3D -ENOMEM; + goto exit; + } + + tx_msg =3D memdup_user(cmd_snd_rcv_rsp_info.tx_buf, + cmd_snd_rcv_rsp_info.tx_buf_sz); + if (IS_ERR(tx_msg)) { + err =3D PTR_ERR(tx_msg); + goto exit; + } + + if (tx_msg->header.tag !=3D priv->if_defs->cmd_tag) { + err =3D -EINVAL; + goto exit; + } + + if (tx_msg->header.ver =3D=3D priv->if_defs->fw_api_ver && + get_load_fw_instance(priv)->is_fw_tobe_loaded) { + err =3D se_load_firmware(priv); + if (err) { + dev_err(priv->dev, "Could not send the message as FW is not loaded."); + err =3D -EPERM; + goto exit; + } + } + set_se_rcv_msg_timeout(priv, SE_RCV_MSG_LONG_TIMEOUT); + + err =3D ele_msg_send_rcv(dev_ctx, + tx_msg, + cmd_snd_rcv_rsp_info.tx_buf_sz, + rx_msg, + cmd_snd_rcv_rsp_info.rx_buf_sz); + if (err < 0) + goto exit; + + dev_dbg(priv->dev, + "%s: %s %s\n", + dev_ctx->devname, + __func__, + "message received, start transmit to user"); + + /* We may need to copy the output data to user before + * delivering the completion message. + */ + err =3D se_dev_ctx_cpy_out_data(dev_ctx); + if (err < 0) + goto exit; + + /* Copy data from the buffer */ + print_hex_dump_debug("to user ", DUMP_PREFIX_OFFSET, 4, 4, + rx_msg, + cmd_snd_rcv_rsp_info.rx_buf_sz, false); + + if (copy_to_user(cmd_snd_rcv_rsp_info.rx_buf, rx_msg, + cmd_snd_rcv_rsp_info.rx_buf_sz)) { + dev_err(priv->dev, + "%s: Failed to copy to user\n", + dev_ctx->devname); + err =3D -EFAULT; + } + +exit: + + /* shared memory is allocated before this IOCTL */ + se_dev_ctx_shared_mem_cleanup(dev_ctx); + + if (copy_to_user((void __user *)arg, &cmd_snd_rcv_rsp_info, + sizeof(cmd_snd_rcv_rsp_info))) { + dev_err(priv->dev, + "%s: Failed to copy cmd_snd_rcv_rsp_info from user\n", + dev_ctx->devname); + err =3D -EFAULT; + } + + return err; +} + +static int se_ioctl_get_mu_info(struct se_if_device_ctx *dev_ctx, + u64 arg) +{ + struct se_if_priv *priv =3D dev_ctx->priv; + struct se_ioctl_get_if_info if_info; + struct se_if_node *if_node; + int err =3D 0; + + if_node =3D container_of(priv->if_defs, typeof(*if_node), if_defs); + + if_info.se_if_id =3D 0; + if_info.interrupt_idx =3D 0; + if_info.tz =3D 0; + if_info.did =3D 0; + if_info.cmd_tag =3D priv->if_defs->cmd_tag; + if_info.rsp_tag =3D priv->if_defs->rsp_tag; + if_info.success_tag =3D priv->if_defs->success_tag; + if_info.base_api_ver =3D priv->if_defs->base_api_ver; + if_info.fw_api_ver =3D priv->if_defs->fw_api_ver; + + dev_dbg(priv->dev, + "%s: info [se_if_id: %d, irq_idx: %d, tz: 0x%x, did: 0x%x]\n", + dev_ctx->devname, + if_info.se_if_id, if_info.interrupt_idx, + if_info.tz, if_info.did); + + if (copy_to_user((u8 __user *)arg, &if_info, sizeof(if_info))) { + dev_err(priv->dev, + "%s: Failed to copy mu info to user\n", + dev_ctx->devname); + err =3D -EFAULT; + } + + return err; +} + +/* + * Copy a buffer of data to/from the user and return the address to use in + * messages + */ +static int se_ioctl_setup_iobuf_handler(struct se_if_device_ctx *dev_ctx, + u64 arg) +{ + struct se_shared_mem *shared_mem =3D NULL; + struct se_ioctl_setup_iobuf io =3D {0}; + int err =3D 0; + u32 pos; + + if (copy_from_user(&io, (u8 __user *)arg, sizeof(io))) { + dev_err(dev_ctx->priv->dev, + "%s: Failed copy iobuf config from user\n", + dev_ctx->devname); + return -EFAULT; + } + + dev_dbg(dev_ctx->priv->dev, + "%s: io [buf: %p(%d) flag: %x]\n", + dev_ctx->devname, + io.user_buf, io.length, io.flags); + + if (io.length =3D=3D 0 || !io.user_buf) { + /* + * Accept NULL pointers since some buffers are optional + * in FW commands. In this case we should return 0 as + * pointer to be embedded into the message. + * Skip all data copy part of code below. + */ + io.ele_addr =3D 0; + goto copy; + } + + /* No specific requirement for this buffer. */ + shared_mem =3D &dev_ctx->se_shared_mem_mgmt.non_secure_mem; + + /* Check there is enough space in the shared memory. */ + dev_dbg(dev_ctx->priv->dev, + "%s: req_size =3D %d, max_size=3D %d, curr_pos =3D %d", + dev_ctx->devname, + round_up(io.length, 8u), + shared_mem->size, shared_mem->pos); + + if (shared_mem->size < shared_mem->pos || + round_up(io.length, 8u) > (shared_mem->size - shared_mem->pos)) { + dev_err(dev_ctx->priv->dev, + "%s: Not enough space in shared memory\n", + dev_ctx->devname); + return -ENOMEM; + } + + /* Allocate space in shared memory. 8 bytes aligned. */ + pos =3D shared_mem->pos; + shared_mem->pos +=3D round_up(io.length, 8u); + io.ele_addr =3D (u64)shared_mem->dma_addr + pos; + + memset(shared_mem->ptr + pos, 0, io.length); + if ((io.flags & SE_IO_BUF_FLAGS_IS_INPUT) || + (io.flags & SE_IO_BUF_FLAGS_IS_IN_OUT)) { + /* + * buffer is input: + * copy data from user space to this allocated buffer. + */ + if (copy_from_user(shared_mem->ptr + pos, io.user_buf, + io.length)) { + dev_err(dev_ctx->priv->dev, + "%s: Failed copy data to shared memory\n", + dev_ctx->devname); + return -EFAULT; + } + } + + err =3D add_b_desc_to_pending_list(shared_mem->ptr + pos, + &io, + dev_ctx); + if (err < 0) + dev_err(dev_ctx->priv->dev, + "%s: Failed to allocate/link b_desc.", + dev_ctx->devname); + +copy: + /* Provide the EdgeLock Enclave address to user space only if success.*/ + if (copy_to_user((u8 __user *)arg, &io, sizeof(io))) { + dev_err(dev_ctx->priv->dev, + "%s: Failed to copy iobuff setup to user.", + dev_ctx->devname); + err =3D -EFAULT; + } + + return err; +} + +/* IOCTL to provide SoC information */ +static int se_ioctl_get_se_soc_info_handler(struct se_if_device_ctx *dev_c= tx, + u64 arg) +{ + struct se_ioctl_get_soc_info soc_info; + int err =3D -EINVAL; + + soc_info.soc_id =3D get_se_soc_id(dev_ctx->priv); + soc_info.soc_rev =3D var_se_info.soc_rev; + + err =3D copy_to_user((u8 __user *)arg, (u8 *)(&soc_info), sizeof(soc_info= )); + if (err) { + dev_err(dev_ctx->priv->dev, + "%s: Failed to copy soc info to user\n", + dev_ctx->devname); + err =3D -EFAULT; + } + + return err; +} + +/* + * File operations for user-space + */ + +/* Write a message to the MU. */ +static ssize_t se_if_fops_write(struct file *fp, const char __user *buf, + size_t size, loff_t *ppos) +{ + struct se_if_device_ctx *dev_ctx =3D fp->private_data; + struct se_api_msg *tx_msg __free(kfree) =3D NULL; + struct se_if_priv *priv =3D dev_ctx->priv; + int err; + + dev_dbg(priv->dev, + "%s: write from buf (%p)%zu, ppos=3D%lld\n", + dev_ctx->devname, + buf, size, ((ppos) ? *ppos : 0)); + + scoped_cond_guard(mutex_intr, return -EBUSY, &dev_ctx->fops_lock) { + if (dev_ctx !=3D priv->cmd_receiver_clbk_hdl.dev_ctx) + return -EINVAL; + + if (size < SE_MU_HDR_SZ) { + dev_err(priv->dev, + "%s: User buffer too small(%zu < %d)\n", + dev_ctx->devname, + size, SE_MU_HDR_SZ); + return -ENOSPC; + } + + tx_msg =3D memdup_user(buf, size); + if (IS_ERR(tx_msg)) + return PTR_ERR(tx_msg); + + print_hex_dump_debug("from user ", DUMP_PREFIX_OFFSET, 4, 4, + tx_msg, size, false); + + err =3D ele_msg_send(dev_ctx, tx_msg, size); + + return err; + } +} + +/* + * Read a message from the MU. + * Blocking until a message is available. + */ +static ssize_t se_if_fops_read(struct file *fp, char __user *buf, + size_t size, loff_t *ppos) +{ + struct se_if_device_ctx *dev_ctx =3D fp->private_data; + struct se_if_priv *priv =3D dev_ctx->priv; + int err; + + dev_dbg(priv->dev, + "%s: read to buf %p(%zu), ppos=3D%lld\n", + dev_ctx->devname, + buf, size, ((ppos) ? *ppos : 0)); + + scoped_cond_guard(mutex_intr, return -EBUSY, &dev_ctx->fops_lock) { + if (dev_ctx !=3D priv->cmd_receiver_clbk_hdl.dev_ctx) { + err =3D -EINVAL; + goto exit; + } + + err =3D ele_msg_rcv(dev_ctx, &priv->cmd_receiver_clbk_hdl); + if (err < 0) { + dev_err(priv->dev, + "%s: Err[0x%x]:Interrupted by signal." + "Current active dev-ctx count =3D %d.", + dev_ctx->devname, err, + dev_ctx->priv->active_devctx_count); + goto exit; + } + + /* We may need to copy the output data to user before + * delivering the completion message. + */ + err =3D se_dev_ctx_cpy_out_data(dev_ctx); + if (err < 0) + goto exit; + + /* Copy data from the buffer */ + print_hex_dump_debug("to user ", DUMP_PREFIX_OFFSET, 4, 4, + priv->cmd_receiver_clbk_hdl.rx_msg, + priv->cmd_receiver_clbk_hdl.rx_msg_sz, + false); + + if (copy_to_user(buf, priv->cmd_receiver_clbk_hdl.rx_msg, + priv->cmd_receiver_clbk_hdl.rx_msg_sz)) { + dev_err(priv->dev, + "%s: Failed to copy to user\n", + dev_ctx->devname); + err =3D -EFAULT; + } else { + err =3D priv->cmd_receiver_clbk_hdl.rx_msg_sz; + } +exit: + priv->cmd_receiver_clbk_hdl.rx_msg_sz =3D 0; + + se_dev_ctx_shared_mem_cleanup(dev_ctx); + + return err; + } +} + +/* Open a character device. */ +static int se_if_fops_open(struct inode *nd, struct file *fp) +{ + struct miscdevice *miscdev =3D fp->private_data; + struct se_if_device_ctx *misc_dev_ctx; + struct se_if_device_ctx *dev_ctx; + struct se_if_priv *priv; + int err =3D 0; + + priv =3D dev_get_drvdata(miscdev->parent); + misc_dev_ctx =3D priv->priv_dev_ctx; + + scoped_cond_guard(mutex_intr, return -EBUSY, &misc_dev_ctx->fops_lock) { + priv->dev_ctx_mono_count++; + err =3D init_device_context(priv, + priv->dev_ctx_mono_count ? + priv->dev_ctx_mono_count + : priv->dev_ctx_mono_count++, + &dev_ctx); + if (err) + dev_err(priv->dev, + "Failed[0x%x] to create device contexts.\n", + err); + else + fp->private_data =3D dev_ctx; + + return err; + } +} + +/* Close a character device. */ +static int se_if_fops_close(struct inode *nd, struct file *fp) +{ + struct se_if_device_ctx *dev_ctx =3D fp->private_data; + struct se_if_priv *priv =3D dev_ctx->priv; + + scoped_cond_guard(mutex_intr, return -EBUSY, &dev_ctx->fops_lock) { + /* check if this device was registered as command receiver. */ + if (priv->cmd_receiver_clbk_hdl.dev_ctx =3D=3D dev_ctx) { + priv->cmd_receiver_clbk_hdl.dev_ctx =3D NULL; + kfree(priv->cmd_receiver_clbk_hdl.rx_msg); + priv->cmd_receiver_clbk_hdl.rx_msg =3D NULL; + } + + se_dev_ctx_shared_mem_cleanup(dev_ctx); + cleanup_se_shared_mem(dev_ctx); + + priv->active_devctx_count--; + list_del(&dev_ctx->link); + + kfree(dev_ctx->devname); + kfree(dev_ctx); + } + + return 0; +} + +/* IOCTL entry point of a character device */ +static long se_ioctl(struct file *fp, unsigned int cmd, unsigned long arg) +{ + struct se_if_device_ctx *dev_ctx =3D fp->private_data; + struct se_if_priv *priv =3D dev_ctx->priv; + long err; + + /* Prevent race during change of device context */ + scoped_cond_guard(mutex_intr, return -EBUSY, &dev_ctx->fops_lock) { + switch (cmd) { + case SE_IOCTL_ENABLE_CMD_RCV: + if (!priv->cmd_receiver_clbk_hdl.dev_ctx) { + if (!priv->cmd_receiver_clbk_hdl.rx_msg) { + priv->cmd_receiver_clbk_hdl.rx_msg =3D + kzalloc(MAX_NVM_MSG_LEN, + GFP_KERNEL); + if (!priv->cmd_receiver_clbk_hdl.rx_msg) { + err =3D -ENOMEM; + break; + } + } + priv->cmd_receiver_clbk_hdl.rx_msg_sz =3D MAX_NVM_MSG_LEN; + priv->cmd_receiver_clbk_hdl.dev_ctx =3D dev_ctx; + err =3D 0; + } else { + err =3D -EBUSY; + } + break; + case SE_IOCTL_GET_MU_INFO: + err =3D se_ioctl_get_mu_info(dev_ctx, arg); + break; + case SE_IOCTL_SETUP_IOBUF: + err =3D se_ioctl_setup_iobuf_handler(dev_ctx, arg); + break; + case SE_IOCTL_GET_SOC_INFO: + err =3D se_ioctl_get_se_soc_info_handler(dev_ctx, arg); + break; + case SE_IOCTL_CMD_SEND_RCV_RSP: + err =3D se_ioctl_cmd_snd_rcv_rsp_handler(dev_ctx, arg); + break; + default: + err =3D -EINVAL; + dev_dbg(priv->dev, + "%s: IOCTL %.8x not supported\n", + dev_ctx->devname, + cmd); + } + } + + return err; +} + +/* Char driver setup */ +static const struct file_operations se_if_fops =3D { + .open =3D se_if_fops_open, + .owner =3D THIS_MODULE, + .release =3D se_if_fops_close, + .unlocked_ioctl =3D se_ioctl, + .read =3D se_if_fops_read, + .write =3D se_if_fops_write, +}; + /* interface for managed res to free a mailbox channel */ static void if_mbox_free_channel(void *mbox_chan) { @@ -258,6 +1016,7 @@ static int se_if_request_channel(struct device *dev, =20 static void se_if_probe_cleanup(void *plat_dev) { + struct se_if_device_ctx *dev_ctx, *t_dev_ctx; struct platform_device *pdev =3D plat_dev; struct se_fw_load_info *load_fw; struct device *dev =3D &pdev->dev; @@ -284,6 +1043,13 @@ static void se_if_probe_cleanup(void *plat_dev) load_fw->imem.buf =3D NULL; } =20 + if (priv->dev_ctx_mono_count) { + list_for_each_entry_safe(dev_ctx, t_dev_ctx, &priv->dev_ctx_list, link) { + list_del(&dev_ctx->link); + priv->active_devctx_count--; + } + } + /* * No need to check, if reserved memory is allocated * before calling for its release. Or clearing the @@ -324,6 +1090,7 @@ static int se_if_probe(struct platform_device *pdev) priv->se_mb_cl.tx_block =3D false; priv->se_mb_cl.knows_txdone =3D true; priv->se_mb_cl.rx_callback =3D se_if_rx_callback; + set_se_rcv_msg_timeout(priv, SE_RCV_MSG_DEFAULT_TIMEOUT); =20 ret =3D se_if_request_channel(dev, &priv->tx_chan, &priv->se_mb_cl, MBOX_TX_NAME); @@ -348,6 +1115,7 @@ static int se_if_probe(struct platform_device *pdev) "Unable to get sram pool =3D %s.", if_node->pool_name); } + INIT_LIST_HEAD(&priv->dev_ctx_list); =20 if (if_node->reserved_dma_ranges) { ret =3D of_reserved_mem_device_init(dev); @@ -356,7 +1124,7 @@ static int se_if_probe(struct platform_device *pdev) "Failed to init reserved memory region."); } =20 - ret =3D init_misc_device_context(priv, 0, &priv->priv_dev_ctx); + ret =3D init_misc_device_context(priv, 0, &priv->priv_dev_ctx, &se_if_fop= s); if (ret) return dev_err_probe(dev, ret, "Failed[0x%x] to create device contexts.", @@ -399,6 +1167,7 @@ static int se_suspend(struct device *dev) struct se_fw_load_info *load_fw; int ret =3D 0; =20 + set_se_rcv_msg_timeout(priv, SE_RCV_MSG_DEFAULT_TIMEOUT); load_fw =3D get_load_fw_instance(priv); =20 if (load_fw->imem_mgmt) diff --git a/drivers/firmware/imx/se_ctrl.h b/drivers/firmware/imx/se_ctrl.h index b5e7705e2f26..d6d5736c39cd 100644 --- a/drivers/firmware/imx/se_ctrl.h +++ b/drivers/firmware/imx/se_ctrl.h @@ -14,6 +14,7 @@ #define SE_MSG_WORD_SZ 0x4 =20 #define RES_STATUS(x) FIELD_GET(0x000000ff, x) +#define MAX_DATA_SIZE_PER_USER (65 * 1024) #define MAX_NVM_MSG_LEN (256) #define MESSAGING_VERSION_6 0x6 #define MESSAGING_VERSION_7 0x7 @@ -37,10 +38,38 @@ struct se_imem_buf { u32 state; }; =20 +struct se_buf_desc { + u8 *shared_buf_ptr; + void __user *usr_buf_ptr; + u32 size; + struct list_head link; +}; + +struct se_shared_mem { + dma_addr_t dma_addr; + u32 size; + u32 pos; + u8 *ptr; +}; + +struct se_shared_mem_mgmt_info { + struct list_head pending_in; + struct list_head pending_out; + + struct se_shared_mem non_secure_mem; +}; + /* Private struct for each char device instance. */ struct se_if_device_ctx { struct se_if_priv *priv; + struct miscdevice *miscdev; const char *devname; + + /* process one file operation at a time. */ + struct mutex fops_lock; + + struct se_shared_mem_mgmt_info se_shared_mem_mgmt; + struct list_head link; }; =20 /* Header of the messages exchange with the EdgeLock Enclave */ @@ -89,6 +118,10 @@ struct se_if_priv { const struct se_if_defines *if_defs; =20 struct se_if_device_ctx *priv_dev_ctx; + struct list_head dev_ctx_list; + u32 active_devctx_count; + u32 dev_ctx_mono_count; + u32 se_rcv_msg_timeout; }; =20 char *get_se_if_name(u8 se_if_id); diff --git a/include/uapi/linux/se_ioctl.h b/include/uapi/linux/se_ioctl.h new file mode 100644 index 000000000000..29a9b1ec5ec3 --- /dev/null +++ b/include/uapi/linux/se_ioctl.h @@ -0,0 +1,101 @@ +/* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Cla= use*/ +/* + * Copyright 2025 NXP + */ + +#ifndef SE_IOCTL_H +#define SE_IOCTL_H + +#include + +#define SE_TYPE_STR_DBG "dbg" +#define SE_TYPE_STR_HSM "hsm" +#define SE_TYPE_ID_UNKWN 0x0 +#define SE_TYPE_ID_DBG 0x1 +#define SE_TYPE_ID_HSM 0x2 +/* IOCTL definitions. */ + +struct se_ioctl_setup_iobuf { + void __user *user_buf; + __u32 length; + __u32 flags; + __u64 ele_addr; +}; + +struct se_ioctl_shared_mem_cfg { + __u32 base_offset; + __u32 size; +}; + +struct se_ioctl_get_if_info { + __u8 se_if_id; + __u8 interrupt_idx; + __u8 tz; + __u8 did; + __u8 cmd_tag; + __u8 rsp_tag; + __u8 success_tag; + __u8 base_api_ver; + __u8 fw_api_ver; +}; + +struct se_ioctl_cmd_snd_rcv_rsp_info { + __u32 __user *tx_buf; + int tx_buf_sz; + __u32 __user *rx_buf; + int rx_buf_sz; +}; + +struct se_ioctl_get_soc_info { + __u16 soc_id; + __u16 soc_rev; +}; + +/* IO Buffer Flags */ +#define SE_IO_BUF_FLAGS_IS_OUTPUT (0x00u) +#define SE_IO_BUF_FLAGS_IS_INPUT (0x01u) +#define SE_IO_BUF_FLAGS_USE_SEC_MEM (0x02u) +#define SE_IO_BUF_FLAGS_USE_SHORT_ADDR (0x04u) +#define SE_IO_BUF_FLAGS_IS_IN_OUT (0x10u) + +/* IOCTLS */ +#define SE_IOCTL 0x0A /* like MISC_MAJOR. */ + +/* + * ioctl to designated the current fd as logical-reciever. + * This is ioctl is send when the nvm-daemon, a slave to the + * firmware is started by the user. + */ +#define SE_IOCTL_ENABLE_CMD_RCV _IO(SE_IOCTL, 0x01) + +/* + * ioctl to get the buffer allocated from the memory, which is shared + * between kernel and FW. + * Post allocation, the kernel tagged the allocated memory with: + * Output + * Input + * Input-Output + * Short address + * Secure-memory + */ +#define SE_IOCTL_SETUP_IOBUF _IOWR(SE_IOCTL, 0x03, \ + struct se_ioctl_setup_iobuf) + +/* + * ioctl to get the mu information, that is used to exchange message + * with FW, from user-spaced. + */ +#define SE_IOCTL_GET_MU_INFO _IOR(SE_IOCTL, 0x04, \ + struct se_ioctl_get_if_info) +/* + * ioctl to get SoC Info from user-space. + */ +#define SE_IOCTL_GET_SOC_INFO _IOR(SE_IOCTL, 0x06, \ + struct se_ioctl_get_soc_info) + +/* + * ioctl to send command and receive response from user-space. + */ +#define SE_IOCTL_CMD_SEND_RCV_RSP _IOWR(SE_IOCTL, 0x07, \ + struct se_ioctl_cmd_snd_rcv_rsp_info) +#endif --=20 2.43.0