Edit

Share via


PEP_ACPI_INITIALIZE_SPB_SPI_RESOURCE function (pepfx.h)

Note

Microsoft supports a diverse and inclusionary environment. This article contains references to terminology that the Microsoft Style Guide for Bias-Free Communications recognizes as exclusionary. The word or phrase is used in this article for consistency because it currently appears in the software. When the software is updated to remove the language, this article will be updated to be in alignment.

The PEP_ACPI_INITIALIZE_SPB_SPI_RESOURCE function initializes a platform extension plug-in's (PEP) PEP_ACPI_SPB_SPI_RESOURCE structure.

Syntax

void PEP_ACPI_INITIALIZE_SPB_SPI_RESOURCE(
  [in]  USHORT             DeviceSelection,
  [in]  UCHAR              DeviceSelectionPolarity,
  [in]  UCHAR              WireMode,
  [in]  UCHAR              DataBitLength,
  [in]  BOOLEAN            SlaveMode,
  [in]  ULONG              ConnectionSpeed,
  [in]  UCHAR              ClockPolarity,
  [in]  UCHAR              ClockPhase,
  [in]  PUNICODE_STRING    ResourceSource,
  [in]  UCHAR              ResourceSourceIndex,
  [in]  BOOLEAN            ResourceUsage,
  [in]  BOOLEAN            SharedMode,
  [in]  PCHAR              VendorData,
  [in]  USHORT             VendorDataLength,
  [out] PPEP_ACPI_RESOURCE Resource
);

Parameters

[in] DeviceSelection

The device selection value. This value is specific to the device and may refer to a chip-select line, GPIO line, or other line selection mechanism.

[in] DeviceSelectionPolarity

The polarity of the clock. If zero, this indicates the clock is low during the first phase. If 1, this indicates the clock is high during the first phase.

[in] WireMode

When zero, indicates that this device produces and consumes this resource. Otherwise, this device only consumes this resource.

[in] DataBitLength

The size, in bits, of the smallest unit of transfer.

[in] SlaveMode

Indicates if the resource is operating in slave mode.

[in] ConnectionSpeed

The maximum speed, in hertz, supported by this connection.

[in] ClockPolarity

The polarity of the clock. If zero, this indicates the clock is low during the first phase. If 1, this indicates the clock is high during the first phase.

[in] ClockPhase

The phase of the clock pulse on which to capture data.

[in] ResourceSource

The name of the serial bus controller device to which this connection descriptor applies. The name can be a fully qualified path, a relative path, or a simple name segment that utilizes the namespace search rules.

[in] ResourceSourceIndex

This parameter should always be set to zero.

[in] ResourceUsage

Indicates if the resource is in use.

[in] SharedMode

Indicates if the resource is shared.

[in] VendorData

A pointer to optional data that is specific to the serial bus connection type.

[in] VendorDataLength

The length of the buffer pointed to by the VendorData parameter.

[out] Resource

A pointer to the resource. The structure behind the pointer is of type PEP_ACPI_SPB_SPI_RESOURCE.

Return value

None

Requirements

Requirement Value
Minimum supported client Supported starting with Windows 10.
Target Platform Windows
Header pepfx.h (include Pep_x.h)

See also

PEP_ACPI_SPB_SPI_RESOURCE