OvmfPkg: Make the VirtIo devices use the new VIRTIO_DEVICE_PROTOCOL

This change replaces the accesses to the PCI bus from the Block, Scsi and Net drivers by
the use of the new VIRTIO_DEVICE_PROTOCOL protocol that abstracts the transport layer.
It means these drivers can be used on PCI and MMIO transport layer.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Olivier Martin <olivier.martin@arm.com>

v5:
- VirtioFlush(): update comment block in VirtioLib.[hc]; error code is
  propagated from VirtIo->SetQueueNotify().
- VirtioBlkInit(): jump to Failed label if SetPageSize() fails
- VirtioBlkInit(): fixup comment, and add error handling, near
  SetQueueNum() call
- VirtioBlkDriverBindingStart(): remove redundant (always false) check for
  a subsystem device ID different from VIRTIO_SUBSYSTEM_BLOCK_DEVICE;
  VirtioBlkDriverBindingSupported() handles it already
- VirtioNetGetFeatures(): update stale comment block
- VirtioNetGetFeatures(): retrieve MAC address byte for byte (open-coded
  loop)
- VirtioNetDriverBindingStart(): remove redundant (always false) check for
  a subsystem device ID different from VIRTIO_SUBSYSTEM_NETWORK_CARD;
  VirtioNetDriverBindingSupported() handles it already
- VirtioNetInitRing(): call SetQueueNum() and SetQueueAlign() for proper
  MMIO operation
- VirtioNetInitialize(): fix destination error label for when
  SetPageSize() fails
- VirtioScsi.c: fix comment block of VIRTIO_CFG_WRITE()/VIRTIO_CFG_READ()
- VirtioScsiInit(): fix destination error label for when SetPageSize()
  fails
- VirtioScsiInit(): call SetQueueNum() and SetQueueAlign() for proper MMIO
  operation

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14966 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 12 insertions, 20 deletions

diff --git a/OvmfPkg/VirtioBlkDxe/VirtioBlk.h b/OvmfPkg/VirtioBlkDxe/VirtioBlk.h
index d22570def9..789caf9a37 100644
--- a/OvmfPkg/VirtioBlkDxe/VirtioBlk.h
+++ b/OvmfPkg/VirtioBlkDxe/VirtioBlk.h
@@ -21,7 +21,6 @@
 #include <Protocol/BlockIo.h>

 #include <Protocol/ComponentName.h>

 #include <Protocol/DriverBinding.h>

-#include <Protocol/PciIo.h>

 

 #include <IndustryStandard/Virtio.h>

 

@@ -34,14 +33,13 @@ typedef struct {
   // at various call depths. The table to the right should make it easier to

   // track them.

   //

-  //                    field                     init function       init dpth

-  //                    ----------------------    ------------------  ---------

-  UINT32                Signature;             // DriverBindingStart  0

-  EFI_PCI_IO_PROTOCOL   *PciIo;                // DriverBindingStart  0

-  UINT64                OriginalPciAttributes; // DriverBindingStart  0

-  VRING                 Ring;                  // VirtioRingInit      2

-  EFI_BLOCK_IO_PROTOCOL BlockIo;               // VirtioBlkInit       1

-  EFI_BLOCK_IO_MEDIA    BlockIoMedia;          // VirtioBlkInit       1

+  //                     field                    init function       init dpth

+  //                     ---------------------    ------------------  ---------

+  UINT32                 Signature;            // DriverBindingStart  0

+  VIRTIO_DEVICE_PROTOCOL *VirtIo;              // DriverBindingStart  0

+  VRING                  Ring;                 // VirtioRingInit      2

+  EFI_BLOCK_IO_PROTOCOL  BlockIo;              // VirtioBlkInit       1

+  EFI_BLOCK_IO_MEDIA     BlockIoMedia;         // VirtioBlkInit       1

 } VBLK_DEV;

 

 #define VIRTIO_BLK_FROM_BLOCK_IO(BlockIoPointer) \

@@ -66,11 +64,6 @@ typedef struct {
       underlying device

     - 9 Driver Binding Protocol -- for exporting ourselves

 

-  Specs relevant in the specific sense:

-  - UEFI Spec 2.3.1 + Errata C, 13.4 EFI PCI I/O Protocol

-  - Driver Writer's Guide for UEFI 2.3.1 v1.01, 18 PCI Driver Design

-    Guidelines, 18.3 PCI drivers.

-

   @param[in]  This                The EFI_DRIVER_BINDING_PROTOCOL object

                                   incorporating this driver (independently of

                                   any device).

@@ -82,11 +75,10 @@ typedef struct {
 

   @retval EFI_SUCCESS      The driver supports the device being probed.

 

-  @retval EFI_UNSUPPORTED  Based on virtio-blk PCI discovery, we do not support

+  @retval EFI_UNSUPPORTED  Based on virtio-blk discovery, we do not support

                            the device.

 

-  @return                  Error codes from the OpenProtocol() boot service or

-                           the PciIo protocol.

+  @return                  Error codes from the OpenProtocol() boot service.

 

 **/

 

@@ -117,14 +109,14 @@ VirtioBlkDriverBindingSupported (
 

 

   @retval EFI_SUCCESS           Driver instance has been created and

-                                initialized  for the virtio-blk PCI device, it

+                                initialized  for the virtio-blk device, it

                                 is now accessibla via EFI_BLOCK_IO_PROTOCOL.

 

   @retval EFI_OUT_OF_RESOURCES  Memory allocation failed.

 

   @return                       Error codes from the OpenProtocol() boot

-                                service, the PciIo protocol, VirtioBlkInit(),

-                                or the InstallProtocolInterface() boot service.

+                                service, VirtioBlkInit(), or the

+                                InstallProtocolInterface() boot service.

 

 **/