OvmfPkg/VirtioGpuDxe: initialize and tear down VirtIo GPU device

[mirror_edk2.git] / OvmfPkg / VirtioGpuDxe / VirtioGpu.h

/** @file\r
\r
  Internal type and macro definitions for the Virtio GPU hybrid driver.\r
\r
  Copyright (C) 2016, Red Hat, Inc.\r
\r
  This program and the accompanying materials are licensed and made available\r
  under the terms and conditions of the BSD License which accompanies this\r
  distribution. The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r
  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _VIRTIO_GPU_DXE_H_\r
#define _VIRTIO_GPU_DXE_H_\r
\r
#include <Library/DebugLib.h>\r
#include <Library/UefiLib.h>\r
#include <Protocol/VirtioDevice.h>\r
\r
//\r
// Forward declaration of VGPU_GOP.\r
//\r
typedef struct VGPU_GOP_STRUCT VGPU_GOP;\r
\r
//\r
// The abstraction that directly corresponds to a Virtio GPU device.\r
//\r
// This structure will be installed on the handle that has the VirtIo Device\r
// Protocol interface, with GUID gEfiCallerIdGuid. A similar trick is employed\r
// in TerminalDxe, and it is necessary so that we can look up VGPU_DEV just\r
// from the VirtIo Device Protocol handle in the Component Name 2 Protocol\r
// implementation.\r
//\r
typedef struct {\r
  //\r
  // VirtIo represents access to the Virtio GPU device. Never NULL.\r
  //\r
  VIRTIO_DEVICE_PROTOCOL   *VirtIo;\r
\r
  //\r
  // BusName carries a customized name for\r
  // EFI_COMPONENT_NAME2_PROTOCOL.GetControllerName(). It is expressed in table\r
  // form because it can theoretically support several languages. Never NULL.\r
  //\r
  EFI_UNICODE_STRING_TABLE *BusName;\r
\r
  //\r
  // VirtIo ring used for VirtIo communication.\r
  //\r
  VRING                    Ring;\r
\r
  //\r
  // Event to be signaled at ExitBootServices().\r
  //\r
  EFI_EVENT                ExitBoot;\r
\r
  //\r
  // The Child field references the GOP wrapper structure. If this pointer is\r
  // NULL, then the hybrid driver has bound (i.e., started) the\r
  // VIRTIO_DEVICE_PROTOCOL controller without producing the child GOP\r
  // controller (that is, after Start() was called with RemainingDevicePath\r
  // pointing to and End of Device Path node). Child can be created and\r
  // destroyed, even repeatedly, independently of VGPU_DEV.\r
  //\r
  // In practice, this field represents the single head (scanout) that we\r
  // support.\r
  //\r
  VGPU_GOP                 *Child;\r
} VGPU_DEV;\r
\r
//\r
// The Graphics Output Protocol wrapper structure.\r
//\r
#define VGPU_GOP_SIG SIGNATURE_64 ('V', 'G', 'P', 'U', '_', 'G', 'O', 'P')\r
\r
struct VGPU_GOP_STRUCT {\r
  UINT64                               Signature;\r
\r
  //\r
  // ParentBus points to the parent VGPU_DEV object. Never NULL.\r
  //\r
  VGPU_DEV                             *ParentBus;\r
\r
  //\r
  // GopName carries a customized name for\r
  // EFI_COMPONENT_NAME2_PROTOCOL.GetControllerName(). It is expressed in table\r
  // form because it can theoretically support several languages. Never NULL.\r
  //\r
  EFI_UNICODE_STRING_TABLE             *GopName;\r
\r
  //\r
  // GopHandle is the UEFI child handle that carries the device path ending\r
  // with the ACPI ADR node, and the Graphics Output Protocol. Never NULL.\r
  //\r
  EFI_HANDLE                           GopHandle;\r
\r
  //\r
  // The GopDevicePath field is the device path installed on GopHandle,\r
  // ending with an ACPI ADR node. Never NULL.\r
  //\r
  EFI_DEVICE_PATH_PROTOCOL             *GopDevicePath;\r
\r
  //\r
  // The Gop field is installed on the child handle as Graphics Output Protocol\r
  // interface.\r
  //\r
  // For now it is just a placeholder.\r
  //\r
  UINT8                                Gop;\r
};\r
\r
//\r
// VirtIo GPU initialization, and commands (primitives) for the GPU device.\r
//\r
/**\r
  Configure the VirtIo GPU device that underlies VgpuDev.\r
\r
  @param[in,out] VgpuDev  The VGPU_DEV object to set up VirtIo messaging for.\r
                          On input, the caller is responsible for having\r
                          initialized VgpuDev->VirtIo. On output, VgpuDev->Ring\r
                          has been initialized, and synchronous VirtIo GPU\r
                          commands (primitives) can be submitted to the device.\r
\r
  @retval EFI_SUCCESS      VirtIo GPU configuration successful.\r
\r
  @retval EFI_UNSUPPORTED  The host-side configuration of the VirtIo GPU is not\r
                           supported by this driver.\r
\r
  @retval                  Error codes from underlying functions.\r
**/\r
EFI_STATUS\r
VirtioGpuInit (\r
  IN OUT VGPU_DEV *VgpuDev\r
  );\r
\r
/**\r
  De-configure the VirtIo GPU device that underlies VgpuDev.\r
\r
  @param[in,out] VgpuDev  The VGPU_DEV object to tear down VirtIo messaging\r
                          for. On input, the caller is responsible for having\r
                          called VirtioGpuInit(). On output, VgpuDev->Ring has\r
                          been uninitialized; VirtIo GPU commands (primitives)\r
                          can no longer be submitted to the device.\r
**/\r
VOID\r
VirtioGpuUninit (\r
  IN OUT VGPU_DEV *VgpuDev\r
  );\r
\r
/**\r
  EFI_EVENT_NOTIFY function for the VGPU_DEV.ExitBoot event. It resets the\r
  VirtIo device, causing it to release its resources and to forget its\r
  configuration.\r
\r
  This function may only be called (that is, VGPU_DEV.ExitBoot may only be\r
  signaled) after VirtioGpuInit() returns and before VirtioGpuUninit() is\r
  called.\r
\r
  @param[in] Event    Event whose notification function is being invoked.\r
\r
  @param[in] Context  Pointer to the associated VGPU_DEV object.\r
**/\r
VOID\r
EFIAPI\r
VirtioGpuExitBoot (\r
  IN EFI_EVENT Event,\r
  IN VOID      *Context\r
  );\r
\r
#endif // _VIRTIO_GPU_DXE_H_\r