Palacios Public Git Repository

To checkout Palacios execute

  git clone http://v3vee.org/palacios/palacios.web/palacios.git
This will give you the master branch. You probably want the devel branch or one of the release branches. To switch to the devel branch, simply execute
  cd palacios
  git checkout --track -b devel origin/devel
The other branches are similar.


Merge branch 'Release-1.2' of ssh://palacios@newskysaw.cs.northwestern.edu//home...
[palacios.git] / palacios / include / devices / pci.h
1 /* 
2  * This file is part of the Palacios Virtual Machine Monitor developed
3  * by the V3VEE Project with funding from the United States National 
4  * Science Foundation and the Department of Energy.  
5  *
6  * The V3VEE Project is a joint project between Northwestern University
7  * and the University of New Mexico.  You can find out more at 
8  * http://www.v3vee.org
9  *
10  * Copyright (c) 2009, Lei Xia <lxia@northwestern.edu>
11  * Copyright (c) 2009, Chang Seok Bae <jhuell@gmail.com>
12  * Copyright (c) 2009, The V3VEE Project <http://www.v3vee.org> 
13  * All rights reserved.
14  *
15  * Author:  Lei Xia <lxia@northwestern.edu>
16  *             Chang Seok Bae <jhuell@gmail.com>
17  *
18  * This is free software.  You are permitted to use,
19  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
20  */
21
22 #ifndef __DEVICES_PCI_H__
23 #define __DEVICES_PCI_H__
24
25 #ifdef __V3VEE__
26
27
28 #include <palacios/vmm_types.h>
29 #include <palacios/vmm_rbtree.h>
30
31 #include <devices/pci_types.h>
32
33 struct vm_device;
34
35
36 typedef enum { PCI_BAR_IO, 
37                PCI_BAR_MEM24, 
38                PCI_BAR_MEM32, 
39                PCI_BAR_MEM64_LOW, 
40                PCI_BAR_MEM64_HIGH, 
41                PCI_BAR_PASSTHROUGH,
42                PCI_BAR_NONE } pci_bar_type_t;
43
44 typedef enum {PCI_STD_DEVICE, PCI_TO_PCI_BRIDGE, PCI_CARDBUS, PCI_MULTIFUNCTION, PCI_PASSTHROUGH} pci_device_type_t;
45
46
47
48 // For the rest of the subclass codes see:
49 // http://www.acm.uiuc.edu/sigops/roll_your_own/7.c.1.html
50
51 #define PCI_AUTO_DEV_NUM (-1)
52
53 struct pci_device;
54
55 struct v3_pci_bar {
56     pci_bar_type_t type;
57     
58     union {
59         struct {
60             int num_pages;
61             addr_t default_base_addr;
62             int (*mem_read)(addr_t guest_addr, void * dst, uint_t length, void * private_data);
63             int (*mem_write)(addr_t guest_addr, void * src, uint_t length, void * private_data);
64         };
65
66         struct {
67             int num_ports;
68             uint16_t default_base_port;
69             int (*io_read)(ushort_t port, void * dst, uint_t length, void * private_data);
70             int (*io_write)(ushort_t port, void * src, uint_t length, void * private_data);
71         };
72         
73         struct {
74             int (*bar_init)(int bar_num, uint32_t * dst,void * private_data);
75             int (*bar_write)(int bar_num, uint32_t * src, void * private_data);
76         };
77     };
78     
79     void * private_data;
80
81     // Internal PCI data
82     uint32_t val;
83     int updated;
84     uint32_t mask;
85 };
86
87
88 #define PCI_IO_MASK 0xfffffffc
89 #define PCI_MEM_MASK 0xfffffff0
90 #define PCI_MEM24_MASK 0x000ffff0
91
92 #define PCI_IO_BASE(bar_val) (bar_val & PCI_IO_MASK)
93 #define PCI_MEM32_BASE(bar_val) (bar_val & PCI_MEM_MASK)
94 #define PCI_MEM24_BASE(bar_val) (bar_val & PCI_MEM24_MASK)
95
96 struct pci_device {
97
98     pci_device_type_t type;
99
100     union {
101         uint8_t config_space[256];
102
103         struct {
104             struct pci_config_header config_header;
105             uint8_t config_data[192];
106         } __attribute__((packed));
107     } __attribute__((packed));
108
109     struct v3_pci_bar bar[6];
110
111     struct rb_node dev_tree_node;
112
113     uint_t bus_num;
114
115     union {
116         uint8_t devfn;
117         struct {
118             uint8_t fn_num       : 3;
119             uint8_t dev_num      : 5;
120         } __attribute__((packed));
121     } __attribute__((packed));
122
123     char name[64];
124
125     int (*config_update)(uint_t reg_num, void * src, uint_t length, void * priv_data);
126
127     int (*cmd_update)(struct pci_device * pci_dev, uchar_t io_enabled, uchar_t mem_enabled);
128     int (*ext_rom_update)(struct pci_device * pci_dev);
129
130     int (*config_write)(uint_t reg_num, void * src, uint_t length, void * private_data);
131     int (*config_read)(uint_t reg_num, void * dst, uint_t length, void * private_data);
132
133
134     int ext_rom_update_flag;
135     int bar_update_flag;
136
137     void * priv_data;
138 };
139
140
141 int v3_pci_set_irq_bridge(struct vm_device * pci_bus, int bus_num,
142                           int (*raise_pci_irq)(struct vm_device * dev, struct pci_device * pci_dev), 
143                           int (*lower_pci_irq)(struct vm_device * dev, struct pci_device * pci_dev), 
144                           struct vm_device * bridge_dev);
145
146
147 int v3_pci_raise_irq(struct vm_device * pci_bus, int bus_num, struct pci_device * dev);
148 int v3_pci_lower_irq(struct vm_device * pci_bus, int bus_num, struct pci_device * dev);
149
150 struct pci_device * 
151 v3_pci_register_device(struct vm_device * pci,
152                        pci_device_type_t dev_type, 
153                        int bus_num,
154                        int dev_num,
155                        int fn_num,
156                        const char * name,
157                        struct v3_pci_bar * bars,
158                        int (*config_update)(uint_t reg_num, void * src, uint_t length, void * private_data),
159                        int (*cmd_update)(struct pci_device *pci_dev, uchar_t io_enabled, uchar_t mem_enabled),
160                        int (*ext_rom_update)(struct pci_device *pci_dev),
161                        void * priv_data);
162
163
164 struct pci_device * 
165 v3_pci_register_passthrough_device(struct vm_device * pci,
166                                    int bus_num,
167                                    int dev_num,
168                                    int fn_num,
169                                    const char * name,
170                                    int (*config_write)(uint_t reg_num, void * src, uint_t length, void * private_data),
171                                    int (*config_read)(uint_t reg_num, void * dst, uint_t length, void * private_data),
172                                    void * private_data);
173
174
175 #endif
176
177 #endif
178