lib/pci.h

   1 /*
   2  *      The PCI Library
   3  *
   4  *      Copyright (c) 1997--2013 Martin Mares <mj@ucw.cz>
   5  *
   6  *      Can be freely distributed and used under the terms of the GNU GPL.
   7  */
   8
   9 #ifndef _PCI_LIB_H
  10 #define _PCI_LIB_H
  11
  12 #ifndef PCI_CONFIG_H
  13 #include "config.h"
  14 #endif
  15
  16 #include "header.h"
  17 #include "types.h"
  18
  19 #define PCI_LIB_VERSION 0x030200
  20
  21 #ifndef PCI_ABI
  22 #define PCI_ABI
  23 #endif
  24
  25 /*
  26  *      PCI Access Structure
  27  */
  28
  29 struct pci_methods;
  30
  31 enum pci_access_type {
  32   /* Known access methods, remember to update access.c as well */
  33   PCI_ACCESS_AUTO,                      /* Autodetection */
  34   PCI_ACCESS_SYS_BUS_PCI,               /* Linux /sys/bus/pci */
  35   PCI_ACCESS_PROC_BUS_PCI,              /* Linux /proc/bus/pci */
  36   PCI_ACCESS_I386_TYPE1,                /* i386 ports, type 1 */
  37   PCI_ACCESS_I386_TYPE2,                /* i386 ports, type 2 */
  38   PCI_ACCESS_FBSD_DEVICE,               /* FreeBSD /dev/pci */
  39   PCI_ACCESS_AIX_DEVICE,                /* /dev/pci0, /dev/bus0, etc. */
  40   PCI_ACCESS_NBSD_LIBPCI,               /* NetBSD libpci */
  41   PCI_ACCESS_OBSD_DEVICE,               /* OpenBSD /dev/pci */
  42   PCI_ACCESS_DUMP,                          /* Dump file */
  43   PCI_ACCESS_DARWIN,                    /* Darwin */
  44   PCI_ACCESS_MAX
  45 };
  46
  47 struct pci_access {
  48   /* Options you can change: */
  49   unsigned int method;                  /* Access method */
  50   int writeable;                        /* Open in read/write mode */
  51   int buscentric;                       /* Bus-centric view of the world */
  52
  53   char *id_file_name;                   /* Name of ID list file (use pci_set_name_list_path()) */
  54   int free_id_name;                     /* Set if id_file_name is malloced */
  55   int numeric_ids;                      /* Enforce PCI_LOOKUP_NUMERIC (>1 => PCI_LOOKUP_MIXED) */
  56
  57   unsigned int id_lookup_mode;          /* pci_lookup_mode flags which are set automatically */
  58                                         /* Default: PCI_LOOKUP_CACHE */
  59
  60   int debugging;                        /* Turn on debugging messages */
  61
  62   /* Functions you can override: */
  63   void (*error)(char *msg, ...) PCI_PRINTF(1,2);        /* Write error message and quit */
  64   void (*warning)(char *msg, ...) PCI_PRINTF(1,2);      /* Write a warning message */
  65   void (*debug)(char *msg, ...) PCI_PRINTF(1,2);        /* Write a debugging message */
  66
  67   struct pci_dev *devices;              /* Devices found on this bus */
  68
  69   /* Fields used internally: */
  70   struct pci_methods *methods;
  71   struct pci_param *params;
  72   struct id_entry **id_hash;            /* names.c */
  73   struct id_bucket *current_id_bucket;
  74   int id_load_failed;
  75   int id_cache_status;                  /* 0=not read, 1=read, 2=dirty */
  76   int fd;                               /* proc/sys: fd for config space */
  77   int fd_rw;                            /* proc/sys: fd opened read-write */
  78   int fd_pos;                           /* proc/sys: current position */
  79   int fd_vpd;                           /* sys: fd for VPD */
  80   struct pci_dev *cached_dev;           /* proc/sys: device the fds are for */
  81 };
  82
  83 /* Initialize PCI access */
  84 struct pci_access *pci_alloc(void) PCI_ABI;
  85 void pci_init(struct pci_access *) PCI_ABI;
  86 void pci_cleanup(struct pci_access *) PCI_ABI;
  87
  88 /* Scanning of devices */
  89 void pci_scan_bus(struct pci_access *acc) PCI_ABI;
  90 struct pci_dev *pci_get_dev(struct pci_access *acc, int domain, int bus, int dev, int func) PCI_ABI; /* Raw access to specified device */
  91 void pci_free_dev(struct pci_dev *) PCI_ABI;
  92
  93 /* Names of access methods */
  94 int pci_lookup_method(char *name) PCI_ABI;      /* Returns -1 if not found */
  95 char *pci_get_method_name(int index) PCI_ABI;   /* Returns "" if unavailable, NULL if index out of range */
  96
  97 /*
  98  *      Named parameters
  99  */
 100
 101 struct pci_param {
 102   struct pci_param *next;               /* Please use pci_walk_params() for traversing the list */
 103   char *param;                          /* Name of the parameter */
 104   char *value;                          /* Value of the parameter */
 105   int value_malloced;                   /* used internally */
 106   char *help;                           /* Explanation of the parameter */
 107 };
 108
 109 char *pci_get_param(struct pci_access *acc, char *param) PCI_ABI;
 110 int pci_set_param(struct pci_access *acc, char *param, char *value) PCI_ABI;    /* 0 on success, -1 if no such parameter */
 111 /* To traverse the list, call pci_walk_params repeatedly, first with prev=NULL, and do not modify the parameters during traversal. */
 112 struct pci_param *pci_walk_params(struct pci_access *acc, struct pci_param *prev) PCI_ABI;
 113
 114 /*
 115  *      Devices
 116  */
 117
 118 struct pci_dev {
 119   struct pci_dev *next;                 /* Next device in the chain */
 120   u16 domain;                           /* PCI domain (host bridge) */
 121   u8 bus, dev, func;                    /* Bus inside domain, device and function */
 122
 123   /* These fields are set by pci_fill_info() */
 124   int known_fields;                     /* Set of info fields already known */
 125   u16 vendor_id, device_id;             /* Identity of the device */
 126   u16 device_class;                     /* PCI device class */
 127   int irq;                              /* IRQ number */
 128   pciaddr_t base_addr[6];               /* Base addresses including flags in lower bits */
 129   pciaddr_t size[6];                    /* Region sizes */
 130   pciaddr_t rom_base_addr;              /* Expansion ROM base address */
 131   pciaddr_t rom_size;                   /* Expansion ROM size */
 132   struct pci_cap *first_cap;            /* List of capabilities */
 133   char *phy_slot;                       /* Physical slot */
 134   char *module_alias;                   /* Linux kernel module alias */
 135   char *label;                          /* Device name as exported by BIOS */
 136
 137   /* Fields used internally: */
 138   struct pci_access *access;
 139   struct pci_methods *methods;
 140   u8 *cache;                            /* Cached config registers */
 141   int cache_len;
 142   int hdrtype;                          /* Cached low 7 bits of header type, -1 if unknown */
 143   void *aux;                            /* Auxillary data */
 144 };
 145
 146 #define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
 147 #define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
 148 #define PCI_ADDR_FLAG_MASK 0xf
 149
 150 u8 pci_read_byte(struct pci_dev *, int pos) PCI_ABI; /* Access to configuration space */
 151 u16 pci_read_word(struct pci_dev *, int pos) PCI_ABI;
 152 u32 pci_read_long(struct pci_dev *, int pos) PCI_ABI;
 153 int pci_read_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI;
 154 int pci_read_vpd(struct pci_dev *d, int pos, u8 *buf, int len) PCI_ABI;
 155 int pci_write_byte(struct pci_dev *, int pos, u8 data) PCI_ABI;
 156 int pci_write_word(struct pci_dev *, int pos, u16 data) PCI_ABI;
 157 int pci_write_long(struct pci_dev *, int pos, u32 data) PCI_ABI;
 158 int pci_write_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI;
 159
 160 int pci_fill_info(struct pci_dev *, int flags) PCI_ABI; /* Fill in device information */
 161
 162 #define PCI_FILL_IDENT          1
 163 #define PCI_FILL_IRQ            2
 164 #define PCI_FILL_BASES          4
 165 #define PCI_FILL_ROM_BASE       8
 166 #define PCI_FILL_SIZES          16
 167 #define PCI_FILL_CLASS          32
 168 #define PCI_FILL_CAPS           64
 169 #define PCI_FILL_EXT_CAPS       128
 170 #define PCI_FILL_PHYS_SLOT      256
 171 #define PCI_FILL_MODULE_ALIAS   512
 172 #define PCI_FILL_LABEL          1024
 173 #define PCI_FILL_RESCAN         0x10000
 174
 175 void pci_setup_cache(struct pci_dev *, u8 *cache, int len) PCI_ABI;
 176
 177 /*
 178  *      Capabilities
 179  */
 180
 181 struct pci_cap {
 182   struct pci_cap *next;
 183   u16 id;                               /* PCI_CAP_ID_xxx */
 184   u16 type;                             /* PCI_CAP_xxx */
 185   unsigned int addr;                    /* Position in the config space */
 186 };
 187
 188 #define PCI_CAP_NORMAL          1       /* Traditional PCI capabilities */
 189 #define PCI_CAP_EXTENDED        2       /* PCIe extended capabilities */
 190
 191 struct pci_cap *pci_find_cap(struct pci_dev *, unsigned int id, unsigned int type) PCI_ABI;
 192
 193 /*
 194  *      Filters
 195  */
 196
 197 struct pci_filter {
 198   int domain, bus, slot, func;                  /* -1 = ANY */
 199   int vendor, device;
 200 };
 201
 202 void pci_filter_init(struct pci_access *, struct pci_filter *) PCI_ABI;
 203 char *pci_filter_parse_slot(struct pci_filter *, char *) PCI_ABI;
 204 char *pci_filter_parse_id(struct pci_filter *, char *) PCI_ABI;
 205 int pci_filter_match(struct pci_filter *, struct pci_dev *) PCI_ABI;
 206
 207 /*
 208  *      Conversion of PCI ID's to names (according to the pci.ids file)
 209  *
 210  *      Call pci_lookup_name() to identify different types of ID's:
 211  *
 212  *      VENDOR                          (vendorID) -> vendor
 213  *      DEVICE                          (vendorID, deviceID) -> device
 214  *      VENDOR | DEVICE                 (vendorID, deviceID) -> combined vendor and device
 215  *      SUBSYSTEM | VENDOR              (subvendorID) -> subsystem vendor
 216  *      SUBSYSTEM | DEVICE              (vendorID, deviceID, subvendorID, subdevID) -> subsystem device
 217  *      SUBSYSTEM | VENDOR | DEVICE     (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
 218  *      SUBSYSTEM | ...                 (-1, -1, subvendorID, subdevID) -> generic subsystem
 219  *      CLASS                           (classID) -> class
 220  *      PROGIF                          (classID, progif) -> programming interface
 221  */
 222
 223 char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags, ...) PCI_ABI;
 224
 225 int pci_load_name_list(struct pci_access *a) PCI_ABI;   /* Called automatically by pci_lookup_*() when needed; returns success */
 226 void pci_free_name_list(struct pci_access *a) PCI_ABI;  /* Called automatically by pci_cleanup() */
 227 void pci_set_name_list_path(struct pci_access *a, char *name, int to_be_freed) PCI_ABI;
 228 void pci_id_cache_flush(struct pci_access *a) PCI_ABI;
 229
 230 enum pci_lookup_mode {
 231   PCI_LOOKUP_VENDOR = 1,                /* Vendor name (args: vendorID) */
 232   PCI_LOOKUP_DEVICE = 2,                /* Device name (args: vendorID, deviceID) */
 233   PCI_LOOKUP_CLASS = 4,                 /* Device class (args: classID) */
 234   PCI_LOOKUP_SUBSYSTEM = 8,
 235   PCI_LOOKUP_PROGIF = 16,               /* Programming interface (args: classID, prog_if) */
 236   PCI_LOOKUP_NUMERIC = 0x10000,         /* Want only formatted numbers; default if access->numeric_ids is set */
 237   PCI_LOOKUP_NO_NUMBERS = 0x20000,      /* Return NULL if not found in the database; default is to print numerically */
 238   PCI_LOOKUP_MIXED = 0x40000,           /* Include both numbers and names */
 239   PCI_LOOKUP_NETWORK = 0x80000,         /* Try to resolve unknown ID's by DNS */
 240   PCI_LOOKUP_SKIP_LOCAL = 0x100000,     /* Do not consult local database */
 241   PCI_LOOKUP_CACHE = 0x200000,          /* Consult the local cache before using DNS */
 242   PCI_LOOKUP_REFRESH_CACHE = 0x400000,  /* Forget all previously cached entries, but still allow updating the cache */
 243 };
 244
 245 #endif