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
  34 typedef enum { PCI_BAR_IO,
  35                PCI_BAR_MEM16,
  36                PCI_BAR_MEM32,
  37                PCI_BAR_MEM64_LOW,
  38                PCI_BAR_MEM64_HIGH,
  39                PCI_BAR_NONE } pci_bar_type_t;
  40
  41 typedef enum {PCI_STD_DEVICE, PCI_TO_PCI_BRIDGE, PCI_CARDBUS, PCI_MULTIFUNCTION} pci_device_type_t;
  42
  43
  44
  45 // For the rest of the subclass codes see:
  46 // http://www.acm.uiuc.edu/sigops/roll_your_own/7.c.1.html
  47
  48 #define PCI_AUTO_DEV_NUM (-1)
  49
  50 struct pci_device;
  51
  52 struct v3_pci_bar {
  53     pci_bar_type_t type;
  54
  55     union {
  56         struct {
  57             int num_pages;
  58             addr_t default_base_addr;
  59             int (*mem_read)(addr_t guest_addr, void * dst, uint_t length, void * private_data);
  60             int (*mem_write)(addr_t guest_addr, void * src, uint_t length, void * private_data);
  61         };
  62
  63         struct {
  64             int num_ports;
  65             uint16_t default_base_port;
  66             int (*io_read)(ushort_t port, void * dst, uint_t length, void * private_data);
  67             int (*io_write)(ushort_t port, void * src, uint_t length, void * private_data);
  68         };
  69     };
  70
  71     void * private_data;
  72
  73     // Internal PCI data
  74     uint32_t val;
  75     int updated;
  76     uint32_t mask;
  77 };
  78
  79
  80 #define PCI_IO_MASK 0xfffffffc
  81 #define PCI_MEM32_MASK 0xfffffff0
  82
  83 #define PCI_IO_BASE(bar_val) (bar_val & PCI_IO_MASK)
  84 #define PCI_MEM32_BASE(bar_val) (bar_val & PCI_MEM32_MASK)
  85
  86 struct pci_device {
  87
  88     union {
  89         uint8_t config_space[256];
  90
  91         struct {
  92             struct pci_config_header config_header;
  93             uint8_t config_data[192];
  94         } __attribute__((packed));
  95     } __attribute__((packed));
  96
  97     struct v3_pci_bar bar[6];
  98
  99     struct rb_node dev_tree_node;
 100
 101     uint_t bus_num;
 102
 103     union {
 104         uint8_t devfn;
 105         struct {
 106             uint8_t fn_num       : 3;
 107             uint8_t dev_num      : 5;
 108         } __attribute__((packed));
 109     } __attribute__((packed));
 110
 111     char name[64];
 112
 113     struct vm_device * vm_dev;  //the corresponding virtual device
 114
 115     int (*config_update)(struct pci_device * pci_dev, uint_t reg_num, int length);
 116
 117     int (*cmd_update)(struct pci_device *pci_dev, uchar_t io_enabled, uchar_t mem_enabled);
 118     int (*ext_rom_update)(struct pci_device *pci_dev);
 119
 120     int ext_rom_update_flag;
 121     int bar_update_flag;
 122
 123     void * priv_data;
 124 };
 125
 126
 127 int v3_pci_set_irq_bridge(struct vm_device * pci_bus, int bus_num,
 128                           int (*raise_pci_irq)(struct vm_device * dev, struct pci_device * pci_dev),
 129                           int (*lower_pci_irq)(struct vm_device * dev, struct pci_device * pci_dev),
 130                           struct vm_device * bridge_dev);
 131
 132
 133 int v3_pci_raise_irq(struct vm_device * pci_bus, int bus_num, struct pci_device * dev);
 134 int v3_pci_lower_irq(struct vm_device * pci_bus, int bus_num, struct pci_device * dev);
 135
 136 struct pci_device *
 137 v3_pci_register_device(struct vm_device * pci,
 138                        pci_device_type_t dev_type,
 139                        int bus_num,
 140                        int dev_num,
 141                        int fn_num,
 142                        const char * name,
 143                        struct v3_pci_bar * bars,
 144                        int (*config_update)(struct pci_device * pci_dev, uint_t reg_num, int length),
 145                        int (*cmd_update)(struct pci_device *pci_dev, uchar_t io_enabled, uchar_t mem_enabled),
 146                        int (*ext_rom_update)(struct pci_device *pci_dev),
 147                        struct vm_device * dev);
 148
 149
 150 #endif
 151
 152 #endif
 153