DXGKDDI_OPM_GET_CERTIFICATE callback function (dispmprt.h)

Article
03/15/2023

The DxgkDdiOPMGetCertificate function retrieves a certificate of the given type and size.

Syntax

DXGKDDI_OPM_GET_CERTIFICATE DxgkddiOpmGetCertificate;

NTSTATUS DxgkddiOpmGetCertificate(
  [in]  PVOID MiniportDeviceContext,
  [in]  DXGKMDT_CERTIFICATE_TYPE CertificateType,
  [in]  ULONG CertificateSize,
  [out] PVOID CertificateBuffer
)
{...}

Parameters

[in] MiniportDeviceContext

A handle to a context block associated with a display adapter. Previously, the display miniport driver's DxgkDdiAddDevice function provided this handle to the DirectX graphics kernel subsystem.

[in] CertificateType

A DXGKMDT_CERTIFICATE_TYPE-typed value that identifies the type of certificate to retrieve.

[in] CertificateSize

The size, in bytes, of the certificate to retrieve. This size was returned by a call to the display miniport driver's DxgkDdiOPMGetCertificateSize function.

[out] CertificateBuffer

A pointer to a buffer that receives the requested certificate if DxgkDdiOPMGetCertificate returns successfully. If DxgkDdiOPMGetCertificate fails, the contents of the buffer are unchanged.

Return value

DxgkDdiOPMGetCertificate returns one of the following values.

Return code	Description
STATUS_SUCCESS	The function successfully retrieved the certificate size.
STATUS_GRAPHICS_OPM_NOT_SUPPORTED	The display miniport driver does not support OPM either because the hardware vendor never signed the OPM license agreement or the miniport driver's graphics hardware does not comply with OPM rules. DxgkDdiOPMGetCertificate can also return this value if the display miniport driver detected tampering.
STATUS_GRAPHICS_COPP_NOT_SUPPORTED	The display miniport driver does not support COPP either because the hardware vendor never signed the COPP license agreement or the miniport driver's graphics hardware does not comply with COPP rules. DxgkDdiOPMGetCertificate can also return this value if the display miniport driver detected tampering.
STATUS_GRAPHICS_UAB_NOT_SUPPORTED	The display miniport driver does not support UAB either because the hardware vendor never signed the UAB license agreement or the miniport driver's graphics hardware does not comply with UAB rules. DxgkDdiOPMGetCertificate can also return this value if the display miniport driver detected tampering.
STATUS_GRAPHICS_PVP_HFS_FAILED	The display miniport driver's hardware functionality scan (HFS) failed or the display miniport driver detected tampering. A display miniport driver can optionally return this value. If DxgkDdiOPMGetCertificate does not return this value for tampering, it can return one of the previous error codes instead.

This function might also return other error codes that are defined in Ntstatus.h.

Remarks

DxgkDdiOPMGetCertificate can retrieve the display miniport driver's OPM certificate, User Accessible Bus (UAB) certificate, or Certified Output Protection Protocol (COPP) certificate. For information about these certificates, download the Output Content Protection and Windows Vista document.

DxgkDdiOPMGetCertificate should be made pageable.

Requirements

Requirement	Value
Target Platform	Desktop
Header	dispmprt.h (include Dispmprt.h)
IRQL	PASSIVE_LEVEL (see Remarks section)