template <>

class WireServer

Defined at line 5295 of file fidling/gen/sdk/fidl/fuchsia.hardware.pci/fuchsia.hardware.pci/cpp/fidl/fuchsia.hardware.pci/cpp/wire_messaging.h

Pure-virtual interface to be implemented by a server.

This interface uses typed channels (i.e. |::fidl::ClientEnd

::fuchsia_hardware_pci::Device>|

and |::fidl::ServerEnd

::fuchsia_hardware_pci::Device>|).

Public Methods

void GetDeviceInfo (GetDeviceInfoCompleter::Sync & completer)

Returns a structure containing device information from the configuration header.

void GetBar (::fuchsia_hardware_pci::wire::DeviceGetBarRequest * request, GetBarCompleter::Sync & completer)

Retrieves information for a specified Base Address Register (BAR). If the BAR contains

MSI-X capability tables then an attempt will be made to return an MMIO region excluding

those tables, if possible. Otherwise, an error will be returned.

Parameters:

|bar_id|: The id of the BAR being requested. Valid range is [0, 6).

Errors:

|ZX_ERR_ACCESS_DENIED|: The specified BAR does not have a driver-accessible region due to

the presence of MSI-X tables. To use MSI-X see the |SetInterruptMode| method.

|ZX_ERR_INTERNAL|: A bus driver error has occurred.

|ZX_ERR_INVALID_ARGS|: The |bar_id| specified is outside of the acceptable range.

|ZX_ERR_NOT_FOUND|: The specified |bar_id| does not exist for this device.

void SetBusMastering (::fuchsia_hardware_pci::wire::DeviceSetBusMasteringRequest * request, SetBusMasteringCompleter::Sync & completer)

Enables or disables the bus mastering capability for the device.

Parameters:

|enable|: true to enable bus mastering, false to disable.

Errors:

|ZX_ERR_BAD_STATE|: Method was called while the device is disabled.

void ResetDevice (ResetDeviceCompleter::Sync & completer)

Initiates a function level reset for the device. This is a synchronous

operation that will not return ontil the reset is complete. Interrupt

operation of the device must be disabled before initiating a reset.

Errors:

|ZX_ERR_BAD_STATE|: Interrupts were not disabled before calling |ResetDevice|.

|ZX_ERR_NOT_SUPPORTED|: The device does not support reset.

|ZX_ERR_TIMED_OUT|: The device did not complete its reset in the

expected amount of time and is presumed to no longer be operating

properly.

void AckInterrupt (AckInterruptCompleter::Sync & completer)

Alerts the bus driver to deassert the raised legacy interrupt so that it

may be waited on again. Only used if |SetInterruptMode| was called with

|PCI_INTERRUPT_MODE_LEGACY|.

Errors:

|ZX_ERR_BAD_STATE|: device is not configured to use the Legacy interrupt mode.

void MapInterrupt (::fuchsia_hardware_pci::wire::DeviceMapInterruptRequest * request, MapInterruptCompleter::Sync & completer)

Maps a device's interrupt to a zx:interrupt. The device's interrupt mode

must already be configured with |SetInterruptMode|, and |which_irq| must

be >= to the number of interrupts reported for that interrupt mode by

|GetInterruptModes|. A Legacy interrupt may be mapped multiple times,

but the handles will point to the same interrupt object. MSI

MSI-X

interrupts may only have one outstanding mapping at a time per

interrupt. Outstanding MSI

MSI-X interrupt handles must be closed

before attempting to change the interrupt mode in a subsequent call to

|SetInterruptMode|.

Parameters:

|which_irq|: The id of the interrupt to map.

Errors:

|ZX_ERR_ALREADY_BOUND|: The interrupt specified by |which_irq| is

already mapped to a valid handle.

|ZX_ERR_BAD_STATE|: interrupts are currently disabled for the device.

|ZX_ERR_INVALID_ARGS|: |which_irq| is invalid for the mode.

void GetInterruptModes (GetInterruptModesCompleter::Sync & completer)

Returns the supported interrupt modes for a device.

void SetInterruptMode (::fuchsia_hardware_pci::wire::DeviceSetInterruptModeRequest * request, SetInterruptModeCompleter::Sync & completer)

Configures the interrupt mode for a device. When changing from one

interrupt mode to another the driver must ensure existing interrupt

handles are closed beforehand.

Parameters:

|mode|: The |InterruptMode| to request from the bus driver.

|requested_irq_count|: The number of interrupts requested.

Errors:

|ZX_ERR_BAD_STATE|: The driver attempted to change interrupt mode while

existing handles to mapped MSIs exist.

|ZX_ERR_INVALID_ARGS|: |requested_irq_count| is 0.

|ZX_ERR_NOT_SUPPORTED|: The provided |mode| is not supported, or invalid.

void ReadConfig8 (::fuchsia_hardware_pci::wire::DeviceReadConfig8Request * request, ReadConfig8Completer::Sync & completer)

Reads a byte from the device's configuration space. |Offset| must be

within [0x0, 0xFF] if PCI, or [0x0, 0xFFF) if PCIe. In most cases a

