PCI driver/hardware development tool

Purpose

The exploreApp support is intended as a tool to explore new PCI devices. This may be useful when preparing to write a dedicated driver and/or during development of PCI/PCIe device firmware. exploreApp allows a PCI register to be read and/or written an EPICS record. For example:

record(longout, "pcitestout") {
  field(DTYP, "Explore Write32 LSB")
  field(OUT , "@8:0.0 bar=0 offset=0xc")
}

The record pcitestout will be connected to the PCI device 8:0.0 (bus 8, device 0, function 0) with the first BAR. A single write of 4 bytes is made when the record is processed.

The following can be added to some xyzApp/src/Makefile to include exploreApp.

PROD_IOC += myioc
DBD += myioc.dbd
myioc_DBD += exploreSupport.dbd
myioc_LIBS += explorepci epicspci

Options

INP/OUT link strings may contain the following components

• "bar=#" (default: 0)
• "offset=#" in bytes (default: 0)
• "mask=#" bit mask (default: 0 aka. no mask)
• "shift=#" in bits (default: 0)
• "step=#" in bytes (default: read size. eg Read32 defaults to step=4)
• "initread=1|0" bool (default: 1 for .OUT recordtypes, 0 otherwise)

For record types: longout, bo, mbbo, mbboDirect, ao allowed DTYP are:

• Explore Write8
• Explore Write16 NAT
• Explore Write16 LSB
• Explore Write16 MSB
• Explore Write32 NAT
• Explore Write32 LSB
• Explore Write32 MSB

For record types: longin, longout, bi, bo, mbbi, mbbo, mbbiDirect, mbboDirect, ai, ao

• Explore Read8
• Explore Read16 NAT
• Explore Read16 LSB
• Explore Read16 MSB
• Explore Read32 NAT
• Explore Read32 LSB
• Explore Read32 MSB

The ao record type also accepts

• Explore WriteF32 LSB
• Explore WriteF32 MSB

The ai record type also accepts

• Explore ReadF32 LSB
• Explore ReadF32 MSB

The waveform record type accepts both integer Read and Write DTYP. The step= link option may be applied to change how the address counter is incremented. The default step size is the read size (eg. 4 for Read32). A step size of 0 will read the base address NELM times.

PCI Interrupt

Limited support of PCI interrupts is available on Linux only. A longin record with DTYP="Explore IRQ Count" and SCAN="I/O Intr" will be processed each time an interrupt occurs.

This requires that a UIO kernel module be installed.

FRIB Specific

The DTYP="Explore FRIB Flash" support implements a FRIB specific protocol for accessing a SPI flash chip over PCI. The frib-flash.db file demonstrates use.