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