Re: [PATCH edk2-platforms v4 6/6] Platform/HiKey: enable virtual keyboard

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

On Mon, May 14, 2018 at 12:34:33PM +0800, Haojian Zhuang wrote:
> Enable virtual keyboard on HiKey platform. It detects the pattern
> in memory and GPIO pin setting, and simulates them into virtual
> key.
> 
> 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>

Some of this code looks like it could be turned into a common library
for HiKey/HiKey960. Let's not worry about it for now, but please keep
in mind for future.

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


> ---
>  Platform/Hisilicon/HiKey/HiKey.dsc             |  5 ++
>  Platform/Hisilicon/HiKey/HiKey.fdf             |  5 ++
>  Platform/Hisilicon/HiKey/HiKeyDxe/HiKeyDxe.c   | 98 ++++++++++++++++++++++++++
>  Platform/Hisilicon/HiKey/HiKeyDxe/HiKeyDxe.inf |  5 ++
>  4 files changed, 113 insertions(+)
> 
> diff --git a/Platform/Hisilicon/HiKey/HiKey.dsc b/Platform/Hisilicon/HiKey/HiKey.dsc
> index 5cc4ff27f01b..83dd68a820b1 100644
> --- a/Platform/Hisilicon/HiKey/HiKey.dsc
> +++ b/Platform/Hisilicon/HiKey/HiKey.dsc
> @@ -192,6 +192,11 @@ [Components.common]
>    Platform/Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.inf
>    ArmPlatformPkg/Drivers/PL061GpioDxe/PL061GpioDxe.inf
>  
> +  #
> +  # Virtual Keyboard
> +  #
> +  EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboardDxe.inf
> +
>    Platform/Hisilicon/HiKey/HiKeyDxe/HiKeyDxe.inf
>  
>    #
> diff --git a/Platform/Hisilicon/HiKey/HiKey.fdf b/Platform/Hisilicon/HiKey/HiKey.fdf
> index 39020d27dbcd..2bca7232b6e5 100644
> --- a/Platform/Hisilicon/HiKey/HiKey.fdf
> +++ b/Platform/Hisilicon/HiKey/HiKey.fdf
> @@ -123,6 +123,11 @@ [FV.FvMain]
>    INF Platform/Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.inf
>    INF ArmPlatformPkg/Drivers/PL061GpioDxe/PL061GpioDxe.inf
>  
> +  #
> +  # Virtual Keyboard
> +  #
> +  INF EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboardDxe.inf
> +
>    INF Platform/Hisilicon/HiKey/HiKeyDxe/HiKeyDxe.inf
>  
>    #
> diff --git a/Platform/Hisilicon/HiKey/HiKeyDxe/HiKeyDxe.c b/Platform/Hisilicon/HiKey/HiKeyDxe/HiKeyDxe.c
> index 19987e0b29c3..8f4f9157835c 100644
> --- a/Platform/Hisilicon/HiKey/HiKeyDxe/HiKeyDxe.c
> +++ b/Platform/Hisilicon/HiKey/HiKeyDxe/HiKeyDxe.c
> @@ -12,10 +12,15 @@
>  *
>  **/
>  
> +#include <Library/CacheMaintenanceLib.h>
>  #include <Library/DebugLib.h>
>  #include <Library/IoLib.h>
> +#include <Library/UefiBootServicesTableLib.h>
>  #include <Library/UefiLib.h>
>  
> +#include <Protocol/EmbeddedGpio.h>
> +#include <Protocol/PlatformVirtualKeyboard.h>
> +
>  #include <Hi6220.h>
>  #include <Hi6220RegsPeri.h>
>  
> @@ -31,6 +36,8 @@
>  #define ADB_REBOOT_BOOTLOADER            0x77665500
>  #define ADB_REBOOT_NONE                  0x77665501
>  
> +STATIC EMBEDDED_GPIO        *mGpio;
> +
>  STATIC
>  VOID
>  UartInit (
> @@ -104,6 +111,90 @@ HiKeyInitPeripherals (
>  
>  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;
> +  }
> +  Status = mGpio->Set (mGpio, DETECT_J15_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_J15_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
>  HiKeyEntryPoint (
>    IN EFI_HANDLE         ImageHandle,
>    IN EFI_SYSTEM_TABLE   *SystemTable
> @@ -115,5 +206,12 @@ HiKeyEntryPoint (
>    if (EFI_ERROR (Status)) {
>      return Status;
>    }
> +
> +  Status = gBS->InstallProtocolInterface (
> +                  &ImageHandle,
> +                  &gPlatformVirtualKeyboardProtocolGuid,
> +                  EFI_NATIVE_INTERFACE,
> +                  &mVirtualKeyboard
> +                  );
>    return Status;
>  }
> diff --git a/Platform/Hisilicon/HiKey/HiKeyDxe/HiKeyDxe.inf b/Platform/Hisilicon/HiKey/HiKeyDxe/HiKeyDxe.inf
> index 34734391b45a..41aa7f8081ed 100644
> --- a/Platform/Hisilicon/HiKey/HiKeyDxe/HiKeyDxe.inf
> +++ b/Platform/Hisilicon/HiKey/HiKeyDxe/HiKeyDxe.inf
> @@ -28,11 +28,16 @@ [Packages]
>    MdePkg/MdePkg.dec
>  
>  [LibraryClasses]
> +  CacheMaintenanceLib
>    DebugLib
>    IoLib
>    UefiLib
>    UefiDriverEntryPoint
>  
> +[Protocols]
> +  gEmbeddedGpioProtocolGuid
> +  gPlatformVirtualKeyboardProtocolGuid
> +
>  [Guids]
>    gEfiEndOfDxeEventGroupGuid
>  
> -- 
> 2.7.4
>