pcieutil

Documentation

Overview

Package pcieutil contains utilities to read from and write to registers of a PCIe device.

Index

• type PCIeMemMap
  • func NewPCIeMemMap(resourceFile string) (*PCIeMemMap, error)
  • func (pcie *PCIeMemMap) Close() error
  • func (pcie *PCIeMemMap) ReadAt(offset uint32) (uint32, error)
  • func (pcie *PCIeMemMap) WriteAt(offset, data uint32) error

Types

type PCIeMemMap

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

func NewPCIeMemMap

func NewPCIeMemMap(resourceFile string) (*PCIeMemMap, error)

NewPCIeMemMap creates a memory map for the PCIe device represented by the provided resource file.

func (*PCIeMemMap) Close

func (pcie *PCIeMemMap) Close() error

Close unmaps the memory for the PCIe device, and cleans up.

func (*PCIeMemMap) ReadAt

func (pcie *PCIeMemMap) ReadAt(offset uint32) (uint32, error)

ReadAt reads from the PCIe device register at the provided offset (should be word-aligned).

func (*PCIeMemMap) WriteAt

func (pcie *PCIeMemMap) WriteAt(offset, data uint32) error

WriteAt writes to the PCIe device register at the provided offset (should be word-aligned).