lib/pci.h

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