devLibPCI.h

Go to the documentation of this file.

/*************************************************************************\
* Copyright (c) 2010 Brookhaven Science Associates, as Operator of
*     Brookhaven National Laboratory.
* devLib2 is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
\*************************************************************************/
/*
 * Author: Michael Davidsaver <mdavidsaver@gmail.com>
 */

#ifndef DEVLIBPCI_H_INC
#define DEVLIBPCI_H_INC 1

#include <dbDefs.h>
#include <epicsTypes.h>
#include <devLib.h>
#include <shareLib.h>

#ifdef __cplusplus
extern "C" {
#endif

#define DEVLIBPCI_MAJOR 1 
#define DEVLIBPCI_MINOR 3 
typedef struct {
    epicsUInt32 device, vendor;
    epicsUInt32 sub_device, sub_vendor;
    epicsUInt32 pci_class;
    epicsUInt16 revision;
} epicsPCIID;

#define DEVPCI_ANY_DEVICE 0x10000
#define DEVPCI_ANY_VENDOR 0x10000
#define DEVPCI_ANY_SUBDEVICE 0x10000
#define DEVPCI_ANY_SUBVENDOR 0x10000
#define DEVPCI_ANY_CLASS 0x1000000
#define DEVPCI_ANY_REVISION 0x100

#define DEVPCI_LAST_DEVICE 0xffff0000

#define DEVPCI_END {DEVPCI_LAST_DEVICE,0,0,0,0,0}

#define DEVPCI_DEVICE_ANY() \
{ DEVPCI_ANY_DEVICE, DEVPCI_ANY_VENDOR, \
    DEVPCI_ANY_SUBDEVICE, DEVPCI_ANY_SUBVENDOR, \
    DEVPCI_ANY_CLASS, DEVPCI_ANY_REVISION }

#define DEVPCI_DEVICE_VENDOR(dev,vend) \
{ dev, vend, DEVPCI_ANY_SUBDEVICE, DEVPCI_ANY_SUBVENDOR, \
    DEVPCI_ANY_CLASS, DEVPCI_ANY_REVISION }

#define DEVPCI_DEVICE_VENDOR_CLASS(dev,vend,pclass) \
{ dev, vend, DEVPCI_ANY_SUBDEVICE, DEVPCI_ANY_SUBVENDOR, \
    pclass, DEVPCI_ANY_REVISION }

#define DEVPCI_SUBDEVICE_SUBVENDOR(dev,vend,sdev,svend) \
{ dev, vend, sdev, svend, \
    DEVPCI_ANY_CLASS, DEVPCI_ANY_REVISION }

#define DEVPCI_SUBDEVICE_SUBVENDOR_CLASS(dev,vend,sdev,svend,revision,pclass) \
{ dev, vend, sdev, svend, \
    pclass, revision }

#define DEVPCI_NO_SLOT NULL

struct PCIBar {
    unsigned int ioport:1; 
    unsigned int addr64:1; 
    unsigned int below1M:1; 
};

typedef struct {
    epicsPCIID   id; 
    unsigned int bus;
    unsigned int device;
    unsigned int function;
    const char* slot;
    struct PCIBar bar[6];
    epicsUInt8 irq;
    unsigned int domain;
    const char* driver;
} epicsPCIDevice;

#define PCIBARCOUNT NELEMENTS( ((epicsPCIDevice*)0)->bar )

typedef int (*devPCISearchFn)(void* ptr,const epicsPCIDevice* dev);

epicsShareFunc
int devPCIFindCB(
        const epicsPCIID *idlist,
        devPCISearchFn searchfn,
        void *arg,
        unsigned int opt /* always 0 */
        );

epicsShareFunc
int devPCIFindSpec(
        const epicsPCIID *idlist,
        const char *spec,
        const epicsPCIDevice **found,
        unsigned int opt /* always 0 */
        );

epicsShareFunc
int devPCIFindDBDF(
        const epicsPCIID *idlist,
        unsigned int      domain,
        unsigned int      b,
        unsigned int      d,
        unsigned int      f,
        const epicsPCIDevice **found,
        unsigned int opt /* always 0 */
        );

epicsShareFunc
int devPCIFindBDF(
        const epicsPCIID *idlist,
        unsigned int      b,
        unsigned int      d,
        unsigned int      f,
        const epicsPCIDevice **found,
        unsigned int opt /* always 0 */
        );

#ifdef __linux__
#define DEVLIB_MAP_UIO1TO1 0
#define DEVLIB_MAP_UIOCOMPACT 1
#else
/* UIO options have no meaning for non-Linux OSs */
#define DEVLIB_MAP_UIO1TO1 0
#define DEVLIB_MAP_UIOCOMPACT 0
#endif

epicsShareFunc
int
devPCIToLocalAddr(
        const epicsPCIDevice *id,
        unsigned int  bar,
        volatile void **ppLocalAddr,
        unsigned int opt /* always 0 */
        );

epicsShareFunc
int
devPCIBarLen(
        const epicsPCIDevice *id,
        unsigned int  bar,
        epicsUInt32 *len
        );

epicsShareFunc
int devPCIConnectInterrupt(
        const epicsPCIDevice *id,
        void (*pFunction)(void *),
        void  *parameter,
        unsigned int opt /* always 0 */
        );

epicsShareFunc
int devPCIDisconnectInterrupt(
        const epicsPCIDevice *id,
        void (*pFunction)(void *),
        void  *parameter
        );

epicsShareFunc
void
devPCIShow(int lvl, int vendor, int device, int exact);

epicsShareFunc
void
devPCIShowMatch(int lvl, const char *spec, int vendor, int device);

epicsShareFunc
void
devPCIShowDevice(int lvl, const epicsPCIDevice *dev);

epicsShareFunc
int
devLibPCIUse(const char* name);

epicsShareFunc
const char* devLibPCIDriverName();

epicsShareExtern int devPCIDebug;

epicsShareFunc
int devPCIConfigRead8(const epicsPCIDevice *dev, unsigned offset, epicsUInt8 *pResult);

epicsShareFunc
int devPCIConfigRead16(const epicsPCIDevice *dev, unsigned offset, epicsUInt16 *pResult);

epicsShareFunc
int devPCIConfigRead32(const epicsPCIDevice *dev, unsigned offset, epicsUInt32 *pResult);

epicsShareFunc
int devPCIConfigWrite8(const epicsPCIDevice *dev, unsigned offset, epicsUInt8 value);

epicsShareFunc
int devPCIConfigWrite16(const epicsPCIDevice *dev, unsigned offset, epicsUInt16 value);

epicsShareFunc
int devPCIConfigWrite32(const epicsPCIDevice *dev, unsigned offset, epicsUInt32 value);

epicsShareFunc
int devPCIEnableInterrupt(const epicsPCIDevice *dev);

epicsShareFunc
int devPCIDisableInterrupt(const epicsPCIDevice *dev);

epicsShareFunc
const char* devPCIDeviceClassToString(int classId);

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* DEVLIBPCI_H_INC */