From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by spool.mail.gandi.net (Postfix) with ESMTPS id 800EA941D98 for ; Mon, 18 Dec 2023 16:12:50 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=v5NzgFhcW3aI7XDk+SMeEJ7fKd4zgtT26ydYXZKiBU0=; c=relaxed/simple; d=groups.io; h=ARC-Seal:ARC-Message-Signature:ARC-Authentication-Results:Received-SPF:From:To:CC:Subject:Date:Message-ID:In-Reply-To:References:MIME-Version:Precedence:List-Subscribe:List-Help:Sender:List-Id:Mailing-List:Delivered-To:Reply-To:List-Unsubscribe-Post:List-Unsubscribe:Content-Transfer-Encoding:Content-Type; s=20140610; t=1702915969; v=1; b=fd7MkJSdNw/UFFnKZ5/cBHl638IeJl/1CyZfukAP38XdHMjUofi+Hi8m1EDftygUQo2e56XC jPIeluFN3OloQt6MdHVUIOj2I8S6LKA9mwRiCpMlkZaNtBmBJtAqcZS8fbv/KQnUdVYbgKcVRBc dlJ/UVWfXHYDd+2y/pBeuAY8= X-Received: by 127.0.0.2 with SMTP id l9EZYY7687511xO0y6KNSAlH; Mon, 18 Dec 2023 08:12:49 -0800 X-Received: from NAM11-CO1-obe.outbound.protection.outlook.com (NAM11-CO1-obe.outbound.protection.outlook.com [40.107.220.88]) by mx.groups.io with SMTP id smtpd.web11.47617.1702915968606424289 for ; Mon, 18 Dec 2023 08:12:48 -0800 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=QFi8a0X4mZ/k5ZjqzIPqs7plCwnMFlRoAvay+pvkE1Tj1d3lSfQQr0ihiXVzNBZNq8YzKgkeXKEi7S9+EpCnqliQp81DhoV//+ru+/9GPT0Iv9c60i4D3p7Kl3AoK2zw+xkWifgAtNg9ZparALGk1jJJTQlAWHKL7EjkdahhczsPLRek/IjkyvS99gJo4JMnv/KkJniqcGh2+Cm1kWT3gaWMJF3CGelh5v9ZsFRoKWsC0fpMV5g8uP66Pg/i88IMBMuRVJNYhjKPgbbxsegmKmF8BT/GNPmIkGjXGMhhd99J9s2OilxhLrzlsScS21THR2NuznIFUC7s2iw1MzGL+w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; 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=zHc0JrJoKveSYYVl/pGN02yAqoVBksDtW+ji3cxDOZg=; b=bKsKdlLvlAtC3JcaEpiIg/XQWBUCEIuXUL5muA0NCmolUGfZfkeP4z/RxIPgLDyMROE2ow7PDlPYjqp05dmIQsiykZY7Q4Dzpfp42yF6EbUG6loZXaSr7pGliL1yfz8b6b/lP7AdARrCRXWIkOEQmeRi/e3ICcSEZde+OtEyeVxDydrHnrU6yXqNTnf4H9ioTJ7fmXK5JWgPMGUehOitbytARk9e4dBj2BSFXF4+CE7Pno7vKodd0dRn2hBitvzrXt5IDkS5tzLkoc8hbyxZzc3qh5LqJYPls1LjUqA7ayt1fST4EJGOHGxaeO0iWUapw4KhXjWQcd94nm1XBhaVlg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 165.204.84.17) smtp.rcpttodomain=edk2.groups.io smtp.mailfrom=amd.com; dmarc=pass (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com; dkim=none (message not signed); arc=none (0) X-Received: from SJ0PR05CA0018.namprd05.prod.outlook.com (2603:10b6:a03:33b::23) by DS7PR12MB5791.namprd12.prod.outlook.com (2603:10b6:8:76::12) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7091.37; Mon, 18 Dec 2023 16:12:43 +0000 X-Received: from CO1PEPF000042A7.namprd03.prod.outlook.com (2603:10b6:a03:33b:cafe::af) by SJ0PR05CA0018.outlook.office365.com (2603:10b6:a03:33b::23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7113.17 via Frontend Transport; Mon, 18 Dec 2023 16:12:43 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 165.204.84.17) smtp.mailfrom=amd.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=amd.com; Received-SPF: Pass (protection.outlook.com: domain of amd.com designates 165.204.84.17 as permitted sender) receiver=protection.outlook.com; client-ip=165.204.84.17; helo=SATLEXMB04.amd.com; pr=C X-Received: from SATLEXMB04.amd.com (165.204.84.17) by CO1PEPF000042A7.mail.protection.outlook.com (10.167.243.36) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.20.7113.14 via Frontend Transport; Mon, 18 Dec 2023 16:12:43 +0000 X-Received: from SATLEXMB04.amd.com (10.181.40.145) by SATLEXMB04.amd.com (10.181.40.145) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.34; Mon, 18 Dec 2023 10:12:42 -0600 X-Received: from BLR-LAB-SFW01.amd.com (10.180.168.240) by SATLEXMB04.amd.com (10.181.40.145) with Microsoft SMTP Server id 15.1.2507.34 via Frontend Transport; Mon, 18 Dec 2023 10:12:41 -0600 From: "Abdul Lateef Attar via groups.io" To: CC: Abdul Lateef Attar , Pierre Gondois , Sami Mujawar Subject: [edk2-devel] [PATCH v4 4/4] DynamicTablesPkg: AML Code generation to invoke a method Date: Mon, 18 Dec 2023 21:42:30 +0530 Message-ID: In-Reply-To: References: MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CO1PEPF000042A7:EE_|DS7PR12MB5791:EE_ X-MS-Office365-Filtering-Correlation-Id: f1ef4d18-20e4-4922-2c38-08dbffe42a64 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam-Message-Info: CmyGFiW+KlEY+Poh1qye58HVJKRYlvmDb7PD6x9IbL3Q2JTcH3B+/50iiTBjGrlJGzYLOq5Y/hq2hNVzFtEBw9/+cBCVtlz59RKOgx2LS0nIti05IPlmalotgvG5lYsMHYtKD5BGJlJG4MSr3FN8RFEBd+bGiATKICqlB7UeAYlgz+W2IZ+fL8D5UtkrhxqgO7xGaIv5zOoDCUU6/p4Q605vs73univNTJrh63z4x5cTya/H3D2k8pwD7ffT20rL62F+iOSc9B6rCEMKMXJ/zExm2JsDR9L8Aw7+Mh9cRaHT69HJxyLK2QJcKiaW29uKbGq64WwxZIfmVvjuNelKYYNFBXx9QvzDiv7sy1FfrqcEcsWwjX0McOjN81CxxqXrU0C/llRDkqgUs/i7rlip/xVjgL0b5OIDr66GosNaL5MjH0AFaxo23VDms7jYqam0LjMrbmzN4eMxrYNEPrMD1G27b6C+p/oGVmAFKTAA2CYdVOBcOTmlRCAyOjH2QKSaRKxyXo0ms+FstfHGH+d4U/Gil0s8Cbkpctcfrbg3YsUDE+BhuXqVYmeZ42yYchlMZuPl1ZKRYoFHXV8Gwm4jyVR/5HQsXBQoCLC/FtWV+JRnSVeOwOLIzr9aVwvtKpL+bdHi2c53amR6CFUxhQLaFZGb8k7DdAaJfRN16K+R9vhCaOji1O3FrtWJ7apcm+WnzRzBZBO/7OG5vSs5kKNEPIRm9PeXKoZ6ZBvKc7DB2PIrjfBwzCzrXJORuQVEy3M0fRnerh8TUvaiun8AaIsO1w== X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 18 Dec 2023 16:12:43.0329 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: f1ef4d18-20e4-4922-2c38-08dbffe42a64 X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=3dd8961f-e488-4e60-8e11-a82d994e183d;Ip=[165.204.84.17];Helo=[SATLEXMB04.amd.com] X-MS-Exchange-CrossTenant-AuthSource: CO1PEPF000042A7.namprd03.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS7PR12MB5791 Precedence: Bulk List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,AbdulLateef.Attar@amd.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: kU0AcyBeMB6OxjcgQq8E3B6rx7686176AA= Content-Transfer-Encoding: quoted-printable Content-Type: text/plain X-GND-Status: LEGIT Authentication-Results: spool.mail.gandi.net; dkim=pass header.d=groups.io header.s=20140610 header.b=fd7MkJSd; dmarc=none; spf=pass (spool.mail.gandi.net: domain of bounce@groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce@groups.io From: Abdul Lateef Attar Adds API to generate AML code to invoke/call another method. Also provides ability to pass arguments of type integer, string, ArgObj or LocalObj. Cc: Pierre Gondois Cc: Sami Mujawar Signed-off-by: Abdul Lateef Attar --- .../Include/Library/AmlLib/AmlLib.h | 94 ++++++++ .../Common/AmlLib/CodeGen/AmlCodeGen.c | 221 +++++++++++++++++- 2 files changed, 314 insertions(+), 1 deletion(-) diff --git a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h b/DynamicTabl= esPkg/Include/Library/AmlLib/AmlLib.h index eb8740692f..5e6a6fde21 100644 --- a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h +++ b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h @@ -101,6 +101,53 @@ typedef enum { AmlAddressRangeMax =3D 4 } AML_MEMORY_ATTRIBUTES_MTP; =20 +/** Method parameter types + + Possible values are: + 0 - AmlMethodParamTypeInteger + 1 - AmlMethodParamTypeString + 2 - AmlMethodParamTypeArg + 3 - AmlMethodParamTypeLocal + + @par Reference(s) + - ACPI 6.5, s20.2.5 "Term Objects Encoding" + +**/ +typedef enum { + AmlMethodParamTypeInteger =3D 0, + AmlMethodParamTypeString =3D 1, + AmlMethodParamTypeArg =3D 2, + AmlMethodParamTypeLocal =3D 3 +} AML_METHOD_PARAM_TYPE; + +/** structure to hold AML method parameter types + Type - Type of parameter + Data - holds data of parameter + if Type is AmlMethodParamTypeInteger + then Data is of type Integer to hold integer value. + if Type is AmlMethodParamTypeString + then Data contains null terminated string. + If Type is AmlMethodParamTypeArg + then Data contains the Argument number, + 0 to 6 are supported value. + If Type is AmlMethodParamTypeLocal + then Data contains the Local variable number, + 0 to 7 are supported value. + DataSize - for future use +**/ +typedef struct { + AML_METHOD_PARAM_TYPE Type; + + union { + UINT8 Arg; + UINT8 Local; + UINT64 Integer; + VOID *Buffer; + } Data; + + UINTN DataSize; +} AML_METHOD_PARAM; + /** Parse the definition block. =20 The function parses the whole AML blob. It starts with the ACPI DSDT/SSD= T @@ -1693,4 +1740,51 @@ AmlAddNameStringToNamedPackage ( IN AML_OBJECT_NODE_HANDLE NamedNode ); =20 +/** AML code generation to invoke/call another method. + + This method is subset implementation of MethodInvocation + defined in the ACPI specification 6.5, + section 20.2.5 "Term Objects Encoding". + Added integer, string, ArgObj and LocalObj support. + + Example 1: + AmlCodeGenInvokeMethod ("MET0", 0, NULL, ParentNode); + is equivalent of the following ASL code: + MET0 (); + + Example 2: + AML_METHOD_PARAM Param[4]; + Param[0].Data.Integer =3D 0x100; + Param[0].Type =3D AmlMethodParamTypeInteger; + Param[1].Data.Buffer =3D "TEST"; + Param[1].Type =3D AmlMethodParamTypeString; + Param[2].Data.Arg =3D 0; + Param[2].Type =3D AmlMethodParamTypeArg; + Param[3].Data.Local =3D 2; + Param[3].Type =3D AmlMethodParamTypeLocal; + AmlCodeGenInvokeMethod ("MET0", 4, Param, ParentNode); + + is equivalent of the following ASL code: + MET0 (0x100, "TEST", Arg0, Local2); + + @param [in] MethodNameString Method name to be called/invoked. + @param [in] NumArgs Number of arguments to be passed, + 0 to 7 are permissible values. + @param [in] Parameter contains the parameter data. + @param [in] ParentNode set ParentNode as the parent + of the node created. + + @retval EFI_SUCCESS Success. + @retval EFI_INVALID_PARAMETER Invalid parameter. + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. + **/ +EFI_STATUS +EFIAPI +AmlCodeGenInvokeMethod ( + IN CONST CHAR8 *MethodNameString, + IN UINT8 NumArgs, + IN AML_METHOD_PARAM *Parameters OPTIONAL, + IN AML_NODE_HANDLE ParentNode + ); + #endif // AML_LIB_H_ diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c b/= DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c index a6db34fb97..3565a4dd58 100644 --- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c +++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c @@ -2,6 +2,7 @@ AML Code Generation. =20 Copyright (c) 2020 - 2022, Arm Limited. All rights reserved.
+ Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved.
=20 SPDX-License-Identifier: BSD-2-Clause-Patent **/ @@ -921,7 +922,7 @@ AmlCodeGenNameUnicodeString ( Status =3D AmlCreateDataNode ( EAmlNodeDataTypeRaw, (CONST UINT8 *)String, - StrSize (String), + (UINT32)StrSize (String), &DataNode ); if (EFI_ERROR (Status)) { @@ -3849,3 +3850,221 @@ exit_handler: =20 return Status; } + +/** AML code generation to invoke/call another method. + + This method is subset implementation of MethodInvocation + defined in the ACPI specification 6.5, + section 20.2.5 "Term Objects Encoding". + Added integer, string, ArgObj and LocalObj support. + + Example 1: + AmlCodeGenInvokeMethod ("MET0", 0, NULL, ParentNode); + is equivalent of the following ASL code: + MET0 (); + + Example 2: + AML_METHOD_PARAM Param[4]; + Param[0].Data.Integer =3D 0x100; + Param[0].Type =3D AmlMethodParamTypeInteger; + Param[1].Data.Buffer =3D "TEST"; + Param[1].Type =3D AmlMethodParamTypeString; + Param[2].Data.Arg =3D 0; + Param[2].Type =3D AmlMethodParamTypeArg; + Param[3].Data.Local =3D 2; + Param[3].Type =3D AmlMethodParamTypeLocal; + AmlCodeGenInvokeMethod ("MET0", 4, Param, ParentNode); + + is equivalent of the following ASL code: + MET0 (0x100, "TEST", Arg0, Local2); + + @param [in] MethodNameString Method name to be called/invoked. + @param [in] NumArgs Number of arguments to be passed, + 0 to 7 are permissible values. + @param [in] Parameter contains the parameter data. + @param [in] ParentNode set ParentNode as the parent + of the node created. + + @retval EFI_SUCCESS Success. + @retval EFI_INVALID_PARAMETER Invalid parameter. + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. + **/ +EFI_STATUS +EFIAPI +AmlCodeGenInvokeMethod ( + IN CONST CHAR8 *MethodNameString, + IN UINT8 NumArgs, + IN AML_METHOD_PARAM *Parameters OPTIONAL, + IN AML_NODE_HANDLE ParentNode + ) +{ + EFI_STATUS Status; + UINT8 Index; + CHAR8 *AmlNameString; + UINT32 AmlNameStringSize; + AML_DATA_NODE *DataNode; + AML_OBJECT_NODE *IntNode; + AML_NODE_HANDLE HeadNode; + AML_NODE_HANDLE CurrentNode; + AML_OBJECT_NODE *ObjectNode; + + if ((MethodNameString =3D=3D NULL) || (ParentNode =3D=3D NULL)) { + ASSERT (0); + return EFI_INVALID_PARAMETER; + } + + if ((NumArgs > 7) || + ((Parameters =3D=3D NULL) && (NumArgs > 0))) + { + ASSERT (0); + return EFI_INVALID_PARAMETER; + } + + if (Parameters !=3D NULL) { + /// Validate and convert the Parameters to the stream of node + HeadNode =3D NULL; + CurrentNode =3D NULL; + for (Index =3D 0; Index < NumArgs; Index++) { + switch (Parameters[Index].Type) { + case AmlMethodParamTypeInteger: + IntNode =3D NULL; + Status =3D AmlCodeGenInteger (Parameters[Index].Data.Integer, &= IntNode); + if (EFI_ERROR (Status)) { + ASSERT_EFI_ERROR (Status); + goto exit_handler; + } + + CurrentNode =3D (AML_NODE_HANDLE)IntNode; + break; + case AmlMethodParamTypeString: + ObjectNode =3D NULL; + if (Parameters[Index].Data.Buffer =3D=3D NULL) { + ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER); + Status =3D EFI_INVALID_PARAMETER; + goto exit_handler; + } + + Status =3D AmlCodeGenString (Parameters[Index].Data.Buffer, &Obj= ectNode); + if (EFI_ERROR (Status)) { + ASSERT_EFI_ERROR (Status); + goto exit_handler; + } + + CurrentNode =3D (AML_NODE_HANDLE)ObjectNode; + break; + case AmlMethodParamTypeArg: + ObjectNode =3D NULL; + if (Parameters[Index].Data.Arg > (UINT8)(AML_ARG6 - AML_ARG0)) { + ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER); + Status =3D EFI_INVALID_PARAMETER; + goto exit_handler; + } + + Status =3D AmlCreateObjectNode ( + AmlGetByteEncodingByOpCode (AML_ARG0 + Parameters[Ind= ex].Data.Arg, 0), + 0, + &ObjectNode + ); + if (EFI_ERROR (Status)) { + ASSERT_EFI_ERROR (Status); + goto exit_handler; + } + + CurrentNode =3D (AML_NODE_HANDLE)ObjectNode; + break; + case AmlMethodParamTypeLocal: + ObjectNode =3D NULL; + if (Parameters[Index].Data.Local > (UINT8)(AML_LOCAL7 - AML_LOCA= L0)) { + ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER); + Status =3D EFI_INVALID_PARAMETER; + goto exit_handler; + } + + Status =3D AmlCreateObjectNode ( + AmlGetByteEncodingByOpCode (AML_LOCAL0 + Parameters[I= ndex].Data.Local, 0), + 0, + &ObjectNode + ); + if (EFI_ERROR (Status)) { + ASSERT_EFI_ERROR (Status); + goto exit_handler; + } + + CurrentNode =3D (AML_NODE_HANDLE)ObjectNode; + break; + default: + ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER); + Status =3D EFI_INVALID_PARAMETER; + goto exit_handler; + break; + } + + if (HeadNode =3D=3D NULL) { + HeadNode =3D CurrentNode; + } else { + Status =3D AmlVarListAddTail ( + HeadNode, + CurrentNode + ); + if (EFI_ERROR (Status)) { + ASSERT_EFI_ERROR (Status); + goto exit_handler; + } + } + } + } + + /// Create called/invoked method name string + Status =3D ConvertAslNameToAmlName (MethodNameString, &AmlNameString); + if (EFI_ERROR (Status)) { + ASSERT_EFI_ERROR (Status); + goto exit_handler; + } + + Status =3D AmlGetNameStringSize (AmlNameString, &AmlNameStringSize); + if (EFI_ERROR (Status)) { + ASSERT_EFI_ERROR (Status); + FreePool (AmlNameString); + goto exit_handler; + } + + DataNode =3D NULL; + Status =3D AmlCreateDataNode ( + EAmlNodeDataTypeNameString, + (UINT8 *)AmlNameString, + AmlNameStringSize, + &DataNode + ); + FreePool (AmlNameString); + if (EFI_ERROR (Status)) { + ASSERT_EFI_ERROR (Status); + goto exit_handler; + } + + Status =3D AmlVarListAddTail ( + (AML_NODE_HANDLE)ParentNode, + (AML_NODE_HANDLE)DataNode + ); + if (EFI_ERROR (Status)) { + ASSERT_EFI_ERROR (Status); + goto exit_handler; + } + + Status =3D AmlVarListAddTail ( + (AML_NODE_HANDLE)ParentNode, + HeadNode + ); + if (EFI_ERROR (Status)) { + ASSERT_EFI_ERROR (Status); + goto exit_handler; + } + + return Status; + +exit_handler: + if (HeadNode !=3D NULL) { + AmlDeleteTree (HeadNode); + } + + return Status; +} --=20 2.34.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#112651): https://edk2.groups.io/g/devel/message/112651 Mute This Topic: https://groups.io/mt/103245330/7686176 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-