OvmfPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / OvmfPkg / VirtioRngDxe / VirtioRng.h

/** @file\r
\r
  Private definitions of the VirtioRng RNG driver\r
\r
  Copyright (C) 2016, Linaro Ltd.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _VIRTIO_RNG_DXE_H_\r
#define _VIRTIO_RNG_DXE_H_\r
\r
#include <Protocol/ComponentName.h>\r
#include <Protocol/DriverBinding.h>\r
#include <Protocol/Rng.h>\r
\r
#include <IndustryStandard/Virtio.h>\r
\r
#define VIRTIO_RNG_SIG SIGNATURE_32 ('V', 'R', 'N', 'G')\r
\r
typedef struct {\r
  //\r
  // Parts of this structure are initialized / torn down in various functions\r
  // at various call depths. The table to the right should make it easier to\r
  // track them.\r
  //\r
  //                        field              init function       init depth\r
  //                        ----------------   ------------------  ----------\r
  UINT32                    Signature;      // DriverBindingStart   0\r
  VIRTIO_DEVICE_PROTOCOL    *VirtIo;        // DriverBindingStart   0\r
  EFI_EVENT                 ExitBoot;       // DriverBindingStart   0\r
  VRING                     Ring;           // VirtioRingInit       2\r
  EFI_RNG_PROTOCOL          Rng;            // VirtioRngInit        1\r
  VOID                      *RingMap;       // VirtioRingMap        2\r
} VIRTIO_RNG_DEV;\r
\r
#define VIRTIO_ENTROPY_SOURCE_FROM_RNG(RngPointer) \\r
          CR (RngPointer, VIRTIO_RNG_DEV, Rng, VIRTIO_RNG_SIG)\r
\r
#endif\r