From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: None (no SPF record) identity=mailfrom; client-ip=2a00:1450:4864:20::244; helo=mail-lj1-x244.google.com; envelope-from=mw@semihalf.com; receiver=edk2-devel@lists.01.org Received: from mail-lj1-x244.google.com (mail-lj1-x244.google.com [IPv6:2a00:1450:4864:20::244]) (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 667E92194D3AE for ; Thu, 17 Jan 2019 03:15:41 -0800 (PST) Received: by mail-lj1-x244.google.com with SMTP id k15-v6so8222836ljc.8 for ; Thu, 17 Jan 2019 03:15:41 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=semihalf-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=CQCL6SObqfsJMibmmBZPwiSJ1U6VPBz7vi1HYm0Sg1Y=; b=tuOuvxFKeGuzYbWyDHnlOJz7lFrdIKYpYKFm5ZEvBXKzmYDamGUnR7DwGjY+NxrusU SRz2WwxeBGYcV7zR2aAtOV4bKizzhqVdtjmmq1RGpvPOB50OUiLmgnFu1F6FhHl9TUNF AjrS4iHHYeiw3kEps5mWB3oNTWTJoCGGRaiKfZnhMLp+FfAFZc+MWjjscK7DGwww1oxB uNLlNmKjxb+1GpUCR+r+owX1CyI2/YB4rozL6jS7BI4Dk0zlkd0S7O2RSwnIhk4V2aak jT4rgq/wX3HGbnhb5vnJmBG2kqS8CE9Uqjp0AP9L3Ts+iCNqErxhqcLLHBxNKAfj1Hh/ Dg2A== 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; bh=CQCL6SObqfsJMibmmBZPwiSJ1U6VPBz7vi1HYm0Sg1Y=; b=IbQvZ4glO3+z4Cr1WXwXo/upgzuSoMztAgH5BRSdBzGpcdMOB+mss8Mk/UyiwtoQBe K7GplD/Tg2AC/OuqMrwa6H3dFdXOrPc/Q0CF2Xfx/c4bJ152b7AJRU7kAj3mCcCLjA7Y Fet8tRk0YcBCTNd6pO1tB8t648yy0UN8TKOcUwwu2wm+WOVPk0IafZxfZ6WTj9Zkc68D 1K/eFDi2GMzZPO+JCH9XRmmp4X5Uvo7k5EKce1bVcRJw8EBEB3XqQqaEz2B/8Xmy6gGM zuYf7WhbJkZwzFDMFCRf+xN7U23Y6QvkzW00zY2XaKpcXRuyLZvpdWLrUmCQ4fKIOxZX vRrQ== X-Gm-Message-State: AJcUukeb99S64uEiRLOb+R0zOY5C/zbhrGiQf+7gEfK5EgDweQ6MFyOG fEBfxo+ri+fzVWa+g4o+Cv878ArbD0M= X-Google-Smtp-Source: ALg8bN7jTpmUTMUZ3IkL1ncsAZlrc12l5SK5/g3xIdw6b/b9vdgD7u+YfJTZuXmA4GZea9rwcWGGAA== X-Received: by 2002:a2e:b00a:: with SMTP id y10-v6mr9233489ljk.109.1547723737969; Thu, 17 Jan 2019 03:15:37 -0800 (PST) Received: from gilgamesh.semihalf.com (31-172-191-173.noc.fibertech.net.pl. [31.172.191.173]) by smtp.gmail.com with ESMTPSA id d23sm238003lfc.11.2019.01.17.03.15.36 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 17 Jan 2019 03:15:37 -0800 (PST) From: Marcin Wojtas To: edk2-devel@lists.01.org Cc: leif.lindholm@linaro.org, ard.biesheuvel@linaro.org, nadavh@marvell.com, mw@semihalf.com, jsd@semihalf.com, jaz@semihalf.com, kostap@marvell.com Date: Thu, 17 Jan 2019 12:15:06 +0100 Message-Id: <1547723715-4562-4-git-send-email-mw@semihalf.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1547723715-4562-1-git-send-email-mw@semihalf.com> References: <1547723715-4562-1-git-send-email-mw@semihalf.com> Subject: [platforms: PATCH v3 03/12] Marvell/Library: Introduce MvGpioLib class X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:15:42 -0000 Following patches will add two drivers that are capable of producing the generic EMBEDDED_GPIO protocol. In order to handle a situation, when the consumer module attempts to locate and open a proper protocol, add a library helper function. In order to ease description of used GPIO pins and controllers of the Armada 7k8k platforms, add the common enum types. Signed-off-by: Marcin Wojtas --- Silicon/Marvell/Marvell.dec | 1 + Silicon/Marvell/Library/MvGpioLib/MvGpioLib.inf | 32 +++++ Silicon/Marvell/Include/Library/MvGpioLib.h | 68 ++++++++++ Silicon/Marvell/Library/MvGpioLib/MvGpioLib.c | 132 ++++++++++++++++++++ 4 files changed, 233 insertions(+) create mode 100644 Silicon/Marvell/Library/MvGpioLib/MvGpioLib.inf create mode 100644 Silicon/Marvell/Include/Library/MvGpioLib.h create mode 100644 Silicon/Marvell/Library/MvGpioLib/MvGpioLib.c diff --git a/Silicon/Marvell/Marvell.dec b/Silicon/Marvell/Marvell.dec index 616624e..ac922a0 100644 --- a/Silicon/Marvell/Marvell.dec +++ b/Silicon/Marvell/Marvell.dec @@ -63,6 +63,7 @@ ArmadaBoardDescLib|Include/Library/ArmadaBoardDescLib.h ArmadaIcuLib|Include/Library/ArmadaIcuLib.h ArmadaSoCDescLib|Include/Library/ArmadaSoCDescLib.h + MvGpioLib|Include/Library/MvGpioLib.h SampleAtResetLib|Include/Library/SampleAtResetLib.h [Protocols] diff --git a/Silicon/Marvell/Library/MvGpioLib/MvGpioLib.inf b/Silicon/Marvell/Library/MvGpioLib/MvGpioLib.inf new file mode 100644 index 0000000..3bc54ce --- /dev/null +++ b/Silicon/Marvell/Library/MvGpioLib/MvGpioLib.inf @@ -0,0 +1,32 @@ +## @file +# +# Copyright (C) 2018, Marvell International Ltd. and its affiliates
+# +# 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 = 0x0001001A + BASE_NAME = MvGpioLib + FILE_GUID = f4386b44-6bc2-4fa1-9989-8513bbb22692 + MODULE_TYPE = BASE + VERSION_STRING = 1.0 + LIBRARY_CLASS = MvGpioLib + +[Sources] + MvGpioLib.c + +[Packages] + EmbeddedPkg/EmbeddedPkg.dec + MdePkg/MdePkg.dec + Silicon/Marvell/Marvell.dec + +[LibraryClasses] + DebugLib diff --git a/Silicon/Marvell/Include/Library/MvGpioLib.h b/Silicon/Marvell/Include/Library/MvGpioLib.h new file mode 100644 index 0000000..a14acdf --- /dev/null +++ b/Silicon/Marvell/Include/Library/MvGpioLib.h @@ -0,0 +1,68 @@ +/** +* +* Copyright (C) 2018, Marvell International Ltd. and its affiliates. +* +* 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. +* +**/ +#ifndef __MV_GPIO_LIB_H__ +#define __MV_GPIO_LIB_H__ + +#include + +typedef enum { + MV_GPIO_DRIVER_TYPE_SOC_CONTROLLER, + MV_GPIO_DRIVER_TYPE_PCA95XX, +} MV_GPIO_DRIVER_TYPE; + +typedef enum { + MV_GPIO_AP806_CONTROLLER0, + MV_GPIO_CP0_CONTROLLER0, + MV_GPIO_CP0_CONTROLLER1, + MV_GPIO_CP1_CONTROLLER0, + MV_GPIO_CP1_CONTROLLER1, + MV_GPIO_CP2_CONTROLLER0, + MV_GPIO_CP2_CONTROLLER1, +} MV_GPIO_SOC_CONTROLLER_TYPE; + +typedef enum { + PCA9505_ID, + PCA9534_ID, + PCA9535_ID, + PCA9536_ID, + PCA9537_ID, + PCA9538_ID, + PCA9539_ID, + PCA9554_ID, + PCA9555_ID, + PCA9556_ID, + PCA9557_ID, + PCA95XX_MAX_ID, +} MV_GPIO_EXPANDER_TYPE_PCA95XX; + +typedef struct { + VENDOR_DEVICE_PATH Header; + MV_GPIO_DRIVER_TYPE GpioDriverType; + EFI_DEVICE_PATH_PROTOCOL End; +} MV_GPIO_DEVICE_PATH; + +typedef struct { + UINTN ControllerId; + UINTN PinNumber; + BOOLEAN ActiveHigh; +} MV_GPIO_PIN; + +EFI_STATUS +EFIAPI +MvGpioGetProtocol ( + IN MV_GPIO_DRIVER_TYPE GpioDriverType, + IN OUT EMBEDDED_GPIO **GpioProtocol + ); + +#endif // __MV_GPIO_LIB_H__ diff --git a/Silicon/Marvell/Library/MvGpioLib/MvGpioLib.c b/Silicon/Marvell/Library/MvGpioLib/MvGpioLib.c new file mode 100644 index 0000000..a95d5ae --- /dev/null +++ b/Silicon/Marvell/Library/MvGpioLib/MvGpioLib.c @@ -0,0 +1,132 @@ +/** +* +* Copyright (C) 2018, Marvell International Ltd. and its affiliates. +* +* 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. +* +**/ +#include + +#include +#include +#include +#include +#include + +#include + +/* + * Check if the driver type matches the requested value. + * In case of the success open the GPIO protocol and return. + */ +STATIC +EFI_STATUS +MvGpioFindMatchingDriver ( + IN MV_GPIO_DRIVER_TYPE GpioDriverType, + IN EFI_HANDLE HandleBuffer, + IN EFI_DEVICE_PATH *DevicePath, + IN OUT EMBEDDED_GPIO **GpioProtocol + ) +{ + MV_GPIO_DEVICE_PATH *GpioDevicePath; + EFI_STATUS Status; + + while (!IsDevicePathEndType (DevicePath)) { + /* Check if GpioDriverType matches one found in the device path */ + GpioDevicePath = (MV_GPIO_DEVICE_PATH *)DevicePath; + if (GpioDevicePath->GpioDriverType != GpioDriverType) { + DevicePath = NextDevicePathNode (DevicePath); + continue; + } + + /* + * Open GpioProtocol. With EFI_OPEN_PROTOCOL_GET_PROTOCOL attribute + * the consumer is not obliged to call CloseProtocol. + */ + Status = gBS->OpenProtocol (HandleBuffer, + &gEmbeddedGpioProtocolGuid, + (VOID **)GpioProtocol, + gImageHandle, + NULL, + EFI_OPEN_PROTOCOL_GET_PROTOCOL); + return Status; + } + + return EFI_NOT_FOUND; +} + +/* + * Select desired protocol producer upon MV_GPIO_DRIVER_TYPE + * field of driver's MV_GPIO_DEVICE_PATH. + */ +EFI_STATUS +EFIAPI +MvGpioGetProtocol ( + IN MV_GPIO_DRIVER_TYPE GpioDriverType, + IN OUT EMBEDDED_GPIO **GpioProtocol + ) +{ + EFI_DEVICE_PATH *DevicePath; + EFI_HANDLE *HandleBuffer; + EFI_STATUS Status; + UINTN HandleCount; + UINTN Index; + + /* Locate Handles of all EMBEDDED_GPIO producers */ + Status = gBS->LocateHandleBuffer (ByProtocol, + &gEmbeddedGpioProtocolGuid, + NULL, + &HandleCount, + &HandleBuffer); + if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR, "%a: Unable to locate handles\n", __FUNCTION__)); + return Status; + } + + /* Iterate over all protocol producers */ + for (Index = 0; Index < HandleCount; Index++) { + /* Open device path protocol installed on each handle */ + Status = gBS->OpenProtocol (HandleBuffer[Index], + &gEfiDevicePathProtocolGuid, + (VOID **)&DevicePath, + gImageHandle, + NULL, + EFI_OPEN_PROTOCOL_GET_PROTOCOL); + if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR, "%a: Unable to find DevicePath\n", __FUNCTION__)); + continue; + } + + /* + * Check if the driver type matches the requested value. + * In case of the success open the GPIO protocol and return. + * If there is no match, repeat procedure with the next handle. + */ + Status = MvGpioFindMatchingDriver (GpioDriverType, + HandleBuffer[Index], + DevicePath, + GpioProtocol); + if (Status == EFI_NOT_FOUND) { + continue; + } else if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR, + "%a: Unable to open GPIO protocol\n", + __FUNCTION__)); + } + + gBS->FreePool (HandleBuffer); + + return Status; + } + + /* No matching GPIO protocol producer was found */ + gBS->FreePool (HandleBuffer); + + return EFI_NOT_FOUND; +} -- 2.7.4