OvmfPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / OvmfPkg / Library / VirtioMmioDeviceLib / VirtioMmioDevice.h

/** @file\r
\r
  Internal definitions for the VirtIo MMIO Device driver\r
\r
  Copyright (C) 2013, ARM Ltd\r
  Copyright (C) 2017, AMD Inc. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _VIRTIO_MMIO_DEVICE_INTERNAL_H_\r
#define _VIRTIO_MMIO_DEVICE_INTERNAL_H_\r
\r
#include <Protocol/VirtioDevice.h>\r
\r
#include <IndustryStandard/Virtio.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/VirtioMmioDeviceLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
\r
#define VIRTIO_MMIO_DEVICE_SIGNATURE  SIGNATURE_32 ('V', 'M', 'I', 'O')\r
\r
typedef struct {\r
  UINT32                 Signature;\r
  VIRTIO_DEVICE_PROTOCOL VirtioDevice;\r
  PHYSICAL_ADDRESS       BaseAddress;\r
} VIRTIO_MMIO_DEVICE;\r
\r
#define VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE(Device) \\r
    CR (Device, VIRTIO_MMIO_DEVICE, VirtioDevice, VIRTIO_MMIO_DEVICE_SIGNATURE)\r
\r
#define VIRTIO_CFG_WRITE(Device, Offset, Val) \\r
    (MmioWrite32 (Device->BaseAddress + (Offset), Val))\r
#define VIRTIO_CFG_READ(Device, Offset)       \\r
    (MmioRead32  (Device->BaseAddress + (Offset)))\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioDeviceRead (\r
  IN  VIRTIO_DEVICE_PROTOCOL    *This,\r
  IN  UINTN                     FieldOFfset,\r
  IN  UINTN                     FieldSize,\r
  IN  UINTN                     BufferSize,\r
  OUT VOID*                     Buffer\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioDeviceWrite (\r
  IN  VIRTIO_DEVICE_PROTOCOL    *This,\r
  IN  UINTN                     FieldOffset,\r
  IN  UINTN                     FieldSize,\r
  IN  UINT64                    Value\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioGetDeviceFeatures (\r
  IN VIRTIO_DEVICE_PROTOCOL *This,\r
  OUT UINT64                *DeviceFeatures\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioGetQueueSize (\r
  IN  VIRTIO_DEVICE_PROTOCOL  *This,\r
  OUT UINT16                  *QueueNumMax\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioGetDeviceStatus (\r
  IN  VIRTIO_DEVICE_PROTOCOL  *This,\r
  OUT UINT8                   *DeviceStatus\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetQueueSize (\r
  IN VIRTIO_DEVICE_PROTOCOL *This,\r
  IN UINT16                  QueueSize\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetDeviceStatus (\r
  IN VIRTIO_DEVICE_PROTOCOL *This,\r
  IN UINT8                   DeviceStatus\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetQueueNotify (\r
  IN VIRTIO_DEVICE_PROTOCOL *This,\r
  IN UINT16                  QueueNotify\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetQueueSel (\r
  IN VIRTIO_DEVICE_PROTOCOL *This,\r
  IN UINT16                  Sel\r
  );\r
\r
EFI_STATUS\r
VirtioMmioSetQueueAddress (\r
  IN VIRTIO_DEVICE_PROTOCOL  *This,\r
  IN VRING                   *Ring,\r
  IN UINT64                  RingBaseShift\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetQueueAlignment (\r
  IN VIRTIO_DEVICE_PROTOCOL *This,\r
  IN UINT32                  Alignment\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetPageSize (\r
  IN VIRTIO_DEVICE_PROTOCOL *This,\r
  IN UINT32                  PageSize\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetGuestFeatures (\r
  IN VIRTIO_DEVICE_PROTOCOL *This,\r
  IN UINT64                  Features\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioAllocateSharedPages (\r
  IN  VIRTIO_DEVICE_PROTOCOL        *This,\r
  IN  UINTN                         NumPages,\r
  OUT VOID                          **HostAddress\r
  );\r
\r
VOID\r
EFIAPI\r
VirtioMmioFreeSharedPages (\r
  IN  VIRTIO_DEVICE_PROTOCOL        *This,\r
  IN  UINTN                         NumPages,\r
  IN  VOID                          *HostAddress\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioMapSharedBuffer (\r
  IN      VIRTIO_DEVICE_PROTOCOL        *This,\r
  IN      VIRTIO_MAP_OPERATION          Operation,\r
  IN      VOID                          *HostAddress,\r
  IN OUT  UINTN                         *NumberOfBytes,\r
  OUT     EFI_PHYSICAL_ADDRESS          *DeviceAddress,\r
  OUT     VOID                          **Mapping\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioUnmapSharedBuffer (\r
  IN  VIRTIO_DEVICE_PROTOCOL        *This,\r
  IN  VOID                          *Mapping\r
  );\r
\r
#endif // _VIRTIO_MMIO_DEVICE_INTERNAL_H_\r