From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=2607:f8b0:4001:c06::242; helo=mail-io0-x242.google.com; envelope-from=ard.biesheuvel@linaro.org; receiver=edk2-devel@lists.01.org Received: from mail-io0-x242.google.com (mail-io0-x242.google.com [IPv6:2607:f8b0:4001:c06::242]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 8AE41222F4E29 for ; Sat, 23 Dec 2017 08:08:04 -0800 (PST) Received: by mail-io0-x242.google.com with SMTP id 87so23248350ior.5 for ; Sat, 23 Dec 2017 08:12:55 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc; bh=EE2LoELqu8CCNgI5IMwr2YsAhk44269Bcz9zf/WVJKE=; b=RUhLQ8V9+c9/8FHPOM+Y3YJPNeXXIe12Bl7l5FcL0B89TOB+U9POEt03Njkvh5P2Mm LMgoN261541Qf2TXdxr0kxq5wC8zeIBJWnnsNLoiYtGRoc80tfvC+eTv4TRfV4jMRc8V g+DUEl5vdEvqdr7wthPnlUhuLpZ3PfKVUKZjQ= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc; bh=EE2LoELqu8CCNgI5IMwr2YsAhk44269Bcz9zf/WVJKE=; b=CmSfd7+Fvpfz7urLnyFiCwAbQGZqsFcRBf7xjFK10SovM1cXtDTiCOyRSAvl8TxPVN uIqqnDb6T7jlwSRYpSx1Q+IBX6XoZ5GCtPUTcO83kgPbGLI9mgnb7Hfyuw3Ay2g3QdjZ ZU5Lj3K1O15QzfiLgNxl3gmRWY4U92aOyGHvUe9xhfUoQorq8LLYynEgjK/p6b6cIjZD KhYfSjwNELLErBcrapwoKMzB3f8hoTaH5CX85azKwGhhtOIqx/cri3HUU08cU/BuHgAS W9IHruno2ThZQ1jQ5TK/NmZczAsg+QeVzMa+cCaQMpvCZPFAiK8NY4s/pdSEBqbaqsO6 27VA== X-Gm-Message-State: AKGB3mKCWJtEOejRAayMFdvKGX1GBD/8EV/DUkarIJ7P6qVrrZ21DyJz r8H6gdw26q90YADnRqdPM7DtYfTRjju19FI/r+CiuYvCzKE= X-Google-Smtp-Source: ACJfBouNdh5ZKbjDTYy4AfwlyAqIGeLHoUOYEiBo3K0fTmd7EnMFyYEvWTjvOnMvtBmGFccN2hB1nlbHQlgkG7oIXgU= X-Received: by 10.107.27.84 with SMTP id b81mr22148691iob.43.1514045574912; Sat, 23 Dec 2017 08:12:54 -0800 (PST) MIME-Version: 1.0 Received: by 10.107.52.14 with HTTP; Sat, 23 Dec 2017 08:12:54 -0800 (PST) In-Reply-To: <20171222190821.12440-18-evan.lloyd@arm.com> References: <20171222190821.12440-1-evan.lloyd@arm.com> <20171222190821.12440-18-evan.lloyd@arm.com> From: Ard Biesheuvel Date: Sat, 23 Dec 2017 16:12:54 +0000 Message-ID: To: Evan Lloyd Cc: "edk2-devel@lists.01.org" , Arvind Chauhan , Daniil Egranov , Thomas Panakamattam Abraham , <"ard.biesheuvel@linaro.org"@arm.com>, <"leif.lindholm@linaro.org"@arm.com>, <"Matteo.Carlini@arm.com"@arm.com>, <"nd@arm.com"@arm.com> Subject: Re: [PATCH edk2-platforms v2 17/18] ARM/JunoPkg: Adding SCMI MTL library X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 23 Dec 2017 16:08:05 -0000 Content-Type: text/plain; charset="UTF-8" On 22 December 2017 at 19:08, wrote: > From: Girish Pathak > > This change adds a new Mailbox Transport Layer library for the Juno > platform. This library is required for ArmScmiDxe driver communication > with the SCP. > > Contributed-under: TianoCore Contribution Agreement 1.1 > Signed-off-by: Girish Pathak > --- > Platform/ARM/JunoPkg/ArmJuno.dec | 9 +- > Platform/ARM/JunoPkg/ArmJuno.dsc | 3 + > Platform/ARM/JunoPkg/Library/ArmMtl/ArmMtl.inf | 39 ++++ > Platform/ARM/JunoPkg/Library/ArmMtl/ArmMtlPrivate.h | 94 ++++++++++ > Platform/ARM/JunoPkg/Library/ArmMtl/ArmMtl.c | 195 ++++++++++++++++++++ > 5 files changed, 339 insertions(+), 1 deletion(-) > > diff --git a/Platform/ARM/JunoPkg/ArmJuno.dec b/Platform/ARM/JunoPkg/ArmJuno.dec > index 60cef6d23a2d904103b9806d871fd2b89fff51c3..b733480c3198d135df16ca024b5e85ff350e11c7 100644 > --- a/Platform/ARM/JunoPkg/ArmJuno.dec > +++ b/Platform/ARM/JunoPkg/ArmJuno.dec > @@ -1,5 +1,5 @@ > # > -# Copyright (c) 2013-2015, ARM Limited. All rights reserved. > +# Copyright (c) 2013-2017, ARM Limited. All rights reserved. > # > # This program and the accompanying materials > # are licensed and made available under the terms and conditions of the BSD License > @@ -46,3 +46,10 @@ [PcdsFixedAtBuild.common] > # Juno Device Trees are loaded from NOR Flash > gArmJunoTokenSpaceGuid.PcdJunoFdtDevicePath|L"VenHw(E7223039-5836-41E1-B542-D7EC736C5E59)/board.dtb"|VOID*|0x00000008 > > + # MHU Register base used by SCMI Mailbox transport > + gArmJunoTokenSpaceGuid.PcdArmMtlDoorBell|0x2B1F0000|UINT64|0x00000024 > + > + # ARM_JUNO_NON_SECURE_SRAM_BASE used by SCMI Mailbox transport > + gArmJunoTokenSpaceGuid.PcdArmMtlMailBoxBase|0x2E000000|UINT64|0x00000025 > + gArmJunoTokenSpaceGuid.PcdArmMtlMailBoxSize|0x80|UINT32|0x00000026 > + > diff --git a/Platform/ARM/JunoPkg/ArmJuno.dsc b/Platform/ARM/JunoPkg/ArmJuno.dsc > index 5c2a29fe8330bbf308e31e34b617517a5aebcf6d..fe860956a4dc497cac52be70bab3657246a08bd0 100644 > --- a/Platform/ARM/JunoPkg/ArmJuno.dsc > +++ b/Platform/ARM/JunoPkg/ArmJuno.dsc > @@ -47,6 +47,9 @@ [LibraryClasses.common] > # USB Requirements > UefiUsbLib|MdePkg/Library/UefiUsbLib/UefiUsbLib.inf > > + # SCMI Mailbox Transport Layer > + ArmMtl|Platform/ARM/JunoPkg/Library/ArmMtl/ArmMtl.inf > + > [LibraryClasses.common.SEC] > PrePiLib|EmbeddedPkg/Library/PrePiLib/PrePiLib.inf > ExtractGuidedSectionLib|EmbeddedPkg/Library/PrePiExtractGuidedSectionLib/PrePiExtractGuidedSectionLib.inf > diff --git a/Platform/ARM/JunoPkg/Library/ArmMtl/ArmMtl.inf b/Platform/ARM/JunoPkg/Library/ArmMtl/ArmMtl.inf > new file mode 100644 > index 0000000000000000000000000000000000000000..69e845f93f9332205fd5d36af2753681304058e3 > --- /dev/null > +++ b/Platform/ARM/JunoPkg/Library/ArmMtl/ArmMtl.inf > @@ -0,0 +1,39 @@ > +#/** @file > +# Copyright (c) 2017, ARM Limited. All rights reserved. > +# > +# This program and the accompanying materials > +# are licensed and made available under the terms and conditions of the BSD License > +# which accompanies this distribution. The full text of the license may be found at > +# http://opensource.org/licenses/bsd-license.php > +# > +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, > +# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. > +#**/ > + > +[Defines] > + INF_VERSION = 0x00010019 > + BASE_NAME = ArmMtl Please rename this library *instance* to something Juno-specific, e.g., ArmJunoMtlLib > + FILE_GUID = 21FB2D8F-C6C8-4B2C-A616-A30CB2FBA277 > + MODULE_TYPE = BASE > + VERSION_STRING = 1.0 > + LIBRARY_CLASS = ArmMtl > + Please rename to ArmMtlLib (as mentioned in the related EDK2 patch) > +[Sources.common] > + ArmMtl.c > + > +[Packages] > + ArmPkg/ArmPkg.dec > + ArmPlatformPkg/ArmPlatformPkg.dec > + MdePkg/MdePkg.dec > + Platform/ARM/JunoPkg/ArmJuno.dec > + > +[LibraryClasses] > + ArmLib > + DebugLib > + IoLib > + UefiBootServicesTableLib > + > +[FixedPcd.common] > + gArmJunoTokenSpaceGuid.PcdArmMtlDoorBell > + gArmJunoTokenSpaceGuid.PcdArmMtlMailBoxBase > + gArmJunoTokenSpaceGuid.PcdArmMtlMailBoxSize > diff --git a/Platform/ARM/JunoPkg/Library/ArmMtl/ArmMtlPrivate.h b/Platform/ARM/JunoPkg/Library/ArmMtl/ArmMtlPrivate.h > new file mode 100644 > index 0000000000000000000000000000000000000000..825fc788722bbe01ede24d9f867565c4c1dc938b > --- /dev/null > +++ b/Platform/ARM/JunoPkg/Library/ArmMtl/ArmMtlPrivate.h > @@ -0,0 +1,94 @@ > +/** @file > + > + Copyright (c) 2017, ARM Limited. All rights reserved. > + > + This program and the accompanying materials > + are licensed and made available under the terms and conditions of the BSD License > + which accompanies this distribution. The full text of the license may be found at > + http://opensource.org/licenses/bsd-license.php > + > + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, > + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. > + > + System Control and Management Interface V1.0 > + http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/ > + DEN0056A_System_Control_and_Management_Interface.pdf > + > + Juno ARM Development Platform SoC > + https://www.arm.com/files/pdf/ > + DDI0515D1a_juno_arm_development_platform_soc_trm.pdf > +**/ > + > +#ifndef ARM_MTL_PRIVATE_H_ > +#define ARM_MTL_PRIVATE_H_ > + > +// Mailbox transport layer. > +#define MTL_DOORBELL_MODIFY_MASK (0x00000001U) > +#define MTL_DOORBELL_PRESERVE_MASK (~MTL_DOORBELL_MODIFY_MASK) > + > +#define MTL_DOORBELL_BASE (FixedPcdGet64 (PcdArmMtlDoorBell)) > +#define MTL_MAILBOX_BASE (FixedPcdGet64 (PcdArmMtlMailBoxBase)) > +#define MTL_MAILBOX_SIZE (FixedPcdGet32 (PcdArmMtlMailBoxSize)) > + > +#define MTL_POLL 0 > +#define MTL_INTR 1 > + > +/* For Juno, the mailbox for high priority is non-trusted SRAM + 256. > + > + NOTE: Below is not documented anywhere (yet) > + > + The payload sizes are 128 bytes. > + > + There are two channels: > + > + Channel 0 > + - Agent (OS) to Platform (SCP) memory base: non-trusted SRAM + 0 > + - Platform (SCP) to Agent (OS) memory base: non-trusted SRAM + 128 > + - Doorbell (both directions): MHU, bit 0 > + > + Channel 1 > + - Agent (OS) to Platform (SCP) memory base: non-trusted SRAM + 256 > + - Platform (SCP) to Agent (OS) memory base: non-trusted SRAM + 384 > + - Doorbell (both directions): MHU, bit 0 > +*/ > +#define MTL_MAILBOX_HIGH_PRIORITY_OFFSET (MTL_MAILBOX_SIZE * 2) > + > +// ARM MHU interrupt registers. > +#define CPU_INTR_L_SET 0x108 > +#define CPU_INTR_H_SET 0x128 > + > +// MTL uses MHU interrupt registers for communication with the SCP. > +#define MTL_DOORBELL_REGISTER_LOW (MTL_DOORBELL_BASE + CPU_INTR_L_SET) > +#define MTL_DOORBELL_REGISTER_HIGH (MTL_DOORBELL_BASE + CPU_INTR_H_SET) > + > +#define MTL_CHANNEL_BUSY 0 > +#define MTL_CHANNEL_FREE 1 > + > +// Response timeout value on a MHU channel 20ms. > +#define RESPONSE_TIMEOUT 20000 > + > +/* As per SCMI spec. as a agent UEFI(or OS) can access only two channels > + (low or high priority) secure channel is only accessible > + to ARM Trusted firmware. */ > +#define NUM_CHANNELS 2 > + > +/* Each channel must use a doorbell register to interrupt the SCP firmware. > + on Juno these are MHU interrupt registers for low and high priority > + channels. */ > +#define DOORBELL_LOW { \ > + MTL_DOORBELL_REGISTER_LOW, \ > + MTL_DOORBELL_MODIFY_MASK, \ > + MTL_DOORBELL_PRESERVE_MASK \ > + } > + > +#define DOORBELL_HIGH { \ > + MTL_DOORBELL_REGISTER_HIGH, \ > + MTL_DOORBELL_MODIFY_MASK, \ > + MTL_DOORBELL_PRESERVE_MASK \ > + } > + > +// Arbitarary poll time. > +#define MTL_POLL_WAIT_TIME 100 > + > +#endif /* ARM_MTL_PRIVATE_H_ */ > + > diff --git a/Platform/ARM/JunoPkg/Library/ArmMtl/ArmMtl.c b/Platform/ARM/JunoPkg/Library/ArmMtl/ArmMtl.c > new file mode 100644 > index 0000000000000000000000000000000000000000..b5e469f9a51a8f739526c7eeb873c32403d191f9 > --- /dev/null > +++ b/Platform/ARM/JunoPkg/Library/ArmMtl/ArmMtl.c > @@ -0,0 +1,195 @@ > +/** @file > + > + Copyright (c) 2017, ARM Limited. All rights reserved. > + > + This program and the accompanying materials > + are licensed and made available under the terms and conditions of the BSD License > + which accompanies this distribution. The full text of the license may be found at > + http://opensource.org/licenses/bsd-license.php > + > + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, > + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. > + > + System Control and Management Interface V1.0 > + http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/ > + DEN0056A_System_Control_and_Management_Interface.pdf > +**/ > + > +#include For a BASE library, you should include and possibly if you are using UEFI types. Uefi.h is intended for UEFI drivers and applications > +#include > +#include > +#include > +#include > +#include > +#include > + > +#include "ArmMtlPrivate.h" > + > +// Each channel has a shared mailbox and a doorbell register. > +STATIC CONST MTL_CHANNEL Channels[NUM_CHANNELS] = { > + // Low priority channel. > + { > + MTL_CHANNEL_TYPE_LOW, > + (MTL_MAILBOX*)(MTL_MAILBOX_BASE), > + DOORBELL_LOW > + }, > + // High priority channel > + { > + MTL_CHANNEL_TYPE_HIGH, > + (MTL_MAILBOX*)(MTL_MAILBOX_BASE + MTL_MAILBOX_HIGH_PRIORITY_OFFSET), > + DOORBELL_HIGH > + } > + }; > + > +/** Wait until channel is free. > + > + @param[in] Channel Pointer to a channel. > + @param[in] TimeOutInMicroSeconds Time out in micro seconds. > + > + @retval EFI_SUCCESS Channel is free. > + @retval EFI_TIMOUT Time out error. > +**/ > +EFI_STATUS > +MtlWaitUntilChannelFree ( > + IN MTL_CHANNEL *Channel, > + IN UINTN TimeOutInMicroSeconds > + ) > +{ > + while (TimeOutInMicroSeconds != 0) { > + // If channel is free then we have received the reply. > + if (Channel->MailBox->ChannelStatus == MTL_CHANNEL_FREE) { > + return EFI_SUCCESS; > + } > + if (TimeOutInMicroSeconds < MTL_POLL_WAIT_TIME) { > + gBS->Stall (TimeOutInMicroSeconds); > + break; > + } > + // Wait for some arbitrary time. > + gBS->Stall (MTL_POLL_WAIT_TIME); > + TimeOutInMicroSeconds -= MTL_POLL_WAIT_TIME; > + } > + > + // No response from SCP. > + if (Channel->MailBox->ChannelStatus != MTL_CHANNEL_FREE) { > + ASSERT (FALSE); > + return EFI_TIMEOUT; > + } > + > + return EFI_SUCCESS; > +} > + > +/** Return the address of the message payload. > + > + @param[in] Channel Pointer to a channel. > + > + @retval UINT32* Pointer to the payload. > +**/ > +UINT32* > +MtlGetChannelPayload ( > + IN MTL_CHANNEL *Channel > + ) > +{ > + return Channel->MailBox->Payload; > +} > + > +/** Return pointer to a channel for the requested channel type. > + > + @param[in] ChannelType ChannelType, Low or High priority channel. > + MTL_CHANNEL_TYPE_LOW or > + MTL_CHANNEL_TYPE_HIGH > + > + @param[out] Channel Holds pointer to the channel. > + > + @retval EFI_SUCCESS Pointer to channel is returned. > + @retval EFI_UNSUPPORTED Requested channel type not supported. > +**/ > +EFI_STATUS > +MtlGetChannel ( > + IN MTL_CHANNEL_TYPE ChannelType, > + OUT MTL_CHANNEL **Channel > + ) > +{ > + if (ChannelType != MTL_CHANNEL_TYPE_LOW > + && ChannelType != MTL_CHANNEL_TYPE_HIGH) { > + return EFI_UNSUPPORTED; > + } > + > + *Channel = (MTL_CHANNEL*)&Channels[ChannelType]; > + > + return EFI_SUCCESS; > +} > + > +/** Mark the channel busy and ring the doorbell. > + > + @param[in] Channel Pointer to a channel. > + @param[in] MessageHeader Message header. > + > + @param[out] PayloadLength Message length. > + > + @retval EFI_SUCCESS Message sent successfully. > + @retval EFI_DEVICE_ERROR Channel is busy. > +**/ > +EFI_STATUS > +MtlSendMessage ( > + IN MTL_CHANNEL *Channel, > + IN UINT32 MessageHeader, > + OUT UINT32 PayloadLength > + ) > +{ > + MTL_MAILBOX *MailBox = Channel->MailBox; > + > + if (Channel->MailBox->ChannelStatus != MTL_CHANNEL_FREE) { > + return EFI_DEVICE_ERROR; > + } > + > + // Mark the channel busy before ringing doorbell. > + Channel->MailBox->ChannelStatus = MTL_CHANNEL_BUSY; > + > + MailBox->Flags = MTL_POLL; > + MailBox->MessageHeader = MessageHeader; > + > + // Add length of message header. > + MailBox->Length = PayloadLength + sizeof (MessageHeader); > + > + // Ring the doorbell. It sets SET bit of the MHU register. > + MmioWrite32 ( > + Channel->DoorBell.PhysicalAddress, > + Channel->DoorBell.ModifyMask > + ); > + > + return EFI_SUCCESS; > +} > + > +/** Wait for a response on a channel. > + > + If channel is free after sending message, it implies SCP responded > + with a response on the channel. > + > + @param[in] Channel Pointer to a channel. > + > + @retval EFI_SUCCESS Message received successfully. > + @retval EFI_TIMOUT Timeout error. > +**/ > +EFI_STATUS > +MtlReceiveMessage ( > + IN MTL_CHANNEL *Channel, > + OUT UINT32 *MessageHeader, > + OUT UINT32 *PayloadLength > + ) > +{ > + EFI_STATUS Status; > + > + MTL_MAILBOX *MailBox = Channel->MailBox; > + > + Status = MtlWaitUntilChannelFree (Channel, RESPONSE_TIMEOUT); > + if (EFI_ERROR (Status)) { > + return Status; > + } > + > + *MessageHeader = MailBox->MessageHeader; > + > + // Deduct message header length. > + *PayloadLength = MailBox->Length - sizeof (*MessageHeader); > + > + return EFI_SUCCESS; > +} > -- > Guid("CE165669-3EF3-493F-B85D-6190EE5B9759") >