lib/pci.h

   1 /*
   2  *      The PCI Library
   3  *
   4  *      Copyright (c) 1997--2020 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 0x030700
  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 init.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_SYLIXOS_DEVICE,            /* SylixOS pci */
  45   PCI_ACCESS_HURD,                      /* GNU/Hurd */
  46   PCI_ACCESS_MAX
  47 };
  48
  49 struct pci_access {
  50   /* Options you can change: */
  51   unsigned int method;                  /* Access method */
  52   int writeable;                        /* Open in read/write mode */
  53   int buscentric;                       /* Bus-centric view of the world */
  54
  55   char *id_file_name;                   /* Name of ID list file (use pci_set_name_list_path()) */
  56   int free_id_name;                     /* Set if id_file_name is malloced */
  57   int numeric_ids;                      /* Enforce PCI_LOOKUP_NUMERIC (>1 => PCI_LOOKUP_MIXED) */
  58
  59   unsigned int id_lookup_mode;          /* pci_lookup_mode flags which are set automatically */
  60                                         /* Default: PCI_LOOKUP_CACHE */
  61
  62   int debugging;                        /* Turn on debugging messages */
  63
  64   /* Functions you can override: */
  65   void (*error)(char *msg, ...) PCI_PRINTF(1,2) PCI_NONRET;     /* Write error message and quit */
  66   void (*warning)(char *msg, ...) PCI_PRINTF(1,2);      /* Write a warning message */
  67   void (*debug)(char *msg, ...) PCI_PRINTF(1,2);        /* Write a debugging message */
  68
  69   struct pci_dev *devices;              /* Devices found on this bus */
  70
  71   /* Fields used internally: */
  72   struct pci_methods *methods;
  73   struct pci_param *params;
  74   struct id_entry **id_hash;            /* names.c */
  75   struct id_bucket *current_id_bucket;
  76   int id_load_failed;
  77   int id_cache_status;                  /* 0=not read, 1=read, 2=dirty */
  78   struct udev *id_udev;                 /* names-hwdb.c */
  79   struct udev_hwdb *id_udev_hwdb;
  80   int fd;                               /* proc/sys: fd for config space */
  81   int fd_rw;                            /* proc/sys: fd opened read-write */
  82   int fd_pos;                           /* proc/sys: current position */
  83   int fd_vpd;                           /* sys: fd for VPD */
  84   struct pci_dev *cached_dev;           /* proc/sys: device the fds are for */
  85 };
  86
  87 /* Initialize PCI access */
  88 struct pci_access *pci_alloc(void) PCI_ABI;
  89 void pci_init(struct pci_access *) PCI_ABI;
  90 void pci_cleanup(struct pci_access *) PCI_ABI;
  91
  92 /* Scanning of devices */
  93 void pci_scan_bus(struct pci_access *acc) PCI_ABI;
  94 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 */
  95 void pci_free_dev(struct pci_dev *) PCI_ABI;
  96
  97 /* Names of access methods */
  98 int pci_lookup_method(char *name) PCI_ABI;      /* Returns -1 if not found */
  99 char *pci_get_method_name(int index) PCI_ABI;   /* Returns "" if unavailable, NULL if index out of range */
 100
 101 /*
 102  *      Named parameters
 103  */
 104
 105 struct pci_param {
 106   struct pci_param *next;               /* Please use pci_walk_params() for traversing the list */
 107   char *param;                          /* Name of the parameter */
 108   char *value;                          /* Value of the parameter */
 109   int value_malloced;                   /* used internally */
 110   char *help;                           /* Explanation of the parameter */
 111 };
 112
 113 char *pci_get_param(struct pci_access *acc, char *param) PCI_ABI;
 114 int pci_set_param(struct pci_access *acc, char *param, char *value) PCI_ABI;    /* 0 on success, -1 if no such parameter */
 115 /* To traverse the list, call pci_walk_params repeatedly, first with prev=NULL, and do not modify the parameters during traversal. */
 116 struct pci_param *pci_walk_params(struct pci_access *acc, struct pci_param *prev) PCI_ABI;
 117
 118 /*
 119  *      Devices
 120  */
 121
 122 struct pci_dev {
 123   struct pci_dev *next;                 /* Next device in the chain */
 124   u16 domain_16;                        /* 16-bit version of the PCI domain for backward compatibility */
 125                                         /* 0xffff if the real domain doesn't fit in 16 bits */
 126   u8 bus, dev, func;                    /* Bus inside domain, device and function */
 127
 128   /* These fields are set by pci_fill_info() */
 129   unsigned int known_fields;            /* Set of info fields already known (see pci_fill_info()) */
 130   u16 vendor_id, device_id;             /* Identity of the device */
 131   u16 device_class;                     /* PCI device class */
 132   int irq;                              /* IRQ number */
 133   pciaddr_t base_addr[6];               /* Base addresses including flags in lower bits */
 134   pciaddr_t size[6];                    /* Region sizes */
 135   pciaddr_t rom_base_addr;              /* Expansion ROM base address */
 136   pciaddr_t rom_size;                   /* Expansion ROM size */
 137   struct pci_cap *first_cap;            /* List of capabilities */
 138   char *phy_slot;                       /* Physical slot */
 139   char *module_alias;                   /* Linux kernel module alias */
 140   char *label;                          /* Device name as exported by BIOS */
 141   int numa_node;                        /* NUMA node */
 142   pciaddr_t flags[6];                   /* PCI_IORESOURCE_* flags for regions */
 143   pciaddr_t rom_flags;                  /* PCI_IORESOURCE_* flags for expansion ROM */
 144   int domain;                           /* PCI domain (host bridge) */
 145
 146   /* Fields used internally */
 147   struct pci_access *access;
 148   struct pci_methods *methods;
 149   u8 *cache;                            /* Cached config registers */
 150   int cache_len;
 151   int hdrtype;                          /* Cached low 7 bits of header type, -1 if unknown */
 152   void *aux;                            /* Auxiliary data for use by the back-end */
 153   struct pci_property *properties;      /* A linked list of extra properties */
 154   struct pci_cap *last_cap;             /* Last capability in the list */
 155 };
 156
 157 #define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
 158 #define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
 159 #define PCI_ADDR_FLAG_MASK 0xf
 160
 161 u8 pci_read_byte(struct pci_dev *, int pos) PCI_ABI; /* Access to configuration space */
 162 u16 pci_read_word(struct pci_dev *, int pos) PCI_ABI;
 163 u32 pci_read_long(struct pci_dev *, int pos) PCI_ABI;
 164 int pci_read_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI;
 165 int pci_read_vpd(struct pci_dev *d, int pos, u8 *buf, int len) PCI_ABI;
 166 int pci_write_byte(struct pci_dev *, int pos, u8 data) PCI_ABI;
 167 int pci_write_word(struct pci_dev *, int pos, u16 data) PCI_ABI;
 168 int pci_write_long(struct pci_dev *, int pos, u32 data) PCI_ABI;
 169 int pci_write_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI;
 170
 171 /*
 172  * Most device properties take some effort to obtain, so libpci does not
 173  * initialize them during default bus scan. Instead, you have to call
 174  * pci_fill_info() with the proper PCI_FILL_xxx constants OR'ed together.
 175  *
 176  * Some properties are stored directly in the pci_dev structure.
 177  * The remaining ones can be accessed through pci_get_string_property().
 178  *
 179  * pci_fill_info() returns the current value of pci_dev->known_fields.
 180  * This is a bit mask of all fields, which were already obtained during
 181  * the lifetime of the device. This includes fields which are not supported
 182  * by the particular device -- in that case, the field is left at its default
 183  * value, which is 0 for integer fields and NULL for pointers. On the other
 184  * hand, we never consider known fields unsupported by the current back-end;
 185  * such fields always contain the default value.
 186  *
 187  * XXX: flags and the result should be unsigned, but we do not want to break the ABI.
 188  */
 189
 190 int pci_fill_info(struct pci_dev *, int flags) PCI_ABI;
 191 char *pci_get_string_property(struct pci_dev *d, u32 prop) PCI_ABI;
 192
 193 #define PCI_FILL_IDENT          0x0001
 194 #define PCI_FILL_IRQ            0x0002
 195 #define PCI_FILL_BASES          0x0004
 196 #define PCI_FILL_ROM_BASE       0x0008
 197 #define PCI_FILL_SIZES          0x0010
 198 #define PCI_FILL_CLASS          0x0020
 199 #define PCI_FILL_CAPS           0x0040
 200 #define PCI_FILL_EXT_CAPS       0x0080
 201 #define PCI_FILL_PHYS_SLOT      0x0100
 202 #define PCI_FILL_MODULE_ALIAS   0x0200
 203 #define PCI_FILL_LABEL          0x0400
 204 #define PCI_FILL_NUMA_NODE      0x0800
 205 #define PCI_FILL_IO_FLAGS       0x1000
 206 #define PCI_FILL_DT_NODE        0x2000          /* Device tree node */
 207 #define PCI_FILL_IOMMU_GROUP    0x4000
 208 #define PCI_FILL_RESCAN         0x00010000
 209
 210 void pci_setup_cache(struct pci_dev *, u8 *cache, int len) PCI_ABI;
 211
 212 /*
 213  *      Capabilities
 214  */
 215
 216 struct pci_cap {
 217   struct pci_cap *next;
 218   u16 id;                               /* PCI_CAP_ID_xxx */
 219   u16 type;                             /* PCI_CAP_xxx */
 220   unsigned int addr;                    /* Position in the config space */
 221 };
 222
 223 #define PCI_CAP_NORMAL          1       /* Traditional PCI capabilities */
 224 #define PCI_CAP_EXTENDED        2       /* PCIe extended capabilities */
 225
 226 struct pci_cap *pci_find_cap(struct pci_dev *, unsigned int id, unsigned int type) PCI_ABI;
 227 struct pci_cap *pci_find_cap_nr(struct pci_dev *, unsigned int id, unsigned int type,
 228                                 unsigned int *cap_number) PCI_ABI;
 229
 230 /*
 231  *      Filters
 232  */
 233
 234 struct pci_filter {
 235   int domain, bus, slot, func;                  /* -1 = ANY */
 236   int vendor, device, device_class;
 237   int rfu[3];
 238 };
 239
 240 void pci_filter_init(struct pci_access *, struct pci_filter *) PCI_ABI;
 241 char *pci_filter_parse_slot(struct pci_filter *, char *) PCI_ABI;
 242 char *pci_filter_parse_id(struct pci_filter *, char *) PCI_ABI;
 243 int pci_filter_match(struct pci_filter *, struct pci_dev *) PCI_ABI;
 244
 245 /*
 246  *      Conversion of PCI ID's to names (according to the pci.ids file)
 247  *
 248  *      Call pci_lookup_name() to identify different types of ID's:
 249  *
 250  *      VENDOR                          (vendorID) -> vendor
 251  *      DEVICE                          (vendorID, deviceID) -> device
 252  *      VENDOR | DEVICE                 (vendorID, deviceID) -> combined vendor and device
 253  *      SUBSYSTEM | VENDOR              (subvendorID) -> subsystem vendor
 254  *      SUBSYSTEM | DEVICE              (vendorID, deviceID, subvendorID, subdevID) -> subsystem device
 255  *      SUBSYSTEM | VENDOR | DEVICE     (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
 256  *      SUBSYSTEM | ...                 (-1, -1, subvendorID, subdevID) -> generic subsystem
 257  *      CLASS                           (classID) -> class
 258  *      PROGIF                          (classID, progif) -> programming interface
 259  */
 260
 261 char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags, ...) PCI_ABI;
 262
 263 int pci_load_name_list(struct pci_access *a) PCI_ABI;   /* Called automatically by pci_lookup_*() when needed; returns success */
 264 void pci_free_name_list(struct pci_access *a) PCI_ABI;  /* Called automatically by pci_cleanup() */
 265 void pci_set_name_list_path(struct pci_access *a, char *name, int to_be_freed) PCI_ABI;
 266 void pci_id_cache_flush(struct pci_access *a) PCI_ABI;
 267
 268 enum pci_lookup_mode {
 269   PCI_LOOKUP_VENDOR = 1,                /* Vendor name (args: vendorID) */
 270   PCI_LOOKUP_DEVICE = 2,                /* Device name (args: vendorID, deviceID) */
 271   PCI_LOOKUP_CLASS = 4,                 /* Device class (args: classID) */
 272   PCI_LOOKUP_SUBSYSTEM = 8,
 273   PCI_LOOKUP_PROGIF = 16,               /* Programming interface (args: classID, prog_if) */
 274   PCI_LOOKUP_NUMERIC = 0x10000,         /* Want only formatted numbers; default if access->numeric_ids is set */
 275   PCI_LOOKUP_NO_NUMBERS = 0x20000,      /* Return NULL if not found in the database; default is to print numerically */
 276   PCI_LOOKUP_MIXED = 0x40000,           /* Include both numbers and names */
 277   PCI_LOOKUP_NETWORK = 0x80000,         /* Try to resolve unknown ID's by DNS */
 278   PCI_LOOKUP_SKIP_LOCAL = 0x100000,     /* Do not consult local database */
 279   PCI_LOOKUP_CACHE = 0x200000,          /* Consult the local cache before using DNS */
 280   PCI_LOOKUP_REFRESH_CACHE = 0x400000,  /* Forget all previously cached entries, but still allow updating the cache */
 281   PCI_LOOKUP_NO_HWDB = 0x800000,        /* Do not ask udev's hwdb */
 282 };
 283
 284 #endif