lib/pci.h

   1 /*
   2  *      $Id: pci.h,v 1.5 1999/07/20 12:13:40 mj Exp $
   3  *
   4  *      The PCI Library
   5  *
   6  *      Copyright (c) 1997--1999 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
   7  *
   8  *      Can be freely distributed and used under the terms of the GNU GPL.
   9  */
  10
  11 #ifndef _PCI_LIB_H
  12 #define _PCI_LIB_H
  13
  14 #include "config.h"
  15
  16 #ifdef HAVE_OWN_HEADER_H
  17 #include "header.h"
  18 #else
  19 #include <linux/pci.h>
  20 #endif
  21
  22 /*
  23  *      Types
  24  */
  25
  26 #include <linux/types.h>
  27
  28 typedef __u8 byte;
  29 typedef __u8 u8;
  30 typedef __u16 word;
  31 typedef __u16 u16;
  32 typedef __u32 u32;
  33
  34 #ifdef HAVE_LONG_ADDRESS
  35 typedef unsigned long long pciaddr_t;
  36 #else
  37 typedef unsigned long pciaddr_t;
  38 #endif
  39
  40 /*
  41  *      PCI Access Structure
  42  */
  43
  44 struct pci_methods;
  45 struct nl_entry;
  46
  47 #define PCI_ACCESS_AUTO                 0       /* Autodetection (params: none) */
  48 #define PCI_ACCESS_PROC_BUS_PCI         1       /* Linux /proc/bus/pci (params: path) */
  49 #define PCI_ACCESS_SYSCALLS             2       /* pciconfig_read() syscalls (params: none) */
  50 #define PCI_ACCESS_I386_TYPE1           3       /* i386 ports, type 1 (params: none) */
  51 #define PCI_ACCESS_I386_TYPE2           4       /* i386 ports, type 2 (params: none) */
  52 #define PCI_ACCESS_DUMP                 5       /* Dump file (params: filename) */
  53 #define PCI_ACCESS_MAX                  6
  54
  55 struct pci_access {
  56   /* Options you can change: */
  57   unsigned int method;                  /* Access method */
  58   char *method_params[PCI_ACCESS_MAX];  /* Parameters for the methods */
  59   int writeable;                        /* Open in read/write mode */
  60   int buscentric;                       /* Bus-centric view of the world */
  61   char *id_file_name;                   /* Name of ID list file */
  62   int numeric_ids;                      /* Don't resolve device IDs to names */
  63   int debugging;                        /* Turn on debugging messages */
  64
  65   /* Functions you can override: */
  66   void (*error)(char *msg, ...);        /* Write error message and quit */
  67   void (*warning)(char *msg, ...);      /* Write a warning message */
  68   void (*debug)(char *msg, ...);        /* Write a debugging message */
  69
  70   struct pci_dev *devices;              /* Devices found on this bus */
  71
  72   /* Fields used internally: */
  73   struct pci_methods *methods;
  74   char *nl_list;                        /* Name list cache */
  75   struct nl_entry **nl_hash;
  76   int fd;                               /* proc: fd */
  77   int fd_rw;                            /* proc: fd opened read-write */
  78   struct pci_dev *cached_dev;           /* proc: device the fd is for */
  79   int fd_pos;                           /* proc: current position */
  80 };
  81
  82 /* Initialize PCI access */
  83 struct pci_access *pci_alloc(void);
  84 void pci_init(struct pci_access *);
  85 void pci_cleanup(struct pci_access *);
  86
  87 /* Scanning of devices */
  88 void pci_scan_bus(struct pci_access *acc);
  89 struct pci_dev *pci_get_dev(struct pci_access *acc, int bus, int dev, int func); /* Raw access to specified device */
  90 void pci_free_dev(struct pci_dev *);
  91
  92 /*
  93  *      Devices
  94  */
  95
  96 struct pci_dev {
  97   struct pci_dev *next;                 /* Next device in the chain */
  98   word bus;                             /* Higher byte can select host bridges */
  99   byte dev, func;                       /* Device and function */
 100
 101   /* These fields are set by pci_fill_info() */
 102   int known_fields;                     /* Set of info fields already known */
 103   word vendor_id, device_id;            /* Identity of the device */
 104   int irq;                              /* IRQ number */
 105   pciaddr_t base_addr[6];               /* Base addresses */
 106   pciaddr_t size[6];                    /* Region sizes */
 107   pciaddr_t rom_base_addr;              /* Expansion ROM base address */
 108   pciaddr_t rom_size;                   /* Expansion ROM size */
 109
 110   /* Fields used internally: */
 111   struct pci_access *access;
 112   struct pci_methods *methods;
 113   byte *cache;                          /* Cached information */
 114   int cache_len;
 115   int hdrtype;                          /* Direct methods: header type */
 116   void *aux;                            /* Auxillary data */
 117 };
 118
 119 #define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
 120 #define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
 121
 122 byte pci_read_byte(struct pci_dev *, int pos); /* Access to configuration space */
 123 word pci_read_word(struct pci_dev *, int pos);
 124 u32  pci_read_long(struct pci_dev *, int pos);
 125 int pci_read_block(struct pci_dev *, int pos, byte *buf, int len);
 126 int pci_write_byte(struct pci_dev *, int pos, byte data);
 127 int pci_write_word(struct pci_dev *, int pos, word data);
 128 int pci_write_long(struct pci_dev *, int pos, u32 data);
 129 int pci_write_block(struct pci_dev *, int pos, byte *buf, int len);
 130
 131 int pci_fill_info(struct pci_dev *, int flags); /* Fill in device information */
 132
 133 #define PCI_FILL_IDENT          1
 134 #define PCI_FILL_IRQ            2
 135 #define PCI_FILL_BASES          4
 136 #define PCI_FILL_ROM_BASE       8
 137 #define PCI_FILL_SIZES          16
 138 #define PCI_FILL_RESCAN         0x10000
 139
 140 void pci_setup_cache(struct pci_dev *, byte *cache, int len);
 141
 142 /*
 143  *      Filters
 144  */
 145
 146 struct pci_filter {
 147   int bus, slot, func;                  /* -1 = ANY */
 148   int vendor, device;
 149 };
 150
 151 void pci_filter_init(struct pci_access *, struct pci_filter *);
 152 char *pci_filter_parse_slot(struct pci_filter *, char *);
 153 char *pci_filter_parse_id(struct pci_filter *, char *);
 154 int pci_filter_match(struct pci_filter *, struct pci_dev *);
 155
 156 /*
 157  *      Device names
 158  */
 159
 160 char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags, u32 arg1, u32 arg2);
 161 void pci_free_name_list(struct pci_access *a);
 162
 163 #define PCI_LOOKUP_VENDOR 1
 164 #define PCI_LOOKUP_DEVICE 2
 165 #define PCI_LOOKUP_CLASS 4
 166 #define PCI_LOOKUP_SUBSYSTEM 8
 167 #define PCI_LOOKUP_NUMERIC 0x10000
 168
 169 #endif