From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pg1-f177.google.com (mail-pg1-f177.google.com [209.85.215.177]) by mx.groups.io with SMTP id smtpd.web12.1453.1641521746311083671 for ; Thu, 06 Jan 2022 18:15:46 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20210112 header.b=iEY072N+; spf=pass (domain: gmail.com, ip: 209.85.215.177, mailfrom: kuqin12@gmail.com) Received: by mail-pg1-f177.google.com with SMTP id v25so4191655pge.2 for ; Thu, 06 Jan 2022 18:15:46 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=i5OSoZX72TNES0leZFACzFPKp+jDuqhunoRJdzSzF9M=; b=iEY072N+vrYgz2suRLrQF/vnaO/b4rAP4eUPmkadMt7bGBhwWLONmy35vYgiXLX+YC QWZMHY06oVwdEeNmRH+XWc9Lr93o9XTGIQGl2tHU9ztbQO0+0bqnkLBx6F98XzYZiLTO L20kwB3RS2rGPF+vT3tlbBrP0zo9JNF3XVQ1Ed7B4PGMdB6T1PLlgZaa/JCYMiqM7Ew+ UTFBMy6vyT7wiTDh1X62f6/0tB61VCgtjSQUna0dHmWNJqim7EUf50EPsyix9glxPGyl tex1v8gXIIwFL6y17/PcPG+yPf+xjKd5sM/I94EJaoO677+Lahb3yxs/o/uFWvVdfAy8 YtJQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=i5OSoZX72TNES0leZFACzFPKp+jDuqhunoRJdzSzF9M=; b=4cUM3iYtCrHIuwfMwDr1X4sDeGwQgGnGubHnrISq+WVY/3KCprl8dSSl0lMcklLIMI /OiiWcl2L9fbpjhxp6+XND7+qUQdJFJLVEG3DCyxBGNBZLQY+aSC3qNESgIntGxTKynh twtPitwltCwPUiAxaH1pE11VA+FzWx/kSuix4pUXsHvN4MJhZMce++kRzQ5bn7zHkXCK f/dP12AiJytvlOvIKacwPk4kSIVIjSFdSoIeh2LcdvebL9T2dOblDadOd7MphEkq8lx5 Av+dvD24+USPEW2rWdUOSIzmw50HfUu1clmQ3ZfKa2Gk3xI3PIgukTfpoQTOJE6ht/9H 6RjA== X-Gm-Message-State: AOAM532hGj8ssLrZfRCtloCyVUlGlV6XunuujzYb0A/Xo0749K213JWm CV9ASo5z0YZGlyhuZHeO/jwI61rVPcY= X-Google-Smtp-Source: ABdhPJwuI2vWSQO11DBs0JCEAfe6s7M8tHhYiuHQFYF8L4ZzLZsDJq0N7yjxGBAjwQukyBlPNT4CMw== X-Received: by 2002:a63:211a:: with SMTP id h26mr54517394pgh.239.1641521745757; Thu, 06 Jan 2022 18:15:45 -0800 (PST) Return-Path: Received: from localhost.localdomain ([50.35.74.198]) by smtp.gmail.com with ESMTPSA id j3sm3894875pfc.196.2022.01.06.18.15.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 06 Jan 2022 18:15:45 -0800 (PST) From: "Kun Qin" To: devel@edk2.groups.io Cc: Michael D Kinney , Liming Gao , Zhiguang Liu , Hao A Wu , =?UTF-8?q?Marvin=20H=C3=A4user?= , Bret Barkelew , Michael Kubacki Subject: [PATCH v4 3/7] MdePkg: MmCommunication: Introduce EFI_MM_COMMUNICATION3_PROTOCOL to MdePkg Date: Thu, 6 Jan 2022 18:15:28 -0800 Message-Id: <20220107021532.1322-4-kuqin12@gmail.com> X-Mailer: git-send-email 2.34.1.windows.1 In-Reply-To: <20220107021532.1322-1-kuqin12@gmail.com> References: <20220107021532.1322-1-kuqin12@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3398 REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3430 This change introduces a new definition for MM communicate protocol v3. This protocol will be installed under a new GUID in contrast to exisiting EFI_MM_COMMUNICATION_PROTOCOL. Data communicated to MM through EFI_MM_COMMUNICATION3_PROTOCOL should always start with EFI_MM_COMMUNICATE_HEADER_V3 with its HeaderGuid, Signature and Version fields properly populated. Cc: Michael D Kinney Cc: Liming Gao Cc: Zhiguang Liu Cc: Hao A Wu Cc: Marvin Häuser Cc: Bret Barkelew Cc: Michael Kubacki Signed-off-by: Kun Qin --- Notes: v3: - Newly introduced v3 of communicate protocol v4: - Rebased with uncrustify changes. MdePkg/Include/Protocol/MmCommunication3.h | 70 ++++++++++++++++++++ MdePkg/MdePkg.dec | 3 + 2 files changed, 73 insertions(+) diff --git a/MdePkg/Include/Protocol/MmCommunication3.h b/MdePkg/Include/Protocol/MmCommunication3.h new file mode 100644 index 000000000000..0df9e5b875b7 --- /dev/null +++ b/MdePkg/Include/Protocol/MmCommunication3.h @@ -0,0 +1,70 @@ +/** @file + EFI MM Communication Protocol 2 as defined in the PI 1.7 errata A specification. + + This protocol provides a means of communicating between drivers outside of MM and MMI + handlers inside of MM. + + Copyright (c) 2017, Intel Corporation. All rights reserved.
+ Copyright (c) 2019, Arm Limited. All rights reserved.
+ SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef MM_COMMUNICATION3_H_ +#define MM_COMMUNICATION3_H_ + +#include + +#define EFI_MM_COMMUNICATION3_PROTOCOL_GUID \ + { \ + 0xf7234a14, 0xdf2, 0x46c0, { 0xad, 0x28, 0x90, 0xe6, 0xb8, 0x83, 0xa7, 0x2f } \ + } + +typedef struct _EFI_MM_COMMUNICATION3_PROTOCOL EFI_MM_COMMUNICATION3_PROTOCOL; + +/** + Communicates with a registered handler. + + This function provides a service to send and receive messages from a registered UEFI service. + + @param[in] This The EFI_MM_COMMUNICATION3_PROTOCOL instance. + @param[in, out] CommBufferPhysical Physical address of the MM communication buffer, of which content must + start with EFI_MM_COMMUNICATE_HEADER_V3. + @param[in, out] CommBufferVirtual Virtual address of the MM communication buffer, of which content must + start with EFI_MM_COMMUNICATE_HEADER_V3. + @param[in, out] CommSize The size of the data buffer being passed in. On exit, the size of data + being returned. Zero if the handler does not wish to reply with any data. + This parameter is optional and may be NULL. + + @retval EFI_SUCCESS The message was successfully posted. + @retval EFI_INVALID_PARAMETER CommBufferPhysical was NULL or CommBufferVirtual was NULL. + @retval EFI_BAD_BUFFER_SIZE The buffer is too large for the MM implementation. + If this error is returned, the MessageLength field + in the CommBuffer header or the integer pointed by + CommSize, are updated to reflect the maximum payload + size the implementation can accommodate. + @retval EFI_ACCESS_DENIED The CommunicateBuffer parameter or CommSize parameter, + if not omitted, are in address range that cannot be + accessed by the MM environment. + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_MM_COMMUNICATE3)( + IN CONST EFI_MM_COMMUNICATION3_PROTOCOL *This, + IN OUT VOID *CommBufferPhysical, + IN OUT VOID *CommBufferVirtual, + IN OUT UINTN *CommSize OPTIONAL + ); + +/// +/// EFI MM Communication Protocol provides runtime services for communicating +/// between DXE drivers and a registered MMI handler. +/// +struct _EFI_MM_COMMUNICATION3_PROTOCOL { + EFI_MM_COMMUNICATE3 Communicate; +}; + +extern EFI_GUID gEfiMmCommunication3ProtocolGuid; + +#endif diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec index 11c08e617511..8c61661e4ee7 100644 --- a/MdePkg/MdePkg.dec +++ b/MdePkg/MdePkg.dec @@ -1357,6 +1357,9 @@ [Protocols] ## Include/Protocol/MmCommunication2.h gEfiMmCommunication2ProtocolGuid = { 0x378daedc, 0xf06b, 0x4446, { 0x83, 0x14, 0x40, 0xab, 0x93, 0x3c, 0x87, 0xa3 }} + ## Include/Protocol/MmCommunication3.h + gEfiMmCommunication3ProtocolGuid = { 0xf7234a14, 0xdf2, 0x46c0, { 0xad, 0x28, 0x90, 0xe6, 0xb8, 0x83, 0xa7, 0x2f }} + # # Protocols defined in UEFI2.1/UEFI2.0/EFI1.1 # -- 2.34.1.windows.1