From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pj1-f47.google.com (mail-pj1-f47.google.com [209.85.216.47]) by mx.groups.io with SMTP id smtpd.web11.34913.1629176927034237213 for ; Mon, 16 Aug 2021 22:08:47 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20161025 header.b=UpP1iHnV; spf=pass (domain: gmail.com, ip: 209.85.216.47, mailfrom: kuqin12@gmail.com) Received: by mail-pj1-f47.google.com with SMTP id bo18so30288198pjb.0 for ; Mon, 16 Aug 2021 22:08:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=yFOGXhVlhKNGb5z0WxJwvlk8xoJviBkZAOOo/3/XGKQ=; b=UpP1iHnV8KLbAeJ8yXQXQO9BL/0PKD3J3tRPXjMVmbqs2aXt88Cs8HxezUHJgbIJ3R bdk6lNFCnizUmyWmtEWU8OEl8gm7vqXfwswNockrYOWTzGP6t0r0kgAUNnzKKg5SikgG C1cgLq1W6Z5NHS0jL2+BnpSyMx5CZiKn/zPDAMJQjhL3gm9L/AsYtsrUekz/QK4CdCtx LuxWNm0Hp51sgQ6gde8aY0v0SjjNxvcb3Tgc5FaNi7aTlWg48HO9YRKtcdh025uZmmic 2CTLwHP56OMRf8aYVDVWdS7I8mZHKviPbCm419LdOQoh5s8fXLGAYSfNEvaR59IL4uqp smMQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=yFOGXhVlhKNGb5z0WxJwvlk8xoJviBkZAOOo/3/XGKQ=; b=ulD6pB2wujxuadrcLnwwnmj5tsBpqafJwMkH0E1IOjHoAMlwsL4Zl1OeP8yedmAxFa q+0832IzUg4FZFbGggbBwhvlwutEEk6tDQSfqNnlXN4n2bgiCguok7a4jcJELuUUZFJu z/gDQT+GZ0+8MM8bNvXe079uoSYrxwJCICnYjTGGHYFQ2AFGvgL9FDunc2qL5g53wasI JVTn0EBJGeNzLNAXY4nsOdiu7ZG054U+HbAol1BDMirhhJ8EH5zySgLXk5hDoROU/ktm jQ4sA4zRZnMZBQRvzpgNFNDW71U6jbHh6rDbcrf5V/nWZ7rwzJJ9umg9QNx4CUH6rPhK T9fA== X-Gm-Message-State: AOAM5308Y1wHTLMteIGGES9Z9Ke0TekXvmBAvYej6PpY1sKa0iIL+/8c 4VtUdBWo1TMa5KKMNAMCRnZoFMbw48+Exg== X-Google-Smtp-Source: ABdhPJyYzeX7fhkYbfc2Ty20gurzv0lY1eQpFMiKfGGuKQBQ1W1vSYppOXW229ibBhiFHZHMFBktIA== X-Received: by 2002:a17:90a:a96:: with SMTP id 22mr1684387pjw.156.1629176926419; Mon, 16 Aug 2021 22:08:46 -0700 (PDT) Return-Path: Received: from localhost.localdomain ([50.35.88.161]) by smtp.gmail.com with ESMTPSA id i5sm737965pjk.47.2021.08.16.22.08.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 16 Aug 2021 22:08:46 -0700 (PDT) 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 v3 2/7] MdePkg: MmCommunication: Introduce EFI_MM_COMMUNICATE_HEADER_V3 to MdePkg Date: Mon, 16 Aug 2021 22:08:02 -0700 Message-Id: <20210817050807.766-3-kuqin12@gmail.com> X-Mailer: git-send-email 2.32.0.windows.1 In-Reply-To: <20210817050807.766-1-kuqin12@gmail.com> References: <20210817050807.766-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 header structure, intending to provide better portability between different architectures (IA32 & X64) and adapt to flexible array supported by modern compilers. The original MessageLength field of EFI_MM_COMMUNICATE_HEADER, as a generic definition, was used for both PEI and DXE MM communication. On a system that supports PEI MM launch, but operates PEI in 32bit mode and MM foundation in 64bit, the current EFI_MM_COMMUNICATE_HEADER definition will cause structure parse error due to UINTN used. This introduction removes the architecture dependent field by defining this field as UINT64. The new signature could help identifying whether the data received is compiliant with this new data structure, which will help for binary release modules to identify usage of legacy data structure. Version field is also added to indicate the current version of header in case there is need for minor modification in the future. The data field of MM communicate message is replaced with flexible array to allow users not having to consume extra data during communicate and author code more intrinsically. 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 communicate v3 - Used flexible arrays [Marvin] - Added static assert [Michael] MdePkg/Include/Pi/PiMultiPhase.h | 55 ++++++++++++++++++++ MdePkg/MdePkg.dec | 5 ++ 2 files changed, 60 insertions(+) diff --git a/MdePkg/Include/Pi/PiMultiPhase.h b/MdePkg/Include/Pi/PiMultiPhase.h index 89280d9d3506..8c60338091b3 100644 --- a/MdePkg/Include/Pi/PiMultiPhase.h +++ b/MdePkg/Include/Pi/PiMultiPhase.h @@ -103,6 +103,17 @@ SPDX-License-Identifier: BSD-2-Clause-Patent #define EFI_SMRAM_CLOSED EFI_MMRAM_CLOSED #define EFI_SMRAM_LOCKED EFI_MMRAM_LOCKED +/// +/// MM Communicate header constants +/// +#define COMMUNICATE_HEADER_V3_GUID \ + { \ + 0x68e8c853, 0x2ba9, 0x4dd7, { 0x9a, 0xc0, 0x91, 0xe1, 0x61, 0x55, 0xc9, 0x35 } \ + } + +#define EFI_MM_COMMUNICATE_HEADER_V3_SIGNATURE 0x4D434833 // "MCH3" +#define EFI_MM_COMMUNICATE_HEADER_V3_VERSION 3 + /// /// Structure describing a MMRAM region and its accessibility attributes. /// @@ -149,6 +160,48 @@ typedef struct _EFI_MM_RESERVED_MMRAM_REGION { UINT64 MmramReservedSize; } EFI_MM_RESERVED_MMRAM_REGION; +#pragma pack(1) + +/// +/// To avoid confusion in interpreting frames, the buffer communicating to MM core through +/// EFI_MM_COMMUNICATE3 or later should always start with EFI_MM_COMMUNICATE_HEADER_V3. +/// +typedef struct { + /// + /// Indicator GUID for MM core that the communication buffer is compliant with this v3 header. + /// Must be gCommunicateHeaderV3Guid. + /// + EFI_GUID HeaderGuid; + /// + /// Signature to indicate data is compliant with new MM communicate header structure. + /// Must be "MCH3". + /// + UINT32 Signature; + /// + /// MM communicate data format version, MM foundation entry point should check if incoming + /// data is a supported format before proceeding. + /// Must be 3. + /// + UINT32 Version; + /// + /// Allows for disambiguation of the message format. + /// + EFI_GUID MessageGuid; + /// + /// Describes the size of MessageData (in bytes) and does not include the size of the header. + /// + UINT64 MessageSize; + /// + /// Designates an array of bytes that is MessageSize in size. + /// + UINT8 MessageData[]; +} EFI_MM_COMMUNICATE_HEADER_V3; + +#pragma pack() + +STATIC_ASSERT ((sizeof (EFI_MM_COMMUNICATE_HEADER_V3) == OFFSET_OF (EFI_MM_COMMUNICATE_HEADER_V3, MessageData)), \ + "sizeof (EFI_MM_COMMUNICATE_HEADER_V3) does not align with the beginning of flexible array MessageData"); + typedef enum { EFI_PCD_TYPE_8, EFI_PCD_TYPE_16, @@ -208,4 +261,6 @@ EFI_STATUS IN VOID *ProcedureArgument ); +extern EFI_GUID gCommunicateHeaderV3Guid; + #endif diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec index a28a2daaffa8..411079a4343e 100644 --- a/MdePkg/MdePkg.dec +++ b/MdePkg/MdePkg.dec @@ -823,6 +823,11 @@ [Guids] # gLinuxEfiInitrdMediaGuid = {0x5568e427, 0x68fc, 0x4f3d, {0xac, 0x74, 0xca, 0x55, 0x52, 0x31, 0xcc, 0x68}} + # + # GUID indicates the MM communication data is compliant with v3 communication header. + # + gCommunicateHeaderV3Guid = { 0x68e8c853, 0x2ba9, 0x4dd7, { 0x9a, 0xc0, 0x91, 0xe1, 0x61, 0x55, 0xc9, 0x35 } } + [Guids.IA32, Guids.X64] ## Include/Guid/Cper.h gEfiIa32X64ErrorTypeCacheCheckGuid = { 0xA55701F5, 0xE3EF, 0x43de, { 0xAC, 0x72, 0x24, 0x9B, 0x57, 0x3F, 0xAD, 0x2C }} -- 2.32.0.windows.1