OvmfPkg/VirtioInputDxe/VirtioInput.h

/** @file

  Private definitions of the VirtioInput driver

  Copyright (C) 2024, Red Hat

  SPDX-License-Identifier: BSD-2-Clause-Patent

**/

#pragma once

#include <Protocol/AbsolutePointer.h>
#include <Protocol/ComponentName.h>
#include <Protocol/DriverBinding.h>
#include <Protocol/SimplePointer.h>
#include <Protocol/SimpleTextIn.h>
#include <Protocol/SimpleTextInEx.h>

#include <IndustryStandard/Virtio.h>

#include "VirtioKeyCodes.h"

#define VIRTIO_INPUT_SIG  SIGNATURE_32 ('V', 'I', 'N', 'P')

#define MAX_RINGS   2
#define RX_BUFSIZE  64

// Fetch new input from VirtIO every 50ms
#define PROBE_TIME_MS  50

// Max range of recognized keyboard codes
#define MAX_KEYBOARD_CODE  (BTN_MISC - 1)

// Key code 0x100 ~ 0x15f range is for all kinds of button events.
#define IS_BUTTON_CODE(Code)  (((Code) >= BTN_MISC) && ((Code) < KEY_OK))

typedef struct {
  UINTN                      Signature;
  EFI_KEY_DATA               KeyData;
  EFI_KEY_NOTIFY_FUNCTION    KeyNotificationFn;
  LIST_ENTRY                 NotifyEntry;
} VIRTIO_INPUT_IN_EX_NOTIFY;

// Data structure representing ring buffer
typedef struct {
  VRING                   Ring;
  VOID                    *RingMap;
  DESC_INDICES            Indices;        /* Avail Ring */
  UINT16                  LastUsedIdx;    /* Used Ring */

  UINT32                  BufferSize;
  UINT32                  BufferCount;
  UINT32                  BufferPages;
  UINT8                   *Buffers;
  VOID                    *BufferMap;
  EFI_PHYSICAL_ADDRESS    DeviceAddress;

  BOOLEAN                 Ready;
} VIRTIO_INPUT_RING;

// Declaration of data structure representing driver context
typedef struct {
  // Device signature
  UINT32                               Signature;

  // Hook for the function which shall be caled when driver is closed
  // before system state changes to boot
  EFI_EVENT                            ExitBoot;

  // Virtio device hook
  VIRTIO_DEVICE_PROTOCOL               *VirtIo;

  // Hook for ring buffer
  VIRTIO_INPUT_RING                    Rings[MAX_RINGS];

  // Timer event for checking input from VirtIo
  EFI_EVENT                            PollTimer;

  // Keyboard implementation
  BOOLEAN                              HasKeyboard;
  EFI_SIMPLE_TEXT_INPUT_PROTOCOL       Txt;
  EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL    TxtEx;
  EFI_INPUT_KEY                        LastKey;
  LIST_ENTRY                           KeyNotifyList;
  BOOLEAN                              KeyActive[MAX_KEYBOARD_CODE + 1]; // Key modifiers
  BOOLEAN                              KeyReady;

  // Mouse implementation
  BOOLEAN                              HasMouse;
  EFI_SIMPLE_POINTER_PROTOCOL          SimplePointer;
  EFI_SIMPLE_POINTER_MODE              PointerMode;
  EFI_SIMPLE_POINTER_STATE             PointerState;
  BOOLEAN                              PointerReady;

  // Tablet implementation
  BOOLEAN                              HasTablet;
  EFI_ABSOLUTE_POINTER_PROTOCOL        AbsolutePointer;
  EFI_ABSOLUTE_POINTER_MODE            AbsPointerMode;
  EFI_ABSOLUTE_POINTER_STATE           AbsPointerState;
  BOOLEAN                              AbsPointerReady;
} VIRTIO_INPUT_DEV;

// Helper functions to extract VIRTIO_INPUT_DEV structure pointers
#define VIRTIO_INPUT_FROM_THIS(KbrPointer) \
          CR (KbrPointer, VIRTIO_INPUT_DEV, Txt, VIRTIO_INPUT_SIG)
#define VIRTIO_INPUT_EX_FROM_THIS(KbrPointer) \
          CR (KbrPointer, VIRTIO_INPUT_DEV, TxtEx, VIRTIO_INPUT_SIG)
#define VIRTIO_INPUT_FROM_POINTER_THIS(a) \
          CR (a, VIRTIO_INPUT_DEV, SimplePointer, VIRTIO_INPUT_SIG)
#define VIRTIO_INPUT_FROM_ABS_POINTER_THIS(a) \
          CR (a, VIRTIO_INPUT_DEV, AbsolutePointer, VIRTIO_INPUT_SIG)

// Bellow candidates to be included as Linux header
#define KEY_PRESSED  1

//
// VirtioInput.c
//
EFI_STATUS
VirtioInputConfigQuerySize (
  IN VIRTIO_INPUT_DEV            *Dev,
  IN VIRTIO_INPUT_CONFIG_SELECT  Select,
  IN UINT8                       Subsel,
  OUT UINT8                      *Size
  );

VOID
EFIAPI
VirtioInputTimer (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );

//
// VirtioKeyboard.c
//
BOOLEAN
VirtioKeyboardProbe (
  IN VIRTIO_INPUT_DEV  *Dev
  );

VOID
VirtioKeyboardHandleEvent (
  IN OUT VIRTIO_INPUT_DEV  *Dev,
  IN VIRTIO_INPUT_EVENT    *Event
  );

EFI_STATUS
VirtioKeyboardInit (
  IN OUT VIRTIO_INPUT_DEV  *Dev
  );

VOID
VirtioKeyboardUninit (
  IN OUT VIRTIO_INPUT_DEV  *Dev
  );

//
// VirtioMouse.c
//
BOOLEAN
VirtioMouseProbe (
  IN VIRTIO_INPUT_DEV  *Dev
  );

VOID
VirtioMouseHandleEvent (
  IN OUT VIRTIO_INPUT_DEV  *Dev,
  IN VIRTIO_INPUT_EVENT    *Event
  );

EFI_STATUS
VirtioMouseInit (
  IN OUT VIRTIO_INPUT_DEV  *Dev
  );

VOID
VirtioMouseUninit (
  IN OUT VIRTIO_INPUT_DEV  *Dev
  );

//
// VirtioTablet.c
//
BOOLEAN
VirtioTabletProbe (
  IN VIRTIO_INPUT_DEV  *Dev
  );

VOID
VirtioTabletHandleEvent (
  IN OUT VIRTIO_INPUT_DEV  *Dev,
  IN VIRTIO_INPUT_EVENT    *Event
  );

EFI_STATUS
VirtioTabletInit (
  IN OUT VIRTIO_INPUT_DEV  *Dev
  );

VOID
VirtioTabletUninit (
  IN OUT VIRTIO_INPUT_DEV  *Dev
  );