pci

Documentation

Index

• func Lookup(ids map[string]Vendor, vendor string, device string) (string, string)
• type BusReader
  • func NewBusReader(globs ...string) (BusReader, error)
• type Device
• type Devices
  • func (d Devices) ReadConfig() error
  • func (d Devices) ReadConfigRegister(offset, size int64) ([]uint64, error)
  • func (d Devices) SetVendorDeviceName()
  • func (d Devices) String() string
  • func (d Devices) WriteConfigRegister(offset, size int64, val uint64) error
• type Filter
• type PCI
  • func (p *PCI) ReadConfig() error
  • func (p *PCI) ReadConfigRegister(offset, size int64) (uint64, error)
  • func (p *PCI) SetVendorDeviceName()
  • func (p *PCI) String() string
  • func (p *PCI) WriteConfigRegister(offset, size int64, val uint64) error
• type Vendor

Functions

func Lookup

func Lookup(ids map[string]Vendor, vendor string, device string) (string, string)

Lookup takes PCI hex (as strings) vendor and device ID values and returns human readable labels for both the vendor and device. Returns the input ID value if if label is not found in the ids map.

Types

type BusReader

type BusReader interface {
	// Read returns Devices, possibly filter by a provided ...Filter
	Read(...Filter) (Devices, error)
}

BusReader is the interface for reading device names for a given bus.

func NewBusReader

func NewBusReader(globs ...string) (BusReader, error)

NewBusReader returns a BusReader, given a ...glob to match PCI devices against. If it can't glob in pciPath/g then it returns an error. For convenience, we use * as the glob if none are supplied. We don't provide an option to do type I or PCIe MMIO config stuff.

type Device

type Device string

Device is a PCI device human readable label

type Devices

type Devices []*PCI

Devices contains a slice of one or more PCI devices

func (Devices) ReadConfig

func (d Devices) ReadConfig() error

ReadConfig reads the config info for all the devices.

func (Devices) ReadConfigRegister

func (d Devices) ReadConfigRegister(offset, size int64) ([]uint64, error)

ReadConfigRegister reads the config info for all the devices.

func (Devices) SetVendorDeviceName

func (d Devices) SetVendorDeviceName()

SetVendorDeviceName sets all numeric IDs of all the devices using the pci device SetVendorDeviceName.

func (Devices) String

func (d Devices) String() string

String stringifies the PCI devices. Currently it just calls the device String().

func (Devices) WriteConfigRegister

func (d Devices) WriteConfigRegister(offset, size int64, val uint64) error

WriteConfigRegister writes the config info for all the devices.

type Filter

type Filter func(p *PCI) bool

Filter can be used to filter a device

type PCI

type PCI struct {
	Addr       string
	Vendor     string `pci:"vendor"`
	Device     string `pci:"device"`
	VendorName string
	DeviceName string
	FullPath   string
	ExtraInfo  []string
}

PCI is a PCI device. We will fill this in as we add options. For now it just holds two uint16 per the PCI spec.

func (*PCI) ReadConfig

func (p *PCI) ReadConfig() error

ReadConfig reads the config space and adds it to ExtraInfo as a hexdump.

func (*PCI) ReadConfigRegister

func (p *PCI) ReadConfigRegister(offset, size int64) (uint64, error)

ReadConfigRegister reads a configuration register of size 8, 16, 32, or 64. It will only work on little-endian machines.

func (*PCI) SetVendorDeviceName

func (p *PCI) SetVendorDeviceName()

SetVendorDeviceName changes VendorName and DeviceName from a name to a number, if possible.

func (*PCI) String

func (p *PCI) String() string

String concatenates PCI address, Vendor, and Device and other information to make a useful display for the user.

func (*PCI) WriteConfigRegister

func (p *PCI) WriteConfigRegister(offset, size int64, val uint64) error

WriteConfigRegister writes a configuration register of size 8, 16, 32, or 64. It will only work on little-endian machines.

type Vendor

type Vendor struct {
	Name    string
	Devices map[string]Device
}

Vendor is a PCI vendor human readable label. It contains a map of one or more Devices keyed by hex ID.