lib/pci.h

   1 /*
   2  *      The PCI Library
   3  *
   4  *      Copyright (c) 1997--2003 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
  15 /*
  16  *      Types and format strings
  17  */
  18
  19 #include <sys/types.h>
  20
  21 typedef u_int8_t byte;
  22 typedef u_int8_t u8;
  23 typedef u_int16_t word;
  24 typedef u_int16_t u16;
  25 typedef u_int32_t u32;
  26
  27 #ifdef HAVE_64BIT_ADDRESS
  28 #include <limits.h>
  29 #if ULONG_MAX > 0xffffffff
  30 typedef unsigned long u64;
  31 #define PCIADDR_T_FMT "%016lx"
  32 #define PCIADDR_PORT_FMT "%04lx"
  33 #else
  34 typedef unsigned long long u64;
  35 #define PCIADDR_T_FMT "%016Lx"
  36 #define PCIADDR_PORT_FMT "%04Lx"
  37 #endif
  38 typedef u64 pciaddr_t;
  39 #else
  40 typedef u32 pciaddr_t;
  41 #define PCIADDR_T_FMT "%08x"
  42 #define PCIADDR_PORT_FMT "%04x"
  43 #endif
  44
  45 #ifdef ARCH_SPARC64
  46 /* On sparc64 Linux the kernel reports remapped port addresses and IRQ numbers */
  47 #undef PCIADDR_PORT_FMT
  48 #define PCIADDR_PORT_FMT PCIADDR_T_FMT
  49 #define PCIIRQ_FMT "%08x"
  50 #else
  51 #define PCIIRQ_FMT "%d"
  52 #endif
  53
  54 /*
  55  *      PCI Access Structure
  56  */
  57
  58 struct pci_methods;
  59 struct nl_entry;
  60
  61 enum pci_access_type {
  62   /* Known access methods, remember to update access.c as well */
  63   PCI_ACCESS_AUTO,                      /* Autodetection (params: none) */
  64   PCI_ACCESS_PROC_BUS_PCI,              /* Linux /proc/bus/pci (params: path) */
  65   PCI_ACCESS_I386_TYPE1,                /* i386 ports, type 1 (params: none) */
  66   PCI_ACCESS_I386_TYPE2,                /* i386 ports, type 2 (params: none) */
  67   PCI_ACCESS_FBSD_DEVICE,               /* FreeBSD /dev/pci (params: path) */
  68   PCI_ACCESS_AIX_DEVICE,                /* /dev/pci0, /dev/bus0, etc. */
  69   PCI_ACCESS_NBSD_LIBPCI,               /* NetBSD libpci */
  70   PCI_ACCESS_DUMP,                      /* Dump file (params: filename) */
  71   PCI_ACCESS_MAX
  72 };
  73
  74 struct pci_access {
  75   /* Options you can change: */
  76   unsigned int method;                  /* Access method */
  77   char *method_params[PCI_ACCESS_MAX];  /* Parameters for the methods */
  78   int writeable;                        /* Open in read/write mode */
  79   int buscentric;                       /* Bus-centric view of the world */
  80   char *id_file_name;                   /* Name of ID list file */
  81   int numeric_ids;                      /* Don't resolve device IDs to names */
  82   int debugging;                        /* Turn on debugging messages */
  83
  84   /* Functions you can override: */
  85   void (*error)(char *msg, ...);        /* Write error message and quit */
  86   void (*warning)(char *msg, ...);      /* Write a warning message */
  87   void (*debug)(char *msg, ...);        /* Write a debugging message */
  88
  89   struct pci_dev *devices;              /* Devices found on this bus */
  90
  91   /* Fields used internally: */
  92   struct pci_methods *methods;
  93   char *nl_list;                        /* Name list cache */
  94   struct nl_entry **nl_hash;
  95   int fd;                               /* proc: fd */
  96   int fd_rw;                            /* proc: fd opened read-write */
  97   struct pci_dev *cached_dev;           /* proc: device the fd is for */
  98   int fd_pos;                           /* proc: current position */
  99 };
 100
 101 /* Initialize PCI access */
 102 struct pci_access *pci_alloc(void);
 103 void pci_init(struct pci_access *);
 104 void pci_cleanup(struct pci_access *);
 105
 106 /* Scanning of devices */
 107 void pci_scan_bus(struct pci_access *acc);
 108 struct pci_dev *pci_get_dev(struct pci_access *acc, int bus, int dev, int func); /* Raw access to specified device */
 109 void pci_free_dev(struct pci_dev *);
 110
 111 /*
 112  *      Devices
 113  */
 114
 115 struct pci_dev {
 116   struct pci_dev *next;                 /* Next device in the chain */
 117   word bus;                             /* Higher byte can select host bridges */
 118   byte dev, func;                       /* Device and function */
 119
 120   /* These fields are set by pci_fill_info() */
 121   int known_fields;                     /* Set of info fields already known */
 122   word vendor_id, device_id;            /* Identity of the device */
 123   int irq;                              /* IRQ number */
 124   pciaddr_t base_addr[6];               /* Base addresses */
 125   pciaddr_t size[6];                    /* Region sizes */
 126   pciaddr_t rom_base_addr;              /* Expansion ROM base address */
 127   pciaddr_t rom_size;                   /* Expansion ROM size */
 128
 129   /* Fields used internally: */
 130   struct pci_access *access;
 131   struct pci_methods *methods;
 132   byte *cache;                          /* Cached information */
 133   int cache_len;
 134   int hdrtype;                          /* Direct methods: header type */
 135   void *aux;                            /* Auxillary data */
 136 };
 137
 138 #define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
 139 #define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
 140
 141 byte pci_read_byte(struct pci_dev *, int pos); /* Access to configuration space */
 142 word pci_read_word(struct pci_dev *, int pos);
 143 u32  pci_read_long(struct pci_dev *, int pos);
 144 int pci_read_block(struct pci_dev *, int pos, byte *buf, int len);
 145 int pci_write_byte(struct pci_dev *, int pos, byte data);
 146 int pci_write_word(struct pci_dev *, int pos, word data);
 147 int pci_write_long(struct pci_dev *, int pos, u32 data);
 148 int pci_write_block(struct pci_dev *, int pos, byte *buf, int len);
 149
 150 int pci_fill_info(struct pci_dev *, int flags); /* Fill in device information */
 151
 152 #define PCI_FILL_IDENT          1
 153 #define PCI_FILL_IRQ            2
 154 #define PCI_FILL_BASES          4
 155 #define PCI_FILL_ROM_BASE       8
 156 #define PCI_FILL_SIZES          16
 157 #define PCI_FILL_RESCAN         0x10000
 158
 159 void pci_setup_cache(struct pci_dev *, byte *cache, int len);
 160
 161 /*
 162  *      Filters
 163  */
 164
 165 struct pci_filter {
 166   int bus, slot, func;                  /* -1 = ANY */
 167   int vendor, device;
 168 };
 169
 170 void pci_filter_init(struct pci_access *, struct pci_filter *);
 171 char *pci_filter_parse_slot(struct pci_filter *, char *);
 172 char *pci_filter_parse_id(struct pci_filter *, char *);
 173 int pci_filter_match(struct pci_filter *, struct pci_dev *);
 174
 175 /*
 176  *      Device names
 177  */
 178
 179 char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags, u32 arg1, u32 arg2, u32 arg3, u32 arg4);
 180 void pci_free_name_list(struct pci_access *a);
 181
 182 #define PCI_LOOKUP_VENDOR 1
 183 #define PCI_LOOKUP_DEVICE 2
 184 #define PCI_LOOKUP_CLASS 4
 185 #define PCI_LOOKUP_SUBSYSTEM 8
 186 #define PCI_LOOKUP_PROGIF 16
 187 #define PCI_LOOKUP_NUMERIC 0x10000
 188
 189 #endif