From nobody Wed Nov 27 02:33:16 2024 Received: from EUR05-VI1-obe.outbound.protection.outlook.com (mail-vi1eur05on2042.outbound.protection.outlook.com [40.107.21.42]) (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 096ED1D9A4E; Tue, 15 Oct 2024 09:06:00 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=fail smtp.client-ip=40.107.21.42 ARC-Seal: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1728983164; cv=fail; b=VEYFi5g65/YG2v27YtWqxPs/3tMcZxzbDxpQuxeJx6y+J8Nrce7LVSYEWzSZQqFqNS8sumhP1LJeseZatYjuXcYCEPQEe+Ru0zgtQA9YO/JsUK+SFE4Uis98dk70Cd5EO2NXp8wpNCKi+PcPcqjmwlKmT4Rh/u9kewepYlK+bbs= ARC-Message-Signature: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1728983164; c=relaxed/simple; bh=ax172y29fbwMFJtJnw1/wnSI3JvsRz4Spt+X5leqanc=; h=From:Date:Subject:Content-Type:Message-Id:References:In-Reply-To: To:Cc:MIME-Version; b=ZTc+ZdQS2Wtd2mpfkkxyljVziZn9LZiEyHD2irA4N5m6StyW3Uors1Ft8hWd+TM6RPSG0DoRneygxLiGtmctaAvvcqlbfKbjhxec/LEq8BhjvjjwQIfJH43Vbg2Q7EGBPyoXyJmC5A9ZEXZ7AO54FgsDucMDhQCQnbmYhCuEGkw= 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=oKvkEyq8; arc=fail smtp.client-ip=40.107.21.42 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="oKvkEyq8" ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=v9GP1Gf82tZ0aIFmI/8nwSgjnuxh+awdfET8wGMmVGGbGaViJQe+oIpvpjIFS2HgdIxRCy28UfU/JSSnkrGxGO9HBg7p7+mOM6kt53TgwOB98DmHXCHg9Mt3lfKAVvLS7fQcgZBtdVkifXymCC11khaFd3wCrr6uO9Ow+BCgTmgwczyvUS+KAW1CwUayWwuuY1DfElJaiHBSmWLdZCvBbJLnuhuPG+cHMqkXNiilLGMwnqPOCCn8EUTHAhfZ3BCZxLoRtgFGCkihTX04ixSAQJfO3eUj1vOwdnTiEwPSORyCuESZdprcrkSBKtAaleeUjTXseIxivRsjY/joJMHd3Q== 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=uk92+3FZgT2pxRCdpUZQfLho0vhwZQf8eAn9G9kYcs0=; b=gyZfuzPE53nlS1fjMWq9gGBBAqvDTbXCPts1X29aF1ZHYCIaY+rb5a1Kdc70E38SsJhsFIQQHZX85Ma/qKdyxJo7JdnnN7jDFvWBf6w0/sHx7s8jX1HtAOrHVZL3fBEPs/1oj3xgv/kVvEAhoX8USyJeOL1CGcbQOhby6gFribkIvSp4RDngoI0VIH8woaEckX1OIbqpZalDt4NTiC7vR9EYSntfpdW5t+e8tWCFM8t93wTMWaZSfEL0NnF3PhOZFetXE+CfflgMikfRwZFmw+vEw8CVSgR6CXoB8acWIxlqPJ/4e2h4cP3iAcCCa2cdYPNC7Cqx7NUZjsd2ZKNCxA== 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=uk92+3FZgT2pxRCdpUZQfLho0vhwZQf8eAn9G9kYcs0=; b=oKvkEyq8Vo8cch4sEnPKjL/JVg9QzxC41CMa3xPzikAvv2XbwUAEv75niErMlN7CdmR2N87lRSkSats7iC8I3pvJYqDV/uzfbz7GBlmqktylLq0oL0vA8XQp622RQcQIqlWO5vMM/NE3FCEnXVIssCjzucm6vdO2rcOmMqjVAUGgLoDYC6wvm9PcW5K6FFdU0t8rNBQp2+drBc3pqTbaOSa2uYxNELSjeQ/ZN8la2wW3kFVAu5RXR4SdwOOrjQxHCJtYgE0TsbydYVBHTrNkVmhsIGvvb5V1+73Ex1FndCcK0v+BLgZSOg9V2hcr36VbWP5vIjnVB0tss+WaKZY7TA== 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 PAXPR04MB8223.eurprd04.prod.outlook.com (2603:10a6:102:1c9::14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8048.26; Tue, 15 Oct 2024 09:05:52 +0000 Received: from AM9PR04MB8604.eurprd04.prod.outlook.com ([fe80::e751:223e:aa3d:5827]) by AM9PR04MB8604.eurprd04.prod.outlook.com ([fe80::e751:223e:aa3d:5827%5]) with mapi id 15.20.8048.020; Tue, 15 Oct 2024 09:05:52 +0000 From: Pankaj Gupta Date: Tue, 15 Oct 2024 14:31:03 +0530 Subject: [PATCH v8 5/5] firmware: imx: adds miscdev Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Message-Id: <20241015-imx-se-if-v8-5-915438e267d3@nxp.com> References: <20241015-imx-se-if-v8-0-915438e267d3@nxp.com> In-Reply-To: <20241015-imx-se-if-v8-0-915438e267d3@nxp.com> To: Jonathan Corbet , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Shawn Guo , Sascha Hauer , Pengutronix Kernel Team , Fabio Estevam , Pankaj Gupta , Rob Herring 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=1728982877; l=36622; i=pankaj.gupta@nxp.com; s=20240523; h=from:subject:message-id; bh=ax172y29fbwMFJtJnw1/wnSI3JvsRz4Spt+X5leqanc=; b=1f74ZGswKCqxNmyZVPWy9VrOscQ7xMQs4vKsl74xOVKhDBi6dA6dZZbHwwFs3aYg56CVXo+8l M7iL8eiyeaECFOr4VS84xBCA7b2ZwUvn+2tF2j8sGJlljNkiuq/5Rqq X-Developer-Key: i=pankaj.gupta@nxp.com; a=ed25519; pk=OA0pBQoupy5lV0XfKzD8B0OOBVB6tpAoIf+0x1bYGRg= X-ClientProxiedBy: SG2P153CA0019.APCP153.PROD.OUTLOOK.COM (2603:1096:4:c7::6) 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_|PAXPR04MB8223:EE_ X-MS-Office365-Filtering-Correlation-Id: 80b11af5-6a6a-4ed2-df7a-08dcecf891d4 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0;ARA:13230040|7416014|52116014|376014|366016|1800799024|921020|38350700014; X-Microsoft-Antispam-Message-Info: =?utf-8?B?NVVYZm16YmFtYTZTejBBSTdGRkJJbFdGamoySTQydFZPL2FkTFR1S1IydnZi?= =?utf-8?B?Y1crL0xoMndSaHBzVnl4YnVyTDI3TFpNTjFxTktBaFFqV1p5a2hHNXJMdEg4?= =?utf-8?B?ZEhtWlBCaWJzdm1JaXFoUzBVUHZXVHhLTVVRMm9BdGYxZWZMYkFvVE5ZMWpo?= =?utf-8?B?UkVxQ2ZrRGNSRGdMMUJwMmpSTW96eWw1ZDY0ZTFaNVByNzFYQ3lBQUJCWGMy?= =?utf-8?B?cHNlL0pBMGJBWWIwUjNMaXVta0tOQjNabFZuY2FtUk1tdHJFRHlNbW42QjNG?= =?utf-8?B?bEx0VzRleGlOdHBrQTY1MGhkZkFpc1NYSW5ONnNlaEFIUHIvaDFrVTdnTGJF?= =?utf-8?B?UnFtTGE3a2RybTlXc3Y5OEFCemlSd1NQYVdidWVvaXlrNDR6WkNmRHgrRWZk?= =?utf-8?B?WDYybjk3THpIRktmbmx4a2lMUlV0TjYxYTVhWm1hZnhZWVNWcEF4cGd5N1Ji?= =?utf-8?B?TGRWZ1VjZUFCcFFEMk1mSkIyNlUzR05WT3ZCZzNiZDNmTkNJR3ZGRU5zLzBB?= =?utf-8?B?Yks4bG91NC9ITlYraEFiMmgwVjJ6ck5aWnJ3WUhzN1hzRm10U0t6dUlRamp5?= =?utf-8?B?MUhIQXVhUUYvVUhJTDV5SmVJeVNaNEpjOEg2K2tOSFh2Z1pKVmlRemtZeGtJ?= =?utf-8?B?eStlazU5bktwVXVNY2l5STkySS85V1lnZ0IvZWlxaHltTDB6Wmd5UUlTUVIv?= =?utf-8?B?VFM5b1g0ZU1NUG9qUm9LcmdkbGE0WjM5eEFOR01tSlR6N1lrT0lSN1c0Szl3?= =?utf-8?B?WlB3MjBWY0VNSmJSUzlxWUtaVU13Y3d6N0szTmNnRC95dkhieVFCS1I3UWdN?= =?utf-8?B?V2N1Vk5Ib2VEK0pLOHNmb3gxaS9KTnFydzBHcnpUZTFiclNyRkJ6ZUNnbGd0?= =?utf-8?B?V1hMeG8xZjJTeFhFa1lXZDhaWTY0RnVwaDlTZnRwRTZIVmx2UzcxdUQ3aXNT?= =?utf-8?B?d3lXVTRDd3pDNDBFNytDZFd1NWMyM0ZySUcxTUI1NGRRelB6M1RsZ2cvTUpq?= =?utf-8?B?Q3pSTVo5eE42RHFWL2dYK3Jrbkg5ajFveDR1Q2FyTW0yOElpVUQzL3ZENkpz?= =?utf-8?B?SXhGVklWNStqYmJVdTZHeDFpR1h6ZGVyTlRRbFczakdiZjRZV3dTdldHZDd0?= =?utf-8?B?ZDN2czhUeXNHeW5YSlJTOUphWHI0YUx1NGxEcll5T0RBT29mRyt0Q2xTN3J2?= =?utf-8?B?Q2JyYkhPMGpiY3I2MXBNbCthbVhER29KaC8yaFpMZEpCcEZKTjNjenJ3SEpx?= =?utf-8?B?OEpwcE12U1puV1FOQ0labWZqRFlOSStoWmFEcE5HdkJJd1dXTFJlc3VpeTdJ?= =?utf-8?B?c2NJRFBjTXBoM3R3dmZBVW5Kb3l1ejZVKzhJdUd2QUt0a25BbThSdmNNSVRS?= =?utf-8?B?SzJ3OGpmTnR2WDljSkRORzVsNC9pMnRaeFBFZEVRRk9UMFFaQldsK1lHMTZy?= =?utf-8?B?TG1MUE0zTzRwTnlodHFmNnd6bEdrWkcwWmFHL214NHFPbk9IaHJFam1QSVdF?= =?utf-8?B?anN0ZXZVT0hyckZZalBrZU1jN2h5SDBSZHBmRUQwSVRtOW0xbVJnNVE0K2JS?= =?utf-8?B?SWVHRjdUWDBUSUhVK0tzSmNwNHYxVmRXcC80V0JvSTY5NDdwSXFhc0FJVzdh?= =?utf-8?B?bFJLLzdoT0t4N0tyTGsydm15SWlpdGdPUENtNGh0S0xjd2t1YXNBbDJKTEt5?= =?utf-8?B?VjdFWlQ0Y2NBOHJ1RGpwNUtwckFCRmhWTmlxU3Boc2NzdThLdmo2VWRVbzJu?= =?utf-8?B?eUIwQUZjSldMUnY5R1Via3Q5SzBVajVjUGYvanRUN0RLWW0zdFMxSWFxUlFW?= =?utf-8?Q?Sb/Ea0uJtNhRVrqNykFcBn1G0CFaWrrmS4xqY=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)(7416014)(52116014)(376014)(366016)(1800799024)(921020)(38350700014);DIR:OUT;SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?K0E0QXZPTzdqR1VXU2FFcGV5M1BHQWFvcEhRS2NoTVRlRE1rZE1sVjZMeUt1?= =?utf-8?B?eDdPQmY2Q1RiWnk4UDJiMHNoQnVNMGZ3cUZCRFFKdDFrN2hJZjFPWStyOWpv?= =?utf-8?B?VFRvVnZZZ0JkK1JxWU9lQVhTeDBuU2hCZ1gya3FGTzNWRVgwajZsVVNSM3ZC?= =?utf-8?B?b29xTFRFcGtlcTlMVGdHTFFxcGhkcy90RURHL1lRcXpsaGEvcjdBcHZFbVBi?= =?utf-8?B?eVlFMUpoZ1U2MlFjb1Y5R1NvczFvMTRBT0JkT0NHeTA2Q3NsY2IxcGNZRngr?= =?utf-8?B?eFM1bys3bmlPQUlaSEtieXlVSS9VbnNzS0w2U1J6V21rSVRZaHRqT0ZVTWpj?= =?utf-8?B?Vlhmck1zVHNYYytYdW9wclM1Vm44Rm5aZ1QrZXFxOFd6b01qQW0zLzZyN2Rv?= =?utf-8?B?MHRmT3owTFZuQUVLLzVRYkd3WmdtNmo4amNlM3NlQXc0OGp2dnBLYUpXR3Q5?= =?utf-8?B?MUtXRFM2aDZ5c29zZ3pqcHhBVlY5eWR3cnRrOU9OVFZSL0w2ZnB4TmxTRjRC?= =?utf-8?B?ZklyeDQvOU1FRXpiaDNNeDdVMllPRlVhckhsSGREbUtpNGcxSXdzeVpmTWVp?= =?utf-8?B?aXM5VnY5eHd0U0lMamF2KzdmZFNnbnVlSU1aN1dtU3g5QVpZRUI1WWJlSytp?= =?utf-8?B?a2lwQStaTXU2cFpOeUJjczluWFhXYWxWZkZ1WHBHdU4wRVNjQ05yU0o1dlVl?= =?utf-8?B?K2NMRUlRQjJ5a2NGWUU3QVdzKzZCOElpTnFwNndtcGM3Qkd1cW05YTN0bkQx?= =?utf-8?B?a2FyamlJUlZhKzFvamQ2RDdyb1A0LzJ0U0pSMlBIMDY2ekRSZDRBajl5Wmty?= =?utf-8?B?YVZqZDJsd0U4aUJuTUo0b1ZsVjhrcG1yVzlGQWI3aXRFdUVlaklDdVhBSDhj?= =?utf-8?B?NW9oWEFQemRsQm5kU3Zod0YzSDgvdWJPcERxelhqL1plaEtjU1ltWkNlbUYv?= =?utf-8?B?ZFZSOHdRK1VSU0xKS2hQL091K1RMZlE5ZWFJV1ROQXpCWEF4N0FjN3N4dWM5?= =?utf-8?B?YU55aVRVUzRyYTl5UFptbUpkVGU2aldJT1o4bkJCZVBHRG95OUY4enhidlU0?= =?utf-8?B?NXBPOGVua1dvZjBkT2sxTUxFVXBSeUhRUHlwODVHemRobCsyWjhod294c2x3?= =?utf-8?B?ZW9Xc0NYZWJ3bHkzRVVQV1Avek5SQ2dKREl5cU1WS3UzZ3hkVlE4WE5kVkgv?= =?utf-8?B?cERRSmdnZzR3K2tTNkxHUEhqcTBwQzAzcnB0N2I1NWNTaEptR2dYUzFXR1dX?= =?utf-8?B?WW8xa2M1alNZb3VGTjJJU09BbDJpSXhkVmhwRzhIMkNxT2tVZXpQRUZzRTc1?= =?utf-8?B?QlJRcStkaXA5czdrRWV4eEs1MXgxZEMza29TcTJVK0pqSFRaQXdNYnFQNkk1?= =?utf-8?B?VkZwT3VVNGd3ZThnd1lyMnA5b3hqUlRpR2ZPNEloMEVzNnZ3WGpkd3pSSWl5?= =?utf-8?B?WkRmQmNuV3IzdWpuSGQ4L1dwMUl6ZjVraTZaQ3dzaTRSZkwvQ0l0S20zY0xJ?= =?utf-8?B?NloyaDlBNmVaMmFTK1hxUVhiSTFmRGlacUc2OUYxUWpPeXhhUzZiSFhKVS9m?= =?utf-8?B?S2xBNjRHb1RHZkE5UUd3bmVVVG5uSlZYODRBUkpnMXNwbE80b3NrcExYNVkw?= =?utf-8?B?ejR0ZkNKRjhzVEFkdVBKTlZ5RzEzalRBWUVrMi90MXBNamZsYVl0WnYvYWQ4?= =?utf-8?B?RE84Zkg1YW5RMWoxbk1HUDJsdnlEZ1BrRjI1S2c0eTRUZ1FqRWxOV2VEOFBt?= =?utf-8?B?ZUZFR3d1WmNYVkxwU3IvUEFObkljSWc0ck82VDhiMDUzSjR0QlE3RW82TUxv?= =?utf-8?B?V2U4bUhtaUUxaHRnVkpWNituYk5vbXIycnhMTVFWZDMxQzhRVkREenRYNEc2?= =?utf-8?B?S1VlRmtKV3BEVFpZc3hhNG5oRHl6WFZNWkdUN2pJeng1aXJCWXYvalBTZHVx?= =?utf-8?B?Mno3Ky9HVGVIVHQ4VmNVUFQ1aTVjMzJLMmU0Y2QvYVRrUldYL2t0Tk84dDB2?= =?utf-8?B?ak13R2tCNU42TXdPMDFZKzAyQk1pUWpJSUxXV0hHRzJqT3p6NUpPazNYZXds?= =?utf-8?B?c1pPT0RWeUxvWXVneVo4RlRncFFDZHVoRmwxRU05Vk9WR1Q1ZlR5UXJLdTBZ?= =?utf-8?Q?LWeZC84ubdzyX7mAz/nCnsIe/?= X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: 80b11af5-6a6a-4ed2-df7a-08dcecf891d4 X-MS-Exchange-CrossTenant-AuthSource: AM9PR04MB8604.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Oct 2024 09:05:52.4393 (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: 5vJxOC55X4YGqefWVdL6AQSsgjFzeODbq2Q4dg4vC+yvFvpA0eoth8iFKtqNDN70ZKuLBlxe7rB1rkDB3N6FNA== X-MS-Exchange-Transport-CrossTenantHeadersStamped: PAXPR04MB8223 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 --- Documentation/ABI/testing/se-cdev | 43 ++ drivers/firmware/imx/ele_base_msg.c | 8 +- drivers/firmware/imx/ele_common.c | 39 +- drivers/firmware/imx/ele_common.h | 6 +- drivers/firmware/imx/se_ctrl.c | 774 ++++++++++++++++++++++++++++++++= ++++ drivers/firmware/imx/se_ctrl.h | 42 +- include/uapi/linux/se_ioctl.h | 94 +++++ 7 files changed, 985 insertions(+), 21 deletions(-) diff --git a/Documentation/ABI/testing/se-cdev b/Documentation/ABI/testing/= se-cdev new file mode 100644 index 000000000000..3451c909ccc4 --- /dev/null +++ b/Documentation/ABI/testing/se-cdev @@ -0,0 +1,43 @@ +What: /dev/_mu[0-9]+_ch[0-9]+ +Date: May 2024 +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_base_msg.c b/drivers/firmware/imx/ele= _base_msg.c index fb89340c224e..346c948e8df0 100644 --- a/drivers/firmware/imx/ele_base_msg.c +++ b/drivers/firmware/imx/ele_base_msg.c @@ -67,7 +67,7 @@ int ele_get_info(struct se_if_priv *priv, struct ele_dev_= info *s_info) tx_msg->data[0] =3D upper_32_bits(get_info_addr); tx_msg->data[1] =3D lower_32_bits(get_info_addr); tx_msg->data[2] =3D sizeof(*s_info); - ret =3D ele_msg_send_rcv(priv, + ret =3D ele_msg_send_rcv(priv->priv_dev_ctx, tx_msg, ELE_GET_INFO_REQ_MSG_SZ, rx_msg, @@ -145,7 +145,7 @@ int ele_ping(struct se_if_priv *priv) goto exit; } =20 - ret =3D ele_msg_send_rcv(priv, + ret =3D ele_msg_send_rcv(priv->priv_dev_ctx, tx_msg, ELE_PING_REQ_SZ, rx_msg, @@ -200,7 +200,7 @@ int ele_service_swap(struct se_if_priv *priv, tx_msg->data[3] =3D lower_32_bits(addr); tx_msg->data[4] =3D se_add_msg_crc((uint32_t *)&tx_msg[0], ELE_SERVICE_SWAP_REQ_MSG_SZ); - ret =3D ele_msg_send_rcv(priv, + ret =3D ele_msg_send_rcv(priv->priv_dev_ctx, tx_msg, ELE_SERVICE_SWAP_REQ_MSG_SZ, rx_msg, @@ -261,7 +261,7 @@ int ele_fw_authenticate(struct se_if_priv *priv, phys_a= ddr_t addr) tx_msg->data[0] =3D lower_32_bits(addr); tx_msg->data[2] =3D addr; =20 - ret =3D ele_msg_send_rcv(priv, + ret =3D ele_msg_send_rcv(priv->priv_dev_ctx, tx_msg, ELE_FW_AUTH_REQ_SZ, rx_msg, diff --git a/drivers/firmware/imx/ele_common.c b/drivers/firmware/imx/ele_c= ommon.c index 1cd76c630bdf..30ebfcc0600c 100644 --- a/drivers/firmware/imx/ele_common.c +++ b/drivers/firmware/imx/ele_common.c @@ -18,9 +18,10 @@ u32 se_add_msg_crc(u32 *msg, u32 msg_len) return crc; } =20 -int ele_msg_rcv(struct se_if_priv *priv, +int ele_msg_rcv(struct se_if_device_ctx *dev_ctx, struct se_clbk_handle *se_clbk_hdl) { + struct se_if_priv *priv =3D dev_ctx->priv; int err =3D 0; =20 do { @@ -31,12 +32,13 @@ int ele_msg_rcv(struct se_if_priv *priv, */ err =3D wait_for_completion_interruptible(&se_clbk_hdl->done); if (err =3D=3D -ERESTARTSYS) { - if (priv->waiting_rsp_clbk_hdl.rx_msg) { + if (priv->waiting_rsp_clbk_hdl.dev_ctx) { priv->waiting_rsp_clbk_hdl.signal_rcvd =3D true; continue; } dev_err(priv->dev, - "Err[0x%x]:Interrupted by signal.\n", + "%s: Err[0x%x]:Interrupted by signal.\n", + se_clbk_hdl->dev_ctx->devname, err); err =3D -EINTR; break; @@ -46,10 +48,11 @@ int ele_msg_rcv(struct se_if_priv *priv, return err ? err : se_clbk_hdl->rx_msg_sz; } =20 -int ele_msg_send(struct se_if_priv *priv, +int ele_msg_send(struct se_if_device_ctx *dev_ctx, void *tx_msg, int tx_msg_sz) { + struct se_if_priv *priv =3D dev_ctx->priv; struct se_msg_hdr *header; int err; =20 @@ -62,7 +65,8 @@ int ele_msg_send(struct se_if_priv *priv, if (header->size << 2 !=3D tx_msg_sz) { err =3D -EINVAL; dev_err(priv->dev, - "User buf hdr: 0x%x, sz mismatced with input-sz (%d !=3D %d).", + "%s: User buf hdr: 0x%x, sz mismatced with input-sz (%d !=3D %d).", + dev_ctx->devname, *(u32 *)header, header->size << 2, tx_msg_sz); goto exit; @@ -70,7 +74,9 @@ int ele_msg_send(struct se_if_priv *priv, =20 err =3D mbox_send_message(priv->tx_chan, tx_msg); if (err < 0) { - dev_err(priv->dev, "Error: mbox_send_message failure.\n"); + dev_err(priv->dev, + "%s: Error: mbox_send_message failure.", + dev_ctx->devname); return err; } err =3D tx_msg_sz; @@ -80,29 +86,32 @@ int ele_msg_send(struct se_if_priv *priv, } =20 /* API used for send/receive blocking call. */ -int ele_msg_send_rcv(struct se_if_priv *priv, +int ele_msg_send_rcv(struct se_if_device_ctx *dev_ctx, void *tx_msg, int tx_msg_sz, void *rx_msg, int exp_rx_msg_sz) { int err; + struct se_if_priv *priv =3D dev_ctx->priv; =20 guard(mutex)(&priv->se_if_cmd_lock); =20 + priv->waiting_rsp_clbk_hdl.dev_ctx =3D dev_ctx; priv->waiting_rsp_clbk_hdl.rx_msg_sz =3D exp_rx_msg_sz; priv->waiting_rsp_clbk_hdl.rx_msg =3D rx_msg; =20 - err =3D ele_msg_send(priv, tx_msg, tx_msg_sz); + err =3D ele_msg_send(dev_ctx, tx_msg, tx_msg_sz); if (err < 0) goto exit; =20 - err =3D ele_msg_rcv(priv, &priv->waiting_rsp_clbk_hdl); + err =3D ele_msg_rcv(dev_ctx, &priv->waiting_rsp_clbk_hdl); =20 if (priv->waiting_rsp_clbk_hdl.signal_rcvd) { err =3D -EINTR; priv->waiting_rsp_clbk_hdl.signal_rcvd =3D false; } + priv->waiting_rsp_clbk_hdl.dev_ctx =3D NULL; =20 exit: return err; @@ -149,7 +158,8 @@ void se_if_rx_callback(struct mbox_client *mbox_cl, voi= d *msg) if (header->tag =3D=3D priv->if_defs.cmd_tag) { se_clbk_hdl =3D &priv->cmd_receiver_clbk_hdl; dev_dbg(dev, - "Selecting cmd receiver for mesg header:0x%x.", + "Selecting cmd receiver:%s for mesg header:0x%x.", + se_clbk_hdl->dev_ctx->devname, *(u32 *) header); =20 /* Pre-allocated buffer of MAX_NVM_MSG_LEN @@ -158,7 +168,8 @@ void se_if_rx_callback(struct mbox_client *mbox_cl, voi= d *msg) */ if (rx_msg_sz > MAX_NVM_MSG_LEN) { dev_err(dev, - "CMD-RCVER NVM: hdr(0x%x) with different sz(%d !=3D %d).\n", + "%s: CMD-RCVER NVM: hdr(0x%x) with different sz(%d !=3D %d).\n", + se_clbk_hdl->dev_ctx->devname, *(u32 *) header, rx_msg_sz, se_clbk_hdl->rx_msg_sz); =20 @@ -169,13 +180,15 @@ void se_if_rx_callback(struct mbox_client *mbox_cl, v= oid *msg) } else if (header->tag =3D=3D priv->if_defs.rsp_tag) { se_clbk_hdl =3D &priv->waiting_rsp_clbk_hdl; dev_dbg(dev, - "Selecting resp waiter for mesg header:0x%x.", + "Selecting resp waiter:%s for mesg header:0x%x.", + se_clbk_hdl->dev_ctx->devname, *(u32 *) header); =20 if (rx_msg_sz !=3D se_clbk_hdl->rx_msg_sz && !exception_for_size(priv, header)) { dev_err(dev, - "Rsp to CMD: hdr(0x%x) with different sz(%d !=3D %d).\n", + "%s: Rsp to CMD: hdr(0x%x) with different sz(%d !=3D %d).\n", + se_clbk_hdl->dev_ctx->devname, *(u32 *) header, rx_msg_sz, se_clbk_hdl->rx_msg_sz); =20 diff --git a/drivers/firmware/imx/ele_common.h b/drivers/firmware/imx/ele_c= ommon.h index 374f158a85de..314b782c413c 100644 --- a/drivers/firmware/imx/ele_common.h +++ b/drivers/firmware/imx/ele_common.h @@ -14,12 +14,12 @@ #define IMX_ELE_FW_DIR "imx/ele/" =20 uint32_t se_add_msg_crc(uint32_t *msg, uint32_t msg_len); -int ele_msg_rcv(struct se_if_priv *priv, +int ele_msg_rcv(struct se_if_device_ctx *dev_ctx, struct se_clbk_handle *se_clbk_hdl); -int ele_msg_send(struct se_if_priv *priv, +int ele_msg_send(struct se_if_device_ctx *dev_ctx, void *tx_msg, int tx_msg_sz); -int ele_msg_send_rcv(struct se_if_priv *priv, +int ele_msg_send_rcv(struct se_if_device_ctx *dev_ctx, void *tx_msg, int tx_msg_sz, void *rx_msg, diff --git a/drivers/firmware/imx/se_ctrl.c b/drivers/firmware/imx/se_ctrl.c index 37693c27042f..b89f195e0d40 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" @@ -309,6 +310,757 @@ static int se_load_firmware(struct se_if_priv *priv) return ret; } =20 +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; + + /* Unmap secure memory shared buffer. */ + if (se_shared_mem_mgmt->secure_mem.ptr) + devm_iounmap(priv->dev, + se_shared_mem_mgmt->secure_mem.ptr); + + se_shared_mem_mgmt->secure_mem.ptr =3D NULL; + se_shared_mem_mgmt->secure_mem.dma_addr =3D 0; + se_shared_mem_mgmt->secure_mem.size =3D 0; + se_shared_mem_mgmt->secure_mem.pos =3D 0; + + /* 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 < 2; 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->secure_mem.pos =3D 0; + 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_device_context(struct se_if_priv *priv, int ch_id, + struct se_if_device_ctx **new_dev_ctx, + const struct file_operations *se_if_fops) +{ + const struct se_if_node_info *info =3D priv->if_defs.info; + struct se_if_device_ctx *dev_ctx; + int ret =3D 0; + + if (ch_id) + dev_ctx =3D kzalloc(sizeof(*dev_ctx), GFP_KERNEL); + else + dev_ctx =3D devm_kzalloc(priv->dev, sizeof(*dev_ctx), GFP_KERNEL); + + if (!dev_ctx) { + ret =3D -ENOMEM; + return ret; + } + + dev_ctx->priv =3D priv; + + if (ch_id) + dev_ctx->devname =3D kasprintf(GFP_KERNEL, "%s_ch%d", + info->se_name, ch_id); + else + dev_ctx->devname =3D devm_kasprintf(priv->dev, + GFP_KERNEL, "%s_ch%d", + info->se_name, ch_id); + if (!dev_ctx->devname) { + ret =3D -ENOMEM; + if (ch_id) + kfree(dev_ctx); + + return ret; + } + + mutex_init(&dev_ctx->fops_lock); + + *new_dev_ctx =3D dev_ctx; + + if (ch_id) { + 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; + } + + return ret; + } + + /* Only for ch_id =3D 0: + * - register the misc device. + * - add action + */ + dev_ctx->miscdev =3D devm_kzalloc(priv->dev, sizeof(*dev_ctx->miscdev), G= FP_KERNEL); + if (!dev_ctx->miscdev) { + ret =3D -ENOMEM; + *new_dev_ctx =3D NULL; + return ret; + } + + 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) { + dev_err(priv->dev, "failed to register misc device %d\n", + ret); + return ret; + } + + ret =3D devm_add_action(priv->dev, if_misc_deregister, + dev_ctx->miscdev); + if (ret) { + dev_err(priv->dev, + "failed[%d] to add action to the misc-dev\n", + ret); + misc_deregister(dev_ctx->miscdev); + } + + return ret; +} + +static int se_ioctl_cmd_snd_rcv_rsp_handler(struct se_if_device_ctx *dev_c= tx, + u64 arg) +{ + const struct se_if_node_info *info =3D dev_ctx->priv->if_defs.info; + struct se_ioctl_cmd_snd_rcv_rsp_info cmd_snd_rcv_rsp_info; + struct se_if_node_info_list *info_list + =3D container_of(info, + typeof(*info_list), + info[info->se_if_id]); + struct se_if_priv *priv =3D dev_ctx->priv; + struct se_api_msg *tx_msg __free(kfree) =3D NULL; + struct se_api_msg *rx_msg __free(kfree) =3D NULL; + int err =3D 0; + + if (copy_from_user(&cmd_snd_rcv_rsp_info, (u8 *)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 && + !info_list->load_hsm_fw.is_fw_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; + } + } + 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: + se_dev_ctx_shared_mem_cleanup(dev_ctx); + + if (copy_to_user((void *)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_if_node_info *if_node_info; + struct se_ioctl_get_if_info info; + int err =3D 0; + + if_node_info =3D (struct se_if_node_info *)priv->if_defs.info; + + info.se_if_id =3D if_node_info->se_if_id; + info.interrupt_idx =3D 0; + info.tz =3D 0; + info.did =3D if_node_info->se_if_did; + info.cmd_tag =3D if_node_info->cmd_tag; + info.rsp_tag =3D if_node_info->rsp_tag; + info.success_tag =3D if_node_info->success_tag; + info.base_api_ver =3D if_node_info->base_api_ver; + info.fw_api_ver =3D if_node_info->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, + info.se_if_id, info.interrupt_idx, info.tz, info.did); + + if (copy_to_user((u8 *)arg, &info, sizeof(info))) { + dev_err(priv->dev, + "%s: Failed to copy mu info to user\n", + dev_ctx->devname); + err =3D -EFAULT; + goto exit; + } + +exit: + 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 *)arg, sizeof(io))) { + dev_err(dev_ctx->priv->dev, + "%s: Failed copy iobuf config from user\n", + dev_ctx->devname); + err =3D -EFAULT; + goto exit; + } + + 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. */ + if (shared_mem->size < shared_mem->pos || + round_up(io.length, 8u) >=3D (shared_mem->size - shared_mem->pos)) { + dev_err(dev_ctx->priv->dev, + "%s: Not enough space in shared memory\n", + dev_ctx->devname); + err =3D -ENOMEM; + goto exit; + } + + /* 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); + err =3D -EFAULT; + goto exit; + } + } + + 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 *)arg, &io, sizeof(io))) { + dev_err(dev_ctx->priv->dev, + "%s: Failed to copy iobuff setup to user.", + dev_ctx->devname); + err =3D -EFAULT; + goto exit; + } +exit: + 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) +{ + const struct se_if_node_info_list *info_list; + struct se_ioctl_get_soc_info soc_info; + int err =3D -EINVAL; + + info_list =3D device_get_match_data(dev_ctx->priv->dev); + if (!info_list) + goto exit; + + soc_info.soc_id =3D info_list->soc_id; + soc_info.soc_rev =3D se_soc_rev; + + err =3D (int)copy_to_user((u8 *)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; + goto exit; + } + +exit: + 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)); + + if (mutex_lock_interruptible(&dev_ctx->fops_lock)) + return -EBUSY; + + if (dev_ctx !=3D priv->cmd_receiver_clbk_hdl.dev_ctx) { + err =3D -EINVAL; + goto exit; + } + + 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); + err =3D -ENOSPC; + goto exit; + } + + tx_msg =3D memdup_user(buf, size); + if (IS_ERR(tx_msg)) { + err =3D PTR_ERR(tx_msg); + goto exit; + } + + 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); + if (err < 0) + goto exit; +exit: + mutex_unlock(&dev_ctx->fops_lock); + 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)); + + if (mutex_lock_interruptible(&dev_ctx->fops_lock)) + return -EBUSY; + + 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.\n", + dev_ctx->devname, err); + dev_dbg(priv->dev, + "Current active dev-ctx count =3D %d.\n", + 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; + } + 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); + + mutex_unlock(&dev_ctx->fops_lock); + 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_priv *priv =3D dev_get_drvdata(miscdev->parent); + struct se_if_device_ctx *misc_dev_ctx =3D priv->priv_dev_ctx; + struct se_if_device_ctx *dev_ctx; + int err =3D 0; + + if (mutex_lock_interruptible(&misc_dev_ctx->fops_lock)) + return -EBUSY; + + 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, NULL); + if (err) { + dev_err(priv->dev, + "Failed[0x%x] to create device contexts.\n", + err); + goto exit; + } + + fp->private_data =3D dev_ctx; + +exit: + mutex_unlock(&misc_dev_ctx->fops_lock); + 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; + + if (mutex_lock_interruptible(&dev_ctx->fops_lock)) + return -EBUSY; + + /* 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); + + mutex_unlock(&dev_ctx->fops_lock); + 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; + int err; + + /* Prevent race during change of device context */ + if (mutex_lock_interruptible(&dev_ctx->fops_lock)) + return -EBUSY; + + 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); + } + + mutex_unlock(&dev_ctx->fops_lock); + + return (long)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) { @@ -344,6 +1096,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 device *dev =3D &pdev->dev; struct se_fw_load_info *load_fw; @@ -368,6 +1121,18 @@ 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--; + } + } + + if (priv->priv_dev_ctx && priv->priv_dev_ctx->miscdev) { + devm_remove_action(dev, if_misc_deregister, &priv->priv_dev_ctx->miscdev= ); + misc_deregister(priv->priv_dev_ctx->miscdev); + } + /* No need to check, if reserved memory is allocated * before calling for its release. Or clearing the * un-set bit. @@ -457,6 +1222,7 @@ static int se_if_probe(struct platform_device *pdev) priv->if_defs.success_tag =3D info->success_tag; priv->if_defs.base_api_ver =3D info->base_api_ver; priv->if_defs.fw_api_ver =3D info->fw_api_ver; + INIT_LIST_HEAD(&priv->dev_ctx_list); =20 if (info->reserved_dma_ranges) { ret =3D of_reserved_mem_device_init(dev); @@ -468,6 +1234,14 @@ static int se_if_probe(struct platform_device *pdev) } } =20 + ret =3D init_device_context(priv, 0, &priv->priv_dev_ctx, &se_if_fops); + if (ret) { + dev_err(dev, + "Failed[0x%x] to create device contexts.\n", + ret); + goto exit; + } + ret =3D se_soc_info(priv); if (ret) { dev_err(dev, diff --git a/drivers/firmware/imx/se_ctrl.h b/drivers/firmware/imx/se_ctrl.h index fa2804c5f7e3..52885990cee2 100644 --- a/drivers/firmware/imx/se_ctrl.h +++ b/drivers/firmware/imx/se_ctrl.h @@ -13,6 +13,7 @@ #define MAX_FW_LOAD_RETRIES 50 =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 @@ -31,7 +32,7 @@ struct se_clbk_handle { struct completion done; bool signal_rcvd; - atomic_t pending_hdr; + struct se_if_device_ctx *dev_ctx; u32 rx_msg_sz; /* Assignment of the rx_msg buffer to held till the * received content as part callback function, is copied. @@ -46,6 +47,40 @@ struct se_imem_buf { u32 state; }; =20 +struct se_buf_desc { + u8 *shared_buf_ptr; + u8 *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 secure_mem; + 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; + + struct mutex fops_lock; + + struct se_shared_mem_mgmt_info se_shared_mem_mgmt; + struct list_head link; +}; + /* Header of the messages exchange with the EdgeLock Enclave */ struct se_msg_hdr { u8 ver; @@ -89,6 +124,11 @@ struct se_if_priv { struct mbox_chan *tx_chan, *rx_chan; =20 struct se_if_defines if_defs; + + struct se_if_device_ctx *priv_dev_ctx; + struct list_head dev_ctx_list; + u32 active_devctx_count; + u32 dev_ctx_mono_count; }; =20 #endif diff --git a/include/uapi/linux/se_ioctl.h b/include/uapi/linux/se_ioctl.h new file mode 100644 index 000000000000..c2d0a92ef626 --- /dev/null +++ b/include/uapi/linux/se_ioctl.h @@ -0,0 +1,94 @@ +/* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Cla= use*/ +/* + * Copyright 2024 NXP + */ + +#ifndef SE_IOCTL_H +#define SE_IOCTL_H + +/* IOCTL definitions. */ + +struct se_ioctl_setup_iobuf { + u8 *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 *tx_buf; + int tx_buf_sz; + u32 *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.34.1