pcie

Documentation

Overview

Package pcie provides a Connector and establishes a PCIe connection.

Index

• type Connector
  • func NewConnector() *Connector
  • func (c *Connector) AddSwitch(baseSwitchID int) (switchID int)
  • func (c *Connector) CreateNetwork()
  • func (c *Connector) CreateRootComplex(cpuPorts []akita.Port) (switchID int)
  • func (c *Connector) PlugInDevice(baseSwitchID int, devicePorts []akita.Port)
  • func (c *Connector) WithEngine(engine akita.Engine) *Connector
  • func (c *Connector) WithNetworkName(name string) *Connector
  • func (c *Connector) WithSwitchLatency(numCycles int) *Connector
  • func (c *Connector) WithVersion3() *Connector
  • func (c *Connector) WithVersion4() *Connector
  • func (c *Connector) WithX1() *Connector
  • func (c *Connector) WithX16() *Connector
  • func (c *Connector) WithX2() *Connector
  • func (c *Connector) WithX4() *Connector
  • func (c *Connector) WithX8() *Connector

Types

type Connector

type Connector struct {
	// contains filtered or unexported fields
}

Connector can connect devices into a PCIe network.

func NewConnector

func NewConnector() *Connector

NewConnector creates a new connector that can help configure PCIe networks.

func (*Connector) AddSwitch

func (c *Connector) AddSwitch(baseSwitchID int) (switchID int)

AddSwitch adds a new switch connecting from an existing switch.

func (*Connector) CreateNetwork

func (c *Connector) CreateNetwork()

CreateNetwork creates a network. This function should be called before creating root complexes.

func (*Connector) CreateRootComplex

func (c *Connector) CreateRootComplex(cpuPorts []akita.Port) (switchID int)

CreateRootComplex creates a root complex of the PCIe connection. It requires a set of port that connects to the CPU in the system.

func (*Connector) PlugInDevice

func (c *Connector) PlugInDevice(baseSwitchID int, devicePorts []akita.Port)

PlugInDevice connects a series of ports to a switch.

func (*Connector) WithEngine

func (c *Connector) WithEngine(engine akita.Engine) *Connector

WithEngine sets the event-driven simulation engine that the PCIe connection uses.

func (*Connector) WithNetworkName

func (c *Connector) WithNetworkName(name string) *Connector

WithNetworkName sets the name of the network and the prefix of all the component in the network.

func (*Connector) WithSwitchLatency

func (c *Connector) WithSwitchLatency(numCycles int) *Connector

func (*Connector) WithVersion3

func (c *Connector) WithVersion3() *Connector

WithVersion3 defines the PCIe connection to use the PCIe-v3 standard.

func (*Connector) WithVersion4

func (c *Connector) WithVersion4() *Connector

WithVersion4 defines the PCIe connection to use the PCIe-v4 standard.

func (*Connector) WithX1

func (c *Connector) WithX1() *Connector

WithX1 sets PCIe connection to a X1 PCIe connection.

func (*Connector) WithX16

func (c *Connector) WithX16() *Connector

WithX16 sets PCIe connection to a X1 PCIe connection.

func (*Connector) WithX2

func (c *Connector) WithX2() *Connector

WithX2 sets PCIe connection to a X1 PCIe connection.

func (*Connector) WithX4

func (c *Connector) WithX4() *Connector

WithX4 sets PCIe connection to a X1 PCIe connection.

func (*Connector) WithX8

func (c *Connector) WithX8() *Connector

WithX8 sets PCIe connection to a X1 PCIe connection.