VirtioPciFunctions.c 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373
  1. /** @file
  2. This driver produces Virtio Device Protocol instances for Virtio PCI devices.
  3. Copyright (C) 2012, Red Hat, Inc.
  4. Copyright (c) 2012, Intel Corporation. All rights reserved.<BR>
  5. Copyright (C) 2013, ARM Ltd.
  6. Copyright (C) 2017, AMD Inc, All rights reserved.<BR>
  7. SPDX-License-Identifier: BSD-2-Clause-Patent
  8. **/
  9. #include <Library/BaseMemoryLib.h>
  10. #include <Library/DebugLib.h>
  11. #include <Library/MemoryAllocationLib.h>
  12. #include <Library/UefiBootServicesTableLib.h>
  13. #include <Library/UefiLib.h>
  14. #include "VirtioPciDevice.h"
  15. /**
  16. Read a word from Region 0 of the device specified by VirtIo Device protocol.
  17. The function implements the ReadDevice protocol member of
  18. VIRTIO_DEVICE_PROTOCOL.
  19. @param[in] This VirtIo Device protocol.
  20. @param[in] FieldOffset Source offset.
  21. @param[in] FieldSize Source field size, must be in { 1, 2, 4, 8 }.
  22. @param[in] BufferSize Number of bytes available in the target buffer. Must
  23. equal FieldSize.
  24. @param[out] Buffer Target buffer.
  25. @return Status code returned by PciIo->Io.Read().
  26. **/
  27. EFI_STATUS
  28. EFIAPI
  29. VirtioPciDeviceRead (
  30. IN VIRTIO_DEVICE_PROTOCOL *This,
  31. IN UINTN FieldOffset,
  32. IN UINTN FieldSize,
  33. IN UINTN BufferSize,
  34. OUT VOID *Buffer
  35. )
  36. {
  37. VIRTIO_PCI_DEVICE *Dev;
  38. Dev = VIRTIO_PCI_DEVICE_FROM_VIRTIO_DEVICE (This);
  39. return VirtioPciIoRead (
  40. Dev,
  41. Dev->DeviceSpecificConfigurationOffset + FieldOffset,
  42. FieldSize,
  43. BufferSize,
  44. Buffer
  45. );
  46. }
  47. /**
  48. Write a word into Region 0 of the device specified by VirtIo Device protocol.
  49. @param[in] This VirtIo Device protocol.
  50. @param[in] FieldOffset Destination offset.
  51. @param[in] FieldSize Destination field size, must be in { 1, 2, 4, 8 }.
  52. @param[in] Value Little endian value to write, converted to UINT64.
  53. The least significant FieldSize bytes will be used.
  54. @return Status code returned by PciIo->Io.Write().
  55. **/
  56. EFI_STATUS
  57. EFIAPI
  58. VirtioPciDeviceWrite (
  59. IN VIRTIO_DEVICE_PROTOCOL *This,
  60. IN UINTN FieldOffset,
  61. IN UINTN FieldSize,
  62. IN UINT64 Value
  63. )
  64. {
  65. VIRTIO_PCI_DEVICE *Dev;
  66. Dev = VIRTIO_PCI_DEVICE_FROM_VIRTIO_DEVICE (This);
  67. return VirtioPciIoWrite (
  68. Dev,
  69. Dev->DeviceSpecificConfigurationOffset + FieldOffset,
  70. FieldSize,
  71. Value
  72. );
  73. }
  74. EFI_STATUS
  75. EFIAPI
  76. VirtioPciGetDeviceFeatures (
  77. IN VIRTIO_DEVICE_PROTOCOL *This,
  78. OUT UINT64 *DeviceFeatures
  79. )
  80. {
  81. VIRTIO_PCI_DEVICE *Dev;
  82. EFI_STATUS Status;
  83. UINT32 Features32;
  84. if (DeviceFeatures == NULL) {
  85. return EFI_INVALID_PARAMETER;
  86. }
  87. Dev = VIRTIO_PCI_DEVICE_FROM_VIRTIO_DEVICE (This);
  88. Status = VirtioPciIoRead (
  89. Dev,
  90. VIRTIO_PCI_OFFSET_DEVICE_FEATURES,
  91. sizeof (UINT32),
  92. sizeof (UINT32),
  93. &Features32
  94. );
  95. if (!EFI_ERROR (Status)) {
  96. *DeviceFeatures = Features32;
  97. }
  98. return Status;
  99. }
  100. EFI_STATUS
  101. EFIAPI
  102. VirtioPciGetQueueSize (
  103. IN VIRTIO_DEVICE_PROTOCOL *This,
  104. OUT UINT16 *QueueNumMax
  105. )
  106. {
  107. VIRTIO_PCI_DEVICE *Dev;
  108. if (QueueNumMax == NULL) {
  109. return EFI_INVALID_PARAMETER;
  110. }
  111. Dev = VIRTIO_PCI_DEVICE_FROM_VIRTIO_DEVICE (This);
  112. return VirtioPciIoRead (
  113. Dev,
  114. VIRTIO_PCI_OFFSET_QUEUE_SIZE,
  115. sizeof (UINT16),
  116. sizeof (UINT16),
  117. QueueNumMax
  118. );
  119. }
  120. EFI_STATUS
  121. EFIAPI
  122. VirtioPciGetDeviceStatus (
  123. IN VIRTIO_DEVICE_PROTOCOL *This,
  124. OUT UINT8 *DeviceStatus
  125. )
  126. {
  127. VIRTIO_PCI_DEVICE *Dev;
  128. if (DeviceStatus == NULL) {
  129. return EFI_INVALID_PARAMETER;
  130. }
  131. Dev = VIRTIO_PCI_DEVICE_FROM_VIRTIO_DEVICE (This);
  132. return VirtioPciIoRead (
  133. Dev,
  134. VIRTIO_PCI_OFFSET_QUEUE_DEVICE_STATUS,
  135. sizeof (UINT8),
  136. sizeof (UINT8),
  137. DeviceStatus
  138. );
  139. }
  140. EFI_STATUS
  141. EFIAPI
  142. VirtioPciSetGuestFeatures (
  143. IN VIRTIO_DEVICE_PROTOCOL *This,
  144. IN UINT64 Features
  145. )
  146. {
  147. VIRTIO_PCI_DEVICE *Dev;
  148. Dev = VIRTIO_PCI_DEVICE_FROM_VIRTIO_DEVICE (This);
  149. if (Features > MAX_UINT32) {
  150. return EFI_UNSUPPORTED;
  151. }
  152. return VirtioPciIoWrite (
  153. Dev,
  154. VIRTIO_PCI_OFFSET_GUEST_FEATURES,
  155. sizeof (UINT32),
  156. Features
  157. );
  158. }
  159. EFI_STATUS
  160. EFIAPI
  161. VirtioPciSetQueueAddress (
  162. IN VIRTIO_DEVICE_PROTOCOL *This,
  163. IN VRING *Ring,
  164. IN UINT64 RingBaseShift
  165. )
  166. {
  167. VIRTIO_PCI_DEVICE *Dev;
  168. ASSERT (RingBaseShift == 0);
  169. Dev = VIRTIO_PCI_DEVICE_FROM_VIRTIO_DEVICE (This);
  170. return VirtioPciIoWrite (
  171. Dev,
  172. VIRTIO_PCI_OFFSET_QUEUE_ADDRESS,
  173. sizeof (UINT32),
  174. (UINT32)((UINTN)Ring->Base >> EFI_PAGE_SHIFT)
  175. );
  176. }
  177. EFI_STATUS
  178. EFIAPI
  179. VirtioPciSetQueueSel (
  180. IN VIRTIO_DEVICE_PROTOCOL *This,
  181. IN UINT16 Sel
  182. )
  183. {
  184. VIRTIO_PCI_DEVICE *Dev;
  185. Dev = VIRTIO_PCI_DEVICE_FROM_VIRTIO_DEVICE (This);
  186. return VirtioPciIoWrite (
  187. Dev,
  188. VIRTIO_PCI_OFFSET_QUEUE_SELECT,
  189. sizeof (UINT16),
  190. Sel
  191. );
  192. }
  193. EFI_STATUS
  194. EFIAPI
  195. VirtioPciSetQueueAlignment (
  196. IN VIRTIO_DEVICE_PROTOCOL *This,
  197. IN UINT32 Alignment
  198. )
  199. {
  200. return EFI_SUCCESS;
  201. }
  202. EFI_STATUS
  203. EFIAPI
  204. VirtioPciSetPageSize (
  205. IN VIRTIO_DEVICE_PROTOCOL *This,
  206. IN UINT32 PageSize
  207. )
  208. {
  209. return (PageSize == EFI_PAGE_SIZE) ? EFI_SUCCESS : EFI_UNSUPPORTED;
  210. }
  211. EFI_STATUS
  212. EFIAPI
  213. VirtioPciSetQueueNotify (
  214. IN VIRTIO_DEVICE_PROTOCOL *This,
  215. IN UINT16 Index
  216. )
  217. {
  218. VIRTIO_PCI_DEVICE *Dev;
  219. Dev = VIRTIO_PCI_DEVICE_FROM_VIRTIO_DEVICE (This);
  220. return VirtioPciIoWrite (
  221. Dev,
  222. VIRTIO_PCI_OFFSET_QUEUE_NOTIFY,
  223. sizeof (UINT16),
  224. Index
  225. );
  226. }
  227. EFI_STATUS
  228. EFIAPI
  229. VirtioPciSetQueueSize (
  230. IN VIRTIO_DEVICE_PROTOCOL *This,
  231. IN UINT16 Size
  232. )
  233. {
  234. //
  235. // This function is only applicable in Virtio-MMIO.
  236. // (The QueueSize field is read-only in Virtio proper (PCI))
  237. //
  238. return EFI_SUCCESS;
  239. }
  240. EFI_STATUS
  241. EFIAPI
  242. VirtioPciSetDeviceStatus (
  243. IN VIRTIO_DEVICE_PROTOCOL *This,
  244. IN UINT8 DeviceStatus
  245. )
  246. {
  247. VIRTIO_PCI_DEVICE *Dev;
  248. Dev = VIRTIO_PCI_DEVICE_FROM_VIRTIO_DEVICE (This);
  249. return VirtioPciIoWrite (
  250. Dev,
  251. VIRTIO_PCI_OFFSET_QUEUE_DEVICE_STATUS,
  252. sizeof (UINT8),
  253. DeviceStatus
  254. );
  255. }
  256. EFI_STATUS
  257. EFIAPI
  258. VirtioPciAllocateSharedPages (
  259. IN VIRTIO_DEVICE_PROTOCOL *This,
  260. IN UINTN NumPages,
  261. OUT VOID **HostAddress
  262. )
  263. {
  264. VOID *Buffer;
  265. Buffer = AllocatePages (NumPages);
  266. if (Buffer == NULL) {
  267. return EFI_OUT_OF_RESOURCES;
  268. }
  269. *HostAddress = Buffer;
  270. return EFI_SUCCESS;
  271. }
  272. VOID
  273. EFIAPI
  274. VirtioPciFreeSharedPages (
  275. IN VIRTIO_DEVICE_PROTOCOL *This,
  276. IN UINTN NumPages,
  277. IN VOID *HostAddress
  278. )
  279. {
  280. FreePages (HostAddress, NumPages);
  281. }
  282. EFI_STATUS
  283. EFIAPI
  284. VirtioPciMapSharedBuffer (
  285. IN VIRTIO_DEVICE_PROTOCOL *This,
  286. IN VIRTIO_MAP_OPERATION Operation,
  287. IN VOID *HostAddress,
  288. IN OUT UINTN *NumberOfBytes,
  289. OUT EFI_PHYSICAL_ADDRESS *DeviceAddress,
  290. OUT VOID **Mapping
  291. )
  292. {
  293. *DeviceAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)HostAddress;
  294. *Mapping = NULL;
  295. return EFI_SUCCESS;
  296. }
  297. EFI_STATUS
  298. EFIAPI
  299. VirtioPciUnmapSharedBuffer (
  300. IN VIRTIO_DEVICE_PROTOCOL *This,
  301. IN VOID *Mapping
  302. )
  303. {
  304. return EFI_SUCCESS;
  305. }