idsdb

Documentation

Index

• type Class
• type DB
  • func Load() (*DB, error)
  • func (db *DB) FindClass(hexnum string) (*Class, bool)
  • func (db *DB) FindProduct(hexvendor, hexdevice string) (*Product, bool)
  • func (db *DB) FindVendor(hexvendor string) (*Vendor, bool)
• type Dir
  • func (d Dir) Open(name string) (fs.File, error)
• type Product
• type ProgrammingInterface
• type Store
• type Subclass
• type Vendor

Types

type Class

type Class struct {
	// hex-encoded PCI_ID for the device class
	ID string `json:"id"`
	// common string name for the class
	Name string `json:"name"`
	// any subclasses belonging to this class
	Subclasses []*Subclass `json:"subclasses"`
}

Class is the PCI class

type DB

type DB struct {
	// hash of class ID -> class information
	Classes map[string]*Class `json:"classes"`
	// hash of vendor ID -> vendor information
	Vendors map[string]*Vendor `json:"vendors"`
	// hash of vendor ID + product/device ID -> product information
	Products map[string]*Product `json:"products"`
}

func Load

func Load() (*DB, error)

func (*DB) FindClass

func (db *DB) FindClass(hexnum string) (*Class, bool)

func (*DB) FindProduct

func (db *DB) FindProduct(hexvendor, hexdevice string) (*Product, bool)

func (*DB) FindVendor

func (db *DB) FindVendor(hexvendor string) (*Vendor, bool)

type Dir

type Dir string

func (Dir) Open

func (d Dir) Open(name string) (fs.File, error)

type Product

type Product struct {
	// vendor ID for the product
	VendorID string `json:"vendor_id"`
	// hex-encoded PCI_ID for the product/model
	ID string `json:"id"`
	// common string name of the vendor
	Name string `json:"name"`
	// "subdevices" or "subsystems" for the product
	Subsystems []*Product `json:"subsystems"`
}

Product provides information about a PCI device model

type ProgrammingInterface

type ProgrammingInterface struct {
	// hex-encoded PCI_ID of the programming interface
	ID string `json:"id"`
	// common string name for the programming interface
	Name string `json:"name"`
}

ProgrammingInterface is the PCI programming interface for a class of PCI devices

type Store

type Store interface {
	Open(string) (fs.File, error)
}

type Subclass

type Subclass struct {
	// hex-encoded PCI_ID for the device subclass
	ID string `json:"id"`
	// common string name for the subclass
	Name string `json:"name"`
	// any programming interfaces this subclass might have
	ProgrammingInterfaces []*ProgrammingInterface `json:"programming_interfaces"`
}

Subclass is a subdivision of a PCI class

type Vendor

type Vendor struct {
	// hex-encoded PCI_ID for the vendor
	ID string `json:"id"`
	// common string name of the vendor
	Name string `json:"name"`
	// all top-level devices for the vendor
	Products []*Product `json:"products"`
}

Vendor provides information about a device vendor