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
  33 struct pci_device_mapping;
  34
  35 int pci_fill_capabilities_generic( struct pci_device * dev );
  36 int pci_device_generic_unmap_range(struct pci_device *dev,
  37     struct pci_device_mapping *map);
  38
  39 struct pci_system_methods {
  40     void (*destroy)( void );
  41     void (*destroy_device)( struct pci_device * dev );
  42     int (*read_rom)( struct pci_device * dev, void * buffer );
  43     int (*probe)( struct pci_device * dev );
  44     int (*map_range)(struct pci_device *dev, struct pci_device_mapping *map);
  45     int (*unmap_range)(struct pci_device * dev,
  46                        struct pci_device_mapping *map);
  47
  48     int (*read)(struct pci_device * dev, void * data, pciaddr_t offset,
  49                 pciaddr_t size, pciaddr_t * bytes_read );
  50
  51     int (*write)(struct pci_device * dev, const void * data, pciaddr_t offset,
  52                 pciaddr_t size, pciaddr_t * bytes_written );
  53
  54     int (*fill_capabilities)( struct pci_device * dev );
  55 };
  56
  57 struct pci_device_mapping {
  58     pciaddr_t base;
  59     pciaddr_t size;
  60     unsigned region;
  61     unsigned flags;
  62     void *memory;
  63 };
  64
  65 struct pci_device_private {
  66     struct pci_device  base;
  67     const char * device_string;
  68
  69     uint8_t header_type;
  70
  71     /**
  72      * \name PCI Capabilities
  73      */
  74     /*@{*/
  75     const struct pci_agp_info * agp;   /**< AGP capability information. */
  76     /*@}*/
  77
  78     /**
  79      * Base address of the device's expansion ROM.
  80      */
  81     pciaddr_t rom_base;
  82
  83     /**
  84      * \name Bridge information.
  85      */
  86     /*@{*/
  87     union {
  88         struct pci_bridge_info * pci;
  89         struct pci_pcmcia_bridge_info * pcmcia;
  90     } bridge;
  91     /*@}*/
  92
  93     /**
  94      * \name Mappings active on this device.
  95      */
  96     /*@{*/
  97     struct pci_device_mapping *mappings;
  98     unsigned num_mappings;
  99     /*@}*/
 100 };
 101
 102
 103 /**
 104  * Base type for tracking PCI subsystem information.
 105  */
 106 struct pci_system {
 107     /**
 108      * Platform dependent implementations of specific API routines.
 109      */
 110     const struct pci_system_methods * methods;
 111
 112     /**
 113      * Number of known devices in the system.
 114      */
 115     size_t num_devices;
 116
 117     /**
 118      * Array of known devices.
 119      */
 120     struct pci_device_private * devices;
 121
 122 #ifdef HAVE_MTRR
 123     int mtrr_fd;
 124 #endif
 125 };
 126
 127 extern struct pci_system * pci_sys;
 128
 129 extern int pci_system_linux_sysfs_create( void );
 130 extern int pci_system_freebsd_create( void );