Initial import of libpciaccess.
[platform/upstream/libpciaccess.git] / 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 int pci_fill_capabilities_generic( struct pci_device * dev );
34
35 struct pci_system_methods {
36     void (*destroy)( void );
37     void (*destroy_device)( struct pci_device * dev );
38     int (*read_rom)( struct pci_device * dev, void * buffer );    
39     int (*probe)( struct pci_device * dev );
40     int (*map)( struct pci_device * dev, unsigned region, int write_enable );
41     int (*unmap)( struct pci_device * dev, unsigned region );
42     
43     int (*read)(struct pci_device * dev, void * data, pciaddr_t offset,
44                 pciaddr_t size, pciaddr_t * bytes_read );
45
46     int (*write)(struct pci_device * dev, const void * data, pciaddr_t offset,
47                 pciaddr_t size, pciaddr_t * bytes_written );
48
49     int (*fill_capabilities)( struct pci_device * dev );
50 };
51
52 struct pci_device_private {
53     struct pci_device  base;
54     const char * device_string;
55     
56     /**
57      * \name PCI Capabilities
58      */
59     /*@{*/
60     const struct pci_agp_info * agp;   /**< AGP capability information. */
61     /*@}*/
62 };
63
64
65 /**
66  * Base type for tracking PCI subsystem information.
67  */
68 struct pci_system {
69     /**
70      * Platform dependent implementations of specific API routines.
71      */
72     const struct pci_system_methods * methods;
73
74     /**
75      * Number of known devices in the system.
76      */
77     size_t num_devices;
78
79     /**
80      * Array of known devices.
81      */
82     struct pci_device_private * devices;
83 };
84
85 extern struct pci_system * pci_sys;