device will be PCIe.

Parameters:

|offset|: The offset into the device's configuration space to read.

Errors:

|ZX_ERR_OUT_OF_RANGE|: |offset| is an invalid address.

void ReadConfig16 (::fuchsia_hardware_pci::wire::DeviceReadConfig16Request * request, ReadConfig16Completer::Sync & completer)

Reads two bytes from the device's configuration space. |Offset| must be

within [0x0, 0xFE] if PCI, or [0x0, 0xFFE] if PCIe. In most cases a

device will be PCIe.

Parameters:

|offset|: The offset into the device's configuration space to read.

Errors:

|ZX_ERR_OUT_OF_RANGE|: |offset| is an invalid address.

void ReadConfig32 (::fuchsia_hardware_pci::wire::DeviceReadConfig32Request * request, ReadConfig32Completer::Sync & completer)

Reads four bytes from the device's configuration space. |Offset| must be

within [0x0, 0xFC] if PCI, or [0x0, 0xFFC] if PCIe. In most cases a

device will be PCIe.

Parameters:

|offset|: The offset into the device's configuration space to read.

Errors:

|ZX_ERR_OUT_OF_RANGE|: |offset| is an invalid address.

void WireServer ()

Defined at line 5298 of file fidling/gen/sdk/fidl/fuchsia.hardware.pci/fuchsia.hardware.pci/cpp/fidl/fuchsia.hardware.pci/cpp/wire_messaging.h

void WriteConfig8 (::fuchsia_hardware_pci::wire::DeviceWriteConfig8Request * request, WriteConfig8Completer::Sync & completer)

Writes a byte to the device's configuration space. The acceptable

ranges of |offset| for writes are [0x40, 0xFF] if PCI, or [0x40,

0xFFF] if PCIe. For most purposes a device will be PCIe.

Parameters

|offset|: The offset into the device's configuration space to read.

|value|: The value to write.

Errors:

|ZX_ERR_ACCESS_DENIED|: |offset| is within the device's configuration header.

|ZX_ERR_OUT_OF_RANGE|: |offset| is an invalid address.

void WriteConfig16 (::fuchsia_hardware_pci::wire::DeviceWriteConfig16Request * request, WriteConfig16Completer::Sync & completer)

Writes two bytes to the device's configuration space. The acceptable

ranges of |offset| for writes are [0x40, 0xFE] if PCI, or [0x40,

0xFFE] if PCIe. For most purposes a device will be PCIe.

Parameters

|offset|: The offset into the device's configuration space to read.

|value|: The value to write.

Errors:

|ZX_ERR_ACCESS_DENIED|: |offset| is within the device's configuration header.

|ZX_ERR_OUT_OF_RANGE|: |offset| is an invalid address.

void WriteConfig32 (::fuchsia_hardware_pci::wire::DeviceWriteConfig32Request * request, WriteConfig32Completer::Sync & completer)

Writes four bytes to the device's configuration space. The acceptable

ranges of |offset| for writes are [0x40, 0xFC] if PCI, or [0x40,

0xFFC] if PCIe. For most purposes a device will be PCIe.

Parameters

|offset|: The offset into the device's configuration space to read.

|value|: The value to write.

Errors:

|ZX_ERR_ACCESS_DENIED|: |offset| is within the device's configuration header.

|ZX_ERR_OUT_OF_RANGE|: |offset| is an invalid address.

void GetCapabilities (::fuchsia_hardware_pci::wire::DeviceGetCapabilitiesRequest * request, GetCapabilitiesCompleter::Sync & completer)

Returns a vector of offsets in configuration space corresponding to

capabilities matching the provided capability |id|. If no corresponding

match is found then the vector will be empty.

Parameters:

|id|: the capability id to search for.

void GetExtendedCapabilities (::fuchsia_hardware_pci::wire::DeviceGetExtendedCapabilitiesRequest * request, GetExtendedCapabilitiesCompleter::Sync & completer)

Returns a vector of offsets in configuration space corresponding to

extended capabilities matching the provided extended capability |id|.

If no corresponding match is found then the vector will be empty.

Parameters:

|id|: the capability id to search for

void GetBti (::fuchsia_hardware_pci::wire::DeviceGetBtiRequest * request, GetBtiCompleter::Sync & completer)

Returns the Bus Transaction Intiator (BTI) at a given index for the device.

Parameters:

|index|: the BTI to request.

Errors:

|ZX_ERR_OUT_OF_RANGE|: |index| was not 0.

Handler bind_handler (async_dispatcher_t * dispatcher)

|bind_handler| returns a handler that binds incoming connections to this

server implementation.

The returned handler borrows the server instance.

The server must outlive the provided |dispatcher|. Only after

the dispatcher is shutdown will it be safe to destroy the servers.

The server should not be moved.

void ~WireServer ()

Defined at line 5299 of file fidling/gen/sdk/fidl/fuchsia.hardware.pci/fuchsia.hardware.pci/cpp/fidl/fuchsia.hardware.pci/cpp/wire_messaging.h