Re: [PATCH v6 edk2-platforms 3/6] Platform/HiKey960: enable virtual keyboard

[Leif Lindholm <leif.lindholm@linaro.org>]

On Thu, May 24, 2018 at 08:46:27AM +0800, Haojian Zhuang wrote:
> Enable virtual keyboard on HiKey960 platform. It checks two
> conditions, such as pattern in memory and GPIO pin setting.
> Since code is ported from non-open
> 
> The hardcoding code is taken from non-open reference code.
> Can't fix it for lack of documents.
> 
> Cc: Leif Lindholm <leif.lindholm@linaro.org>
> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Haojian Zhuang <haojian.zhuang@linaro.org>

Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>

> ---
>  Platform/Hisilicon/HiKey960/HiKey960.dsc                |  5 +
>  Platform/Hisilicon/HiKey960/HiKey960.fdf                |  5 +
>  Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.inf |  1 +
>  Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.h   | 10 ++
>  Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.c   | 97 ++++++++++++++++++++
>  5 files changed, 118 insertions(+)
> 
> diff --git a/Platform/Hisilicon/HiKey960/HiKey960.dsc b/Platform/Hisilicon/HiKey960/HiKey960.dsc
> index 6cc1c1edf453..79e68754976d 100644
> --- a/Platform/Hisilicon/HiKey960/HiKey960.dsc
> +++ b/Platform/Hisilicon/HiKey960/HiKey960.dsc
> @@ -182,6 +182,11 @@ [Components.common]
>    Platform/Hisilicon/HiKey960/HiKey960GpioDxe/HiKey960GpioDxe.inf
>    ArmPlatformPkg/Drivers/PL061GpioDxe/PL061GpioDxe.inf
>  
> +  #
> +  # Virtual Keyboard
> +  #
> +  EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboardDxe.inf
> +
>    Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.inf
>  
>    #
> diff --git a/Platform/Hisilicon/HiKey960/HiKey960.fdf b/Platform/Hisilicon/HiKey960/HiKey960.fdf
> index b7d70b010598..d65f77878575 100644
> --- a/Platform/Hisilicon/HiKey960/HiKey960.fdf
> +++ b/Platform/Hisilicon/HiKey960/HiKey960.fdf
> @@ -123,6 +123,11 @@ [FV.FvMain]
>    INF Platform/Hisilicon/HiKey960/HiKey960GpioDxe/HiKey960GpioDxe.inf
>    INF ArmPlatformPkg/Drivers/PL061GpioDxe/PL061GpioDxe.inf
>  
> +  #
> +  # Virtual Keyboard
> +  #
> +  INF EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboardDxe.inf
> +
>    INF Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.inf
>  
>    #
> diff --git a/Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.inf b/Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.inf
> index a1a7d005ce8b..46a9a5803e3d 100644
> --- a/Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.inf
> +++ b/Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.inf
> @@ -39,6 +39,7 @@ [LibraryClasses]
>  
>  [Protocols]
>    gEmbeddedGpioProtocolGuid
> +  gPlatformVirtualKeyboardProtocolGuid
>  
>  [Guids]
>    gEfiEndOfDxeEventGroupGuid
> diff --git a/Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.h b/Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.h
> index 9a4c66f42c50..211eea55aa54 100644
> --- a/Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.h
> +++ b/Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.h
> @@ -21,6 +21,7 @@
>  
>  #include <Library/BaseLib.h>
>  #include <Library/BaseMemoryLib.h>
> +#include <Library/CacheMaintenanceLib.h>
>  #include <Library/DebugLib.h>
>  #include <Library/IoLib.h>
>  #include <Library/PrintLib.h>
> @@ -29,6 +30,15 @@
>  #include <Library/UefiBootServicesTableLib.h>
>  #include <Library/UefiLib.h>
>  
> +#include <Protocol/EmbeddedGpio.h>
> +#include <Protocol/PlatformVirtualKeyboard.h>
> +
> +#define ADB_REBOOT_ADDRESS               0x32100000
> +#define ADB_REBOOT_BOOTLOADER            0x77665500
> +#define ADB_REBOOT_NONE                  0x77665501
> +
> +#define DETECT_SW_FASTBOOT               68        // GPIO8_4
> +
>  enum {
>    BOOT_MODE_RECOVERY  = 0,
>    BOOT_MODE_MASK = 1,
> diff --git a/Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.c b/Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.c
> index 7c1705241e88..7ff2f118128d 100644
> --- a/Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.c
> +++ b/Platform/Hisilicon/HiKey960/HiKey960Dxe/HiKey960Dxe.c
> @@ -14,6 +14,8 @@
>  
>  #include "HiKey960Dxe.h"
>  
> +STATIC EMBEDDED_GPIO   *mGpio;
> +
>  STATIC
>  VOID
>  InitSdCard (
> @@ -166,6 +168,94 @@ OnEndOfDxe (
>  
>  EFI_STATUS
>  EFIAPI
> +VirtualKeyboardRegister (
> +  IN VOID
> +  )
> +{
> +  EFI_STATUS           Status;
> +
> +  Status = gBS->LocateProtocol (
> +                  &gEmbeddedGpioProtocolGuid,
> +                  NULL,
> +                  (VOID **) &mGpio
> +                  );
> +  if (EFI_ERROR (Status)) {
> +    return Status;
> +  }
> +  return EFI_SUCCESS;
> +}
> +
> +EFI_STATUS
> +EFIAPI
> +VirtualKeyboardReset (
> +  IN VOID
> +  )
> +{
> +  EFI_STATUS           Status;
> +
> +  if (mGpio == NULL) {
> +    return EFI_INVALID_PARAMETER;
> +  }
> +  //
> +  // Configure GPIO68 as GPIO function
> +  //
> +  MmioWrite32 (0xe896c108, 0);
> +  Status = mGpio->Set (mGpio, DETECT_SW_FASTBOOT, GPIO_MODE_INPUT);
> +  return Status;
> +}
> +
> +BOOLEAN
> +EFIAPI
> +VirtualKeyboardQuery (
> +  IN VIRTUAL_KBD_KEY             *VirtualKey
> +  )
> +{
> +  EFI_STATUS           Status;
> +  UINTN                Value = 0;
> +
> +  if ((VirtualKey == NULL) || (mGpio == NULL)) {
> +    return FALSE;
> +  }
> +  if (MmioRead32 (ADB_REBOOT_ADDRESS) == ADB_REBOOT_BOOTLOADER) {
> +    goto Done;
> +  } else {
> +    Status = mGpio->Get (mGpio, DETECT_SW_FASTBOOT, &Value);
> +    if (EFI_ERROR (Status) || (Value != 0)) {
> +      return FALSE;
> +    }
> +  }
> +Done:
> +  VirtualKey->Signature = VIRTUAL_KEYBOARD_KEY_SIGNATURE;
> +  VirtualKey->Key.ScanCode = SCAN_NULL;
> +  VirtualKey->Key.UnicodeChar = L'f';
> +  return TRUE;
> +}
> +
> +EFI_STATUS
> +EFIAPI
> +VirtualKeyboardClear (
> +  IN VIRTUAL_KBD_KEY            *VirtualKey
> +  )
> +{
> +  if (VirtualKey == NULL) {
> +    return EFI_INVALID_PARAMETER;
> +  }
> +  if (MmioRead32 (ADB_REBOOT_ADDRESS) == ADB_REBOOT_BOOTLOADER) {
> +    MmioWrite32 (ADB_REBOOT_ADDRESS, ADB_REBOOT_NONE);
> +    WriteBackInvalidateDataCacheRange ((VOID *)ADB_REBOOT_ADDRESS, 4);
> +  }
> +  return EFI_SUCCESS;
> +}
> +
> +PLATFORM_VIRTUAL_KBD_PROTOCOL mVirtualKeyboard = {
> +  VirtualKeyboardRegister,
> +  VirtualKeyboardReset,
> +  VirtualKeyboardQuery,
> +  VirtualKeyboardClear
> +};
> +
> +EFI_STATUS
> +EFIAPI
>  HiKey960EntryPoint (
>    IN EFI_HANDLE         ImageHandle,
>    IN EFI_SYSTEM_TABLE   *SystemTable
> @@ -194,5 +284,12 @@ HiKey960EntryPoint (
>    if (EFI_ERROR (Status)) {
>      return Status;
>    }
> +
> +  Status = gBS->InstallProtocolInterface (
> +                  &ImageHandle,
> +                  &gPlatformVirtualKeyboardProtocolGuid,
> +                  EFI_NATIVE_INTERFACE,
> +                  &mVirtualKeyboard
> +                  );
>    return Status;
>  }
> -- 
> 2.7.4
>