qemu/pci: add routines to manage PCI capabilities
[qemu] / hw / pci.h
1 #ifndef QEMU_PCI_H
2 #define QEMU_PCI_H
3
4 #include "qemu-common.h"
5
6 #include "qdev.h"
7
8 /* PCI includes legacy ISA access.  */
9 #include "isa.h"
10
11 /* PCI bus */
12
13 extern target_phys_addr_t pci_mem_base;
14
15 #define PCI_DEVFN(slot, func)   ((((slot) & 0x1f) << 3) | ((func) & 0x07))
16 #define PCI_SLOT(devfn)         (((devfn) >> 3) & 0x1f)
17 #define PCI_FUNC(devfn)         ((devfn) & 0x07)
18
19 /* Class, Vendor and Device IDs from Linux's pci_ids.h */
20 #include "pci_ids.h"
21
22 /* QEMU-specific Vendor and Device ID definitions */
23
24 /* IBM (0x1014) */
25 #define PCI_DEVICE_ID_IBM_440GX          0x027f
26 #define PCI_DEVICE_ID_IBM_OPENPIC2       0xffff
27
28 /* Hitachi (0x1054) */
29 #define PCI_VENDOR_ID_HITACHI            0x1054
30 #define PCI_DEVICE_ID_HITACHI_SH7751R    0x350e
31
32 /* Apple (0x106b) */
33 #define PCI_DEVICE_ID_APPLE_343S1201     0x0010
34 #define PCI_DEVICE_ID_APPLE_UNI_N_I_PCI  0x001e
35 #define PCI_DEVICE_ID_APPLE_UNI_N_PCI    0x001f
36 #define PCI_DEVICE_ID_APPLE_UNI_N_KEYL   0x0022
37 #define PCI_DEVICE_ID_APPLE_IPID_USB     0x003f
38
39 /* Realtek (0x10ec) */
40 #define PCI_DEVICE_ID_REALTEK_8029       0x8029
41
42 /* Xilinx (0x10ee) */
43 #define PCI_DEVICE_ID_XILINX_XC2VP30     0x0300
44
45 /* Marvell (0x11ab) */
46 #define PCI_DEVICE_ID_MARVELL_GT6412X    0x4620
47
48 /* QEMU/Bochs VGA (0x1234) */
49 #define PCI_VENDOR_ID_QEMU               0x1234
50 #define PCI_DEVICE_ID_QEMU_VGA           0x1111
51
52 /* VMWare (0x15ad) */
53 #define PCI_VENDOR_ID_VMWARE             0x15ad
54 #define PCI_DEVICE_ID_VMWARE_SVGA2       0x0405
55 #define PCI_DEVICE_ID_VMWARE_SVGA        0x0710
56 #define PCI_DEVICE_ID_VMWARE_NET         0x0720
57 #define PCI_DEVICE_ID_VMWARE_SCSI        0x0730
58 #define PCI_DEVICE_ID_VMWARE_IDE         0x1729
59
60 /* Intel (0x8086) */
61 #define PCI_DEVICE_ID_INTEL_82551IT      0x1209
62
63 /* Red Hat / Qumranet (for QEMU) -- see pci-ids.txt */
64 #define PCI_VENDOR_ID_REDHAT_QUMRANET    0x1af4
65 #define PCI_SUBVENDOR_ID_REDHAT_QUMRANET 0x1af4
66 #define PCI_SUBDEVICE_ID_QEMU            0x1100
67
68 #define PCI_DEVICE_ID_VIRTIO_NET         0x1000
69 #define PCI_DEVICE_ID_VIRTIO_BLOCK       0x1001
70 #define PCI_DEVICE_ID_VIRTIO_BALLOON     0x1002
71 #define PCI_DEVICE_ID_VIRTIO_CONSOLE     0x1003
72
73 typedef void PCIConfigWriteFunc(PCIDevice *pci_dev,
74                                 uint32_t address, uint32_t data, int len);
75 typedef uint32_t PCIConfigReadFunc(PCIDevice *pci_dev,
76                                    uint32_t address, int len);
77 typedef void PCIMapIORegionFunc(PCIDevice *pci_dev, int region_num,
78                                 uint32_t addr, uint32_t size, int type);
79 typedef int PCIUnregisterFunc(PCIDevice *pci_dev);
80
81 #define PCI_ADDRESS_SPACE_MEM           0x00
82 #define PCI_ADDRESS_SPACE_IO            0x01
83 #define PCI_ADDRESS_SPACE_MEM_PREFETCH  0x08
84
85 typedef struct PCIIORegion {
86     uint32_t addr; /* current PCI mapping address. -1 means not mapped */
87     uint32_t size;
88     uint8_t type;
89     PCIMapIORegionFunc *map_func;
90 } PCIIORegion;
91
92 #define PCI_ROM_SLOT 6
93 #define PCI_NUM_REGIONS 7
94
95 /* Declarations from linux/pci_regs.h */
96 #define PCI_VENDOR_ID           0x00    /* 16 bits */
97 #define PCI_DEVICE_ID           0x02    /* 16 bits */
98 #define PCI_COMMAND             0x04    /* 16 bits */
99 #define  PCI_COMMAND_IO         0x1     /* Enable response in I/O space */
100 #define  PCI_COMMAND_MEMORY     0x2     /* Enable response in Memory space */
101 #define  PCI_COMMAND_MASTER     0x4     /* Enable bus master */
102 #define PCI_STATUS              0x06    /* 16 bits */
103 #define PCI_REVISION_ID         0x08    /* 8 bits  */
104 #define PCI_CLASS_DEVICE        0x0a    /* Device class */
105 #define PCI_CACHE_LINE_SIZE     0x0c    /* 8 bits */
106 #define PCI_LATENCY_TIMER       0x0d    /* 8 bits */
107 #define PCI_HEADER_TYPE         0x0e    /* 8 bits */
108 #define  PCI_HEADER_TYPE_NORMAL         0
109 #define  PCI_HEADER_TYPE_BRIDGE         1
110 #define  PCI_HEADER_TYPE_CARDBUS        2
111 #define  PCI_HEADER_TYPE_MULTI_FUNCTION 0x80
112 #define PCI_BASE_ADDRESS_0      0x10    /* 32 bits */
113 #define PCI_PRIMARY_BUS         0x18    /* Primary bus number */
114 #define PCI_SECONDARY_BUS       0x19    /* Secondary bus number */
115 #define PCI_SEC_STATUS          0x1e    /* Secondary status register, only bit 14 used */
116 #define PCI_SUBSYSTEM_VENDOR_ID 0x2c    /* 16 bits */
117 #define PCI_SUBSYSTEM_ID        0x2e    /* 16 bits */
118 #define PCI_CAPABILITY_LIST     0x34    /* Offset of first capability list entry */
119 #define PCI_INTERRUPT_LINE      0x3c    /* 8 bits */
120 #define PCI_INTERRUPT_PIN       0x3d    /* 8 bits */
121 #define PCI_MIN_GNT             0x3e    /* 8 bits */
122 #define PCI_MAX_LAT             0x3f    /* 8 bits */
123
124 /* Capability lists */
125 #define PCI_CAP_LIST_ID         0       /* Capability ID */
126 #define PCI_CAP_LIST_NEXT       1       /* Next capability in the list */
127
128 #define PCI_REVISION            0x08    /* obsolete, use PCI_REVISION_ID */
129 #define PCI_SUBVENDOR_ID        0x2c    /* obsolete, use PCI_SUBSYSTEM_VENDOR_ID */
130 #define PCI_SUBDEVICE_ID        0x2e    /* obsolete, use PCI_SUBSYSTEM_ID */
131
132 /* Bits in the PCI Status Register (PCI 2.3 spec) */
133 #define PCI_STATUS_RESERVED1    0x007
134 #define PCI_STATUS_INT_STATUS   0x008
135 #define PCI_STATUS_CAP_LIST     0x010
136 #define PCI_STATUS_66MHZ        0x020
137 #define PCI_STATUS_RESERVED2    0x040
138 #define PCI_STATUS_FAST_BACK    0x080
139 #define PCI_STATUS_DEVSEL       0x600
140
141 #define PCI_STATUS_RESERVED_MASK_LO (PCI_STATUS_RESERVED1 | \
142                 PCI_STATUS_INT_STATUS | PCI_STATUS_CAPABILITIES | \
143                 PCI_STATUS_66MHZ | PCI_STATUS_RESERVED2 | PCI_STATUS_FAST_BACK)
144
145 #define PCI_STATUS_RESERVED_MASK_HI (PCI_STATUS_DEVSEL >> 8)
146
147 /* Bits in the PCI Command Register (PCI 2.3 spec) */
148 #define PCI_COMMAND_RESERVED    0xf800
149
150 #define PCI_COMMAND_RESERVED_MASK_HI (PCI_COMMAND_RESERVED >> 8)
151
152 /* Size of the standard PCI config header */
153 #define PCI_CONFIG_HEADER_SIZE 0x40
154 /* Size of the standard PCI config space */
155 #define PCI_CONFIG_SPACE_SIZE 0x100
156
157 struct PCIDevice {
158     DeviceState qdev;
159     /* PCI config space */
160     uint8_t config[PCI_CONFIG_SPACE_SIZE];
161
162     /* Used to implement R/W bytes */
163     uint8_t wmask[PCI_CONFIG_SPACE_SIZE];
164
165     /* Used to allocate config space for capabilities. */
166     uint8_t used[PCI_CONFIG_SPACE_SIZE];
167
168     /* the following fields are read only */
169     PCIBus *bus;
170     int devfn;
171     char name[64];
172     PCIIORegion io_regions[PCI_NUM_REGIONS];
173
174     /* do not access the following fields */
175     PCIConfigReadFunc *config_read;
176     PCIConfigWriteFunc *config_write;
177     PCIUnregisterFunc *unregister;
178
179     /* IRQ objects for the INTA-INTD pins.  */
180     qemu_irq *irq;
181
182     /* Current IRQ levels.  Used internally by the generic PCI code.  */
183     int irq_state[4];
184 };
185
186 PCIDevice *pci_register_device(PCIBus *bus, const char *name,
187                                int instance_size, int devfn,
188                                PCIConfigReadFunc *config_read,
189                                PCIConfigWriteFunc *config_write);
190 int pci_unregister_device(PCIDevice *pci_dev);
191
192 void pci_register_bar(PCIDevice *pci_dev, int region_num,
193                             uint32_t size, int type,
194                             PCIMapIORegionFunc *map_func);
195
196 int pci_add_capability(PCIDevice *pci_dev, uint8_t cap_id, uint8_t cap_size);
197
198 void pci_del_capability(PCIDevice *pci_dev, uint8_t cap_id, uint8_t cap_size);
199
200 void pci_reserve_capability(PCIDevice *pci_dev, uint8_t offset, uint8_t size);
201
202 uint8_t pci_find_capability(PCIDevice *pci_dev, uint8_t cap_id);
203
204
205 uint32_t pci_default_read_config(PCIDevice *d,
206                                  uint32_t address, int len);
207 void pci_default_write_config(PCIDevice *d,
208                               uint32_t address, uint32_t val, int len);
209 void pci_device_save(PCIDevice *s, QEMUFile *f);
210 int pci_device_load(PCIDevice *s, QEMUFile *f);
211
212 typedef void (*pci_set_irq_fn)(qemu_irq *pic, int irq_num, int level);
213 typedef int (*pci_map_irq_fn)(PCIDevice *pci_dev, int irq_num);
214 PCIBus *pci_register_bus(DeviceState *parent, const char *name,
215                          pci_set_irq_fn set_irq, pci_map_irq_fn map_irq,
216                          qemu_irq *pic, int devfn_min, int nirq);
217
218 PCIDevice *pci_nic_init(NICInfo *nd, const char *default_model,
219                         const char *default_devaddr);
220 void pci_data_write(void *opaque, uint32_t addr, uint32_t val, int len);
221 uint32_t pci_data_read(void *opaque, uint32_t addr, int len);
222 int pci_bus_num(PCIBus *s);
223 void pci_for_each_device(int bus_num, void (*fn)(PCIDevice *d));
224 PCIBus *pci_find_bus(int bus_num);
225 PCIDevice *pci_find_device(int bus_num, int slot, int function);
226
227 int pci_read_devaddr(const char *addr, int *domp, int *busp, unsigned *slotp);
228
229 void pci_info(Monitor *mon);
230 PCIBus *pci_bridge_init(PCIBus *bus, int devfn, uint16_t vid, uint16_t did,
231                         pci_map_irq_fn map_irq, const char *name);
232
233 static inline void
234 pci_set_word(uint8_t *config, uint16_t val)
235 {
236     cpu_to_le16wu((uint16_t *)config, val);
237 }
238
239 static inline uint16_t
240 pci_get_word(uint8_t *config)
241 {
242     return le16_to_cpupu((uint16_t *)config);
243 }
244
245 static inline void
246 pci_set_long(uint8_t *config, uint32_t val)
247 {
248     cpu_to_le32wu((uint32_t *)config, val);
249 }
250
251 static inline uint32_t
252 pci_get_long(uint8_t *config)
253 {
254     return le32_to_cpupu((uint32_t *)config);
255 }
256
257 static inline void
258 pci_config_set_vendor_id(uint8_t *pci_config, uint16_t val)
259 {
260     pci_set_word(&pci_config[PCI_VENDOR_ID], val);
261 }
262
263 static inline void
264 pci_config_set_device_id(uint8_t *pci_config, uint16_t val)
265 {
266     pci_set_word(&pci_config[PCI_DEVICE_ID], val);
267 }
268
269 static inline void
270 pci_config_set_class(uint8_t *pci_config, uint16_t val)
271 {
272     pci_set_word(&pci_config[PCI_CLASS_DEVICE], val);
273 }
274
275 typedef void (*pci_qdev_initfn)(PCIDevice *dev);
276 void pci_qdev_register(const char *name, int size, pci_qdev_initfn init);
277
278 PCIDevice *pci_create(const char *name, const char *devaddr);
279 PCIDevice *pci_create_simple(PCIBus *bus, int devfn, const char *name);
280
281 /* lsi53c895a.c */
282 #define LSI_MAX_DEVS 7
283 void lsi_scsi_attach(DeviceState *host, BlockDriverState *bd, int id);
284
285 /* vmware_vga.c */
286 void pci_vmsvga_init(PCIBus *bus);
287
288 /* usb-uhci.c */
289 void usb_uhci_piix3_init(PCIBus *bus, int devfn);
290 void usb_uhci_piix4_init(PCIBus *bus, int devfn);
291
292 /* usb-ohci.c */
293 void usb_ohci_init_pci(struct PCIBus *bus, int num_ports, int devfn);
294
295 /* prep_pci.c */
296 PCIBus *pci_prep_init(qemu_irq *pic);
297
298 /* apb_pci.c */
299 PCIBus *pci_apb_init(target_phys_addr_t special_base,
300                      target_phys_addr_t mem_base,
301                      qemu_irq *pic, PCIBus **bus2, PCIBus **bus3);
302
303 /* sh_pci.c */
304 PCIBus *sh_pci_register_bus(pci_set_irq_fn set_irq, pci_map_irq_fn map_irq,
305                             qemu_irq *pic, int devfn_min, int nirq);
306
307 #endif