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 struct vm_device;
  35
  36
  37 typedef enum { PCI_BAR_IO,
  38                PCI_BAR_MEM24,
  39                PCI_BAR_MEM32,
  40                PCI_BAR_MEM64_LO,
  41                PCI_BAR_MEM64_HI,
  42                PCI_BAR_PASSTHROUGH,
  43                PCI_BAR_NONE } pci_bar_type_t;
  44
  45 typedef enum {PCI_STD_DEVICE, PCI_TO_PCI_BRIDGE, PCI_CARDBUS, PCI_MULTIFUNCTION, PCI_PASSTHROUGH} pci_device_type_t;
  46
  47
  48
  49 // For the rest of the subclass codes see:
  50 // http://www.acm.uiuc.edu/sigops/roll_your_own/7.c.1.html
  51
  52 #define PCI_AUTO_DEV_NUM (-1)
  53
  54 struct guest_info;
  55
  56 struct pci_device;
  57
  58 struct v3_pci_bar {
  59     pci_bar_type_t type;
  60
  61     union {
  62         struct {
  63             int num_pages;
  64             addr_t default_base_addr;
  65             int (*mem_read)(struct guest_info * core, addr_t guest_addr, void * dst, uint_t length, void * private_data);
  66             int (*mem_write)(struct guest_info * core, addr_t guest_addr, void * src, uint_t length, void * private_data);
  67         };
  68
  69         struct {
  70             int num_ports;
  71             uint16_t default_base_port;
  72             int (*io_read)(struct guest_info * core, uint16_t port, void * src, uint_t length, void * private_data);
  73             int (*io_write)(struct guest_info * core, uint16_t port, void * src, uint_t length, void * private_data);
  74         };
  75
  76         struct {
  77             int (*bar_init)(int bar_num, uint32_t * dst, void * private_data);
  78             int (*bar_write)(int bar_num, uint32_t * src, void * private_data);
  79         };
  80     };
  81
  82     void * private_data;
  83
  84     // Internal PCI data
  85     uint32_t val;
  86     uint8_t updated;
  87     uint32_t mask;
  88 };
  89
  90
  91 #define PCI_IO_MASK 0xfffffffc
  92 #define PCI_MEM24_MASK 0x000ffff0
  93 #define PCI_MEM_MASK 0xfffffff0
  94 #define PCI_MEM64_MASK_HI 0xffffffff
  95 #define PCI_MEM64_MASK_LO 0xfffffff0
  96 #define PCI_EXP_ROM_MASK 0xfffff800
  97
  98
  99
 100 #define PCI_IO_BASE(bar_val) (bar_val & PCI_IO_MASK)
 101 #define PCI_MEM24_BASE(bar_val) (bar_val & PCI_MEM24_MASK)
 102 #define PCI_MEM32_BASE(bar_val) (bar_val & PCI_MEM_MASK)
 103 #define PCI_MEM64_BASE_HI(bar_val) (bar_val & PCI_MEM64_MASK_HI)
 104 #define PCI_MEM64_BASE_LO(bar_val) (bar_val & PCI_MEM64_MASK_LO)
 105 #define PCI_EXP_ROM_BASE(rom_val) (rom_val & PCI_EXP_ROM_MASK)
 106
 107
 108 struct pci_device {
 109
 110     pci_device_type_t type;
 111
 112     union {
 113         uint8_t config_space[256];
 114
 115         struct {
 116             struct pci_config_header config_header;
 117             uint8_t config_data[192];
 118         } __attribute__((packed));
 119     } __attribute__((packed));
 120
 121     struct v3_pci_bar bar[6];
 122
 123     struct rb_node dev_tree_node;
 124
 125     uint_t bus_num;
 126
 127     union {
 128         uint8_t devfn;
 129         struct {
 130             uint8_t fn_num       : 3;
 131             uint8_t dev_num      : 5;
 132         } __attribute__((packed));
 133     } __attribute__((packed));
 134
 135     char name[64];
 136
 137     int (*config_update)(uint_t reg_num, void * src, uint_t length, void * priv_data);
 138
 139     int (*cmd_update)(struct pci_device * pci_dev, uchar_t io_enabled, uchar_t mem_enabled);
 140     int (*exp_rom_update)(struct pci_device * pci_dev, uint32_t * src, void * private_data);
 141
 142     int (*config_write)(uint_t reg_num, void * src, uint_t length, void * private_data);
 143     int (*config_read)(uint_t reg_num, void * dst, uint_t length, void * private_data);
 144
 145
 146     int exp_rom_update_flag;
 147     int bar_update_flag;
 148
 149     void * priv_data;
 150 };
 151
 152
 153 int v3_pci_set_irq_bridge(struct vm_device * pci_bus, int bus_num,
 154                           int (*raise_pci_irq)(struct pci_device * pci_dev, void * dev_data),
 155                           int (*lower_pci_irq)(struct pci_device * pci_dev, void * dev_data),
 156                           void * dev_data);
 157
 158
 159 int v3_pci_raise_irq(struct vm_device * pci_bus, int bus_num, struct pci_device * dev);
 160 int v3_pci_lower_irq(struct vm_device * pci_bus, int bus_num, struct pci_device * dev);
 161
 162 struct pci_device *
 163 v3_pci_register_device(struct vm_device * pci,
 164                        pci_device_type_t dev_type,
 165                        int bus_num,
 166                        int dev_num,
 167                        int fn_num,
 168                        const char * name,
 169                        struct v3_pci_bar * bars,
 170                        int (*config_update)(uint_t reg_num, void * src, uint_t length, void * private_data),
 171                        int (*cmd_update)(struct pci_device *pci_dev, uchar_t io_enabled, uchar_t mem_enabled),
 172                        int (*exp_rom_update)(struct pci_device * pci_dev, uint32_t * src, void * private_data),
 173                        void * priv_data);
 174
 175
 176 struct pci_device *
 177 v3_pci_register_passthrough_device(struct vm_device * pci,
 178                                    int bus_num,
 179                                    int dev_num,
 180                                    int fn_num,
 181                                    const char * name,
 182                                    int (*config_write)(uint_t reg_num, void * src, uint_t length, void * private_data),
 183                                    int (*config_read)(uint_t reg_num, void * dst, uint_t length, void * private_data),
 184                                    void * private_data);
 185
 186
 187 #endif
 188
 189 #endif
 190