From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=2a00:1450:4864:20::341; helo=mail-wm1-x341.google.com; envelope-from=leif.lindholm@linaro.org; receiver=edk2-devel@lists.01.org Received: from mail-wm1-x341.google.com (mail-wm1-x341.google.com [IPv6:2a00:1450:4864:20::341]) (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 7BAF2211B6C22 for ; Thu, 17 Jan 2019 03:33:10 -0800 (PST) Received: by mail-wm1-x341.google.com with SMTP id r24so834469wmh.0 for ; Thu, 17 Jan 2019 03:33:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=dCwLahXRMgnREkO8w4ahMYuziQQ/gbWj+0/8upzbSNw=; b=isrZW3hBJ2qKPIaRkChLE/NIWz3YTntk0nsjuoNGJhwi3RMCxreA4VsUBsz9n8I7b7 B+xt8dx4sgQOTO1MMoPTuDskmLf94Cc3RDNczYTV3kBGQWowAz89WmJqOIDfE6w94E1s a58UU9nW+yAMaqQhSU1WhzqdYAs/TbxunIirc= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=dCwLahXRMgnREkO8w4ahMYuziQQ/gbWj+0/8upzbSNw=; b=HhCF1YBw2ICcK4KNhH14zf61Ed3OsryMSZ4Zmwwh1cAZjjUrqzBuSJvsx5ieffBHEe nfAoP/9vOybbkfAguPgdiMg7RsRAjapergez0K/JtUmST3+z3wzR4hATmi+js5OlS6R6 Gfi+C+c4JbRFTjAxO3rmHqgjZ+N4TDN5UWXrYomtpQ/vekiIepZP1rd6eS+tydZU4WUL RpkYkuPSJGKsee2HPilzFOGMtF94cQnLooZoQSu37PI+trr4awhZUQ3tuipWZ0RvEKqe UBl0+/o8kG8zt3FkP/la3d7MuPXiqqLNyIVSxOU6WoURpS4gEZv++E2rbC0asXUDD+Ih J2IQ== X-Gm-Message-State: AJcUuke57sgmD6jNZoXcztm/6FG7MVu3dC5NKkwZ5ysch9z2pRWskEW+ 49cuThQC4CJo5FfsjmEDAspkHA== X-Google-Smtp-Source: ALg8bN7D2k06SITcjeTW6EAxiZwHzX8hZXBhzBNfSCO5uswSBT7oWexnUKoqUpXE4neQ5Ck8jhncqw== X-Received: by 2002:a1c:2e43:: with SMTP id u64mr11618613wmu.52.1547724788425; Thu, 17 Jan 2019 03:33:08 -0800 (PST) Received: from bivouac.eciton.net (bivouac.eciton.net. [2a00:1098:0:86:1000:23:0:2]) by smtp.gmail.com with ESMTPSA id z12sm68468014wrh.35.2019.01.17.03.33.07 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Thu, 17 Jan 2019 03:33:07 -0800 (PST) Date: Thu, 17 Jan 2019 11:33:06 +0000 From: Leif Lindholm To: Marcin Wojtas Cc: edk2-devel@lists.01.org, ard.biesheuvel@linaro.org, nadavh@marvell.com, jsd@semihalf.com, jaz@semihalf.com, kostap@marvell.com Message-ID: <20190117113305.muntfdgceho4safl@bivouac.eciton.net> References: <1547723715-4562-1-git-send-email-mw@semihalf.com> <1547723715-4562-4-git-send-email-mw@semihalf.com> MIME-Version: 1.0 In-Reply-To: <1547723715-4562-4-git-send-email-mw@semihalf.com> User-Agent: NeoMutt/20170113 (1.7.2) Subject: Re: [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:33:11 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:33:11 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:33:11 -0000 X-List-Received-Date: Thu, 17 Jan 2019 11:33:11 -0000 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline (Can drop the "class" from subject line) With that: Reviewed-by: Leif Lindholm On Thu, Jan 17, 2019 at 12:15:06PM +0100, Marcin Wojtas wrote: > 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 >