| 1 | /** @file\r |
| 2 | \r |
| 3 | Internal definitions for the VirtIo MMIO Device driver\r |
| 4 | \r |
| 5 | Copyright (C) 2013, ARM Ltd\r |
| 6 | Copyright (C) 2017, AMD Inc. All rights reserved.<BR>\r |
| 7 | \r |
| 8 | This program and the accompanying materials are licensed and made available\r |
| 9 | under the terms and conditions of the BSD License which accompanies this\r |
| 10 | distribution. The full text of the license may be found at\r |
| 11 | http://opensource.org/licenses/bsd-license.php\r |
| 12 | \r |
| 13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r |
| 14 | WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
| 15 | \r |
| 16 | **/\r |
| 17 | \r |
| 18 | #ifndef _VIRTIO_MMIO_DEVICE_INTERNAL_H_\r |
| 19 | #define _VIRTIO_MMIO_DEVICE_INTERNAL_H_\r |
| 20 | \r |
| 21 | #include <Protocol/VirtioDevice.h>\r |
| 22 | \r |
| 23 | #include <IndustryStandard/Virtio.h>\r |
| 24 | \r |
| 25 | #include <Library/DebugLib.h>\r |
| 26 | #include <Library/IoLib.h>\r |
| 27 | #include <Library/UefiLib.h>\r |
| 28 | #include <Library/VirtioMmioDeviceLib.h>\r |
| 29 | #include <Library/MemoryAllocationLib.h>\r |
| 30 | \r |
| 31 | #define VIRTIO_MMIO_DEVICE_SIGNATURE SIGNATURE_32 ('V', 'M', 'I', 'O')\r |
| 32 | \r |
| 33 | typedef struct {\r |
| 34 | UINT32 Signature;\r |
| 35 | VIRTIO_DEVICE_PROTOCOL VirtioDevice;\r |
| 36 | PHYSICAL_ADDRESS BaseAddress;\r |
| 37 | } VIRTIO_MMIO_DEVICE;\r |
| 38 | \r |
| 39 | #define VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE(Device) \\r |
| 40 | CR (Device, VIRTIO_MMIO_DEVICE, VirtioDevice, VIRTIO_MMIO_DEVICE_SIGNATURE)\r |
| 41 | \r |
| 42 | #define VIRTIO_CFG_WRITE(Device, Offset, Val) \\r |
| 43 | (MmioWrite32 (Device->BaseAddress + (Offset), Val))\r |
| 44 | #define VIRTIO_CFG_READ(Device, Offset) \\r |
| 45 | (MmioRead32 (Device->BaseAddress + (Offset)))\r |
| 46 | \r |
| 47 | EFI_STATUS\r |
| 48 | EFIAPI\r |
| 49 | VirtioMmioDeviceRead (\r |
| 50 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 51 | IN UINTN FieldOFfset,\r |
| 52 | IN UINTN FieldSize,\r |
| 53 | IN UINTN BufferSize,\r |
| 54 | OUT VOID* Buffer\r |
| 55 | );\r |
| 56 | \r |
| 57 | EFI_STATUS\r |
| 58 | EFIAPI\r |
| 59 | VirtioMmioDeviceWrite (\r |
| 60 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 61 | IN UINTN FieldOffset,\r |
| 62 | IN UINTN FieldSize,\r |
| 63 | IN UINT64 Value\r |
| 64 | );\r |
| 65 | \r |
| 66 | EFI_STATUS\r |
| 67 | EFIAPI\r |
| 68 | VirtioMmioGetDeviceFeatures (\r |
| 69 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 70 | OUT UINT64 *DeviceFeatures\r |
| 71 | );\r |
| 72 | \r |
| 73 | EFI_STATUS\r |
| 74 | EFIAPI\r |
| 75 | VirtioMmioGetQueueSize (\r |
| 76 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 77 | OUT UINT16 *QueueNumMax\r |
| 78 | );\r |
| 79 | \r |
| 80 | EFI_STATUS\r |
| 81 | EFIAPI\r |
| 82 | VirtioMmioGetDeviceStatus (\r |
| 83 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 84 | OUT UINT8 *DeviceStatus\r |
| 85 | );\r |
| 86 | \r |
| 87 | EFI_STATUS\r |
| 88 | EFIAPI\r |
| 89 | VirtioMmioSetQueueSize (\r |
| 90 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 91 | IN UINT16 QueueSize\r |
| 92 | );\r |
| 93 | \r |
| 94 | EFI_STATUS\r |
| 95 | EFIAPI\r |
| 96 | VirtioMmioSetDeviceStatus (\r |
| 97 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 98 | IN UINT8 DeviceStatus\r |
| 99 | );\r |
| 100 | \r |
| 101 | EFI_STATUS\r |
| 102 | EFIAPI\r |
| 103 | VirtioMmioSetQueueNotify (\r |
| 104 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 105 | IN UINT16 QueueNotify\r |
| 106 | );\r |
| 107 | \r |
| 108 | EFI_STATUS\r |
| 109 | EFIAPI\r |
| 110 | VirtioMmioSetQueueSel (\r |
| 111 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 112 | IN UINT16 Sel\r |
| 113 | );\r |
| 114 | \r |
| 115 | EFI_STATUS\r |
| 116 | VirtioMmioSetQueueAddress (\r |
| 117 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 118 | IN VRING *Ring,\r |
| 119 | IN UINT64 RingBaseShift\r |
| 120 | );\r |
| 121 | \r |
| 122 | EFI_STATUS\r |
| 123 | EFIAPI\r |
| 124 | VirtioMmioSetQueueAlignment (\r |
| 125 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 126 | IN UINT32 Alignment\r |
| 127 | );\r |
| 128 | \r |
| 129 | EFI_STATUS\r |
| 130 | EFIAPI\r |
| 131 | VirtioMmioSetPageSize (\r |
| 132 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 133 | IN UINT32 PageSize\r |
| 134 | );\r |
| 135 | \r |
| 136 | EFI_STATUS\r |
| 137 | EFIAPI\r |
| 138 | VirtioMmioSetGuestFeatures (\r |
| 139 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 140 | IN UINT64 Features\r |
| 141 | );\r |
| 142 | \r |
| 143 | EFI_STATUS\r |
| 144 | EFIAPI\r |
| 145 | VirtioMmioAllocateSharedPages (\r |
| 146 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 147 | IN UINTN NumPages,\r |
| 148 | OUT VOID **HostAddress\r |
| 149 | );\r |
| 150 | \r |
| 151 | VOID\r |
| 152 | EFIAPI\r |
| 153 | VirtioMmioFreeSharedPages (\r |
| 154 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 155 | IN UINTN NumPages,\r |
| 156 | IN VOID *HostAddress\r |
| 157 | );\r |
| 158 | \r |
| 159 | EFI_STATUS\r |
| 160 | EFIAPI\r |
| 161 | VirtioMmioMapSharedBuffer (\r |
| 162 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 163 | IN VIRTIO_MAP_OPERATION Operation,\r |
| 164 | IN VOID *HostAddress,\r |
| 165 | IN OUT UINTN *NumberOfBytes,\r |
| 166 | OUT EFI_PHYSICAL_ADDRESS *DeviceAddress,\r |
| 167 | OUT VOID **Mapping\r |
| 168 | );\r |
| 169 | \r |
| 170 | EFI_STATUS\r |
| 171 | EFIAPI\r |
| 172 | VirtioMmioUnmapSharedBuffer (\r |
| 173 | IN VIRTIO_DEVICE_PROTOCOL *This,\r |
| 174 | IN VOID *Mapping\r |
| 175 | );\r |
| 176 | \r |
| 177 | #endif // _VIRTIO_MMIO_DEVICE_INTERNAL_H_\r |