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