src/pciaccess_private.h

   1 /*
   2  * (C) Copyright IBM Corporation 2006
   3  * All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * on the rights to use, copy, modify, merge, publish, distribute, sub
   9  * license, and/or sell copies of the Software, and to permit persons to whom
  10  * the Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the next
  13  * paragraph) shall be included in all copies or substantial portions of the
  14  * Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.  IN NO EVENT SHALL
  19  * IBM AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 /**
  26  * \file pciaccess_private.h
  27  * Functions and datastructures that are private to the pciaccess library.
  28  *
  29  * \author Ian Romanick <idr@us.ibm.com>
  30  */
  31
  32 #if defined(__GNUC__) && (__GNUC__ >= 4)
  33 # define _pci_hidden      __attribute__((visibility("hidden")))
  34 #elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x550)
  35 # define _pci_hidden      __hidden
  36 #else /* not gcc >= 4 and not Sun Studio >= 8 */
  37 # define _pci_hidden
  38 #endif /* GNUC >= 4 */
  39
  40 /*
  41  * O_CLOEXEC fixes an fd leak case (see 'man 2 open' for details). I don't
  42  * know of any OS we support where this isn't available in a sufficiently
  43  * new version, so warn unconditionally.
  44  */
  45 #include <sys/fcntl.h>
  46
  47 #ifndef O_CLOEXEC
  48 #warning O_CLOEXEC not available, please upgrade.
  49 #define O_CLOEXEC 0
  50 #endif
  51
  52
  53 struct pci_device_mapping;
  54
  55 int pci_fill_capabilities_generic( struct pci_device * dev );
  56 int pci_device_generic_unmap_range(struct pci_device *dev,
  57     struct pci_device_mapping *map);
  58
  59 struct pci_system_methods {
  60     void (*destroy)( void );
  61     void (*destroy_device)( struct pci_device * dev );
  62     int (*read_rom)( struct pci_device * dev, void * buffer );
  63     int (*probe)( struct pci_device * dev );
  64     int (*map_range)(struct pci_device *dev, struct pci_device_mapping *map);
  65     int (*unmap_range)(struct pci_device * dev,
  66                        struct pci_device_mapping *map);
  67
  68     int (*read)(struct pci_device * dev, void * data, pciaddr_t offset,
  69                 pciaddr_t size, pciaddr_t * bytes_read );
  70
  71     int (*write)(struct pci_device * dev, const void * data, pciaddr_t offset,
  72                 pciaddr_t size, pciaddr_t * bytes_written );
  73
  74     int (*fill_capabilities)( struct pci_device * dev );
  75     void (*enable)( struct pci_device *dev );
  76     int (*boot_vga)( struct pci_device *dev );
  77     int (*has_kernel_driver)( struct pci_device *dev );
  78     struct pci_io_handle *(*open_device_io)( struct pci_io_handle *handle,
  79                                              struct pci_device *dev, int bar,
  80                                              pciaddr_t base, pciaddr_t size );
  81     struct pci_io_handle *(*open_legacy_io)( struct pci_io_handle *handle,
  82                                              struct pci_device *dev,
  83                                              pciaddr_t base, pciaddr_t size );
  84     void (*close_io)( struct pci_device *dev, struct pci_io_handle *handle );
  85     uint32_t (*read32)( struct pci_io_handle *handle, uint32_t reg );
  86     uint16_t (*read16)( struct pci_io_handle *handle, uint32_t reg );
  87     uint8_t  (*read8)( struct pci_io_handle *handle, uint32_t reg );
  88     void (*write32)( struct pci_io_handle *handle, uint32_t reg,
  89                      uint32_t data );
  90     void (*write16)( struct pci_io_handle *handle, uint32_t reg,
  91                      uint16_t data );
  92     void (*write8)( struct pci_io_handle *handle, uint32_t reg, uint8_t data );
  93
  94     int (*map_legacy)(struct pci_device *dev, pciaddr_t base, pciaddr_t size,
  95                       unsigned map_flags, void **addr);
  96     int (*unmap_legacy)(struct pci_device *dev, void *addr, pciaddr_t size);
  97 };
  98
  99 struct pci_device_mapping {
 100     pciaddr_t base;
 101     pciaddr_t size;
 102     unsigned region;
 103     unsigned flags;
 104     void *memory;
 105 };
 106
 107 struct pci_io_handle {
 108     pciaddr_t base;
 109     pciaddr_t size;
 110     void *memory;
 111     int fd;
 112     int is_legacy;
 113 };
 114
 115 struct pci_device_private {
 116     struct pci_device  base;
 117     const char * device_string;
 118
 119     uint8_t header_type;
 120
 121     /**
 122      * \name PCI Capabilities
 123      */
 124     /*@{*/
 125     const struct pci_agp_info * agp;   /**< AGP capability information. */
 126     /*@}*/
 127
 128     /**
 129      * Base address of the device's expansion ROM.
 130      */
 131     pciaddr_t rom_base;
 132
 133     /**
 134      * \name Bridge information.
 135      */
 136     /*@{*/
 137     union {
 138         struct pci_bridge_info * pci;
 139         struct pci_pcmcia_bridge_info * pcmcia;
 140     } bridge;
 141     /*@}*/
 142
 143     /**
 144      * \name Mappings active on this device.
 145      */
 146     /*@{*/
 147     struct pci_device_mapping *mappings;
 148     unsigned num_mappings;
 149     /*@}*/
 150 #ifdef __sun
 151     int is_primary;
 152 #endif
 153 };
 154
 155
 156 /**
 157  * Base type for tracking PCI subsystem information.
 158  */
 159 struct pci_system {
 160     /**
 161      * Platform dependent implementations of specific API routines.
 162      */
 163     const struct pci_system_methods * methods;
 164
 165     /**
 166      * Number of known devices in the system.
 167      */
 168     size_t num_devices;
 169
 170     /**
 171      * Array of known devices.
 172      */
 173     struct pci_device_private * devices;
 174
 175 #ifdef HAVE_MTRR
 176     int mtrr_fd;
 177 #endif
 178     int vgaarb_fd;
 179     int vga_count;
 180     struct pci_device *vga_target;
 181     struct pci_device *vga_default_dev;
 182 };
 183
 184 extern struct pci_system * pci_sys;
 185
 186 extern int pci_system_linux_sysfs_create( void );
 187 extern int pci_system_freebsd_create( void );
 188 extern int pci_system_netbsd_create( void );
 189 extern int pci_system_openbsd_create( void );
 190 extern void pci_system_openbsd_init_dev_mem( int );
 191 extern int pci_system_solx_devfs_create( void );
 192 extern int pci_system_x86_create( void );
 193 extern void pci_io_cleanup( void );