hw/msix.c

   1 /*
   2  * MSI-X device support
   3  *
   4  * This module includes support for MSI-X in pci devices.
   5  *
   6  * Author: Michael S. Tsirkin <mst@redhat.com>
   7  *
   8  *  Copyright (c) 2009, Red Hat Inc, Michael S. Tsirkin (mst@redhat.com)
   9  *
  10  * This work is licensed under the terms of the GNU GPL, version 2.  See
  11  * the COPYING file in the top-level directory.
  12  */
  13
  14 #include "hw.h"
  15 #include "msix.h"
  16 #include "pci.h"
  17
  18 /* Declaration from linux/pci_regs.h */
  19 #define  PCI_CAP_ID_MSIX 0x11 /* MSI-X */
  20 #define  PCI_MSIX_FLAGS 2     /* Table at lower 11 bits */
  21 #define  PCI_MSIX_FLAGS_QSIZE   0x7FF
  22 #define  PCI_MSIX_FLAGS_ENABLE  (1 << 15)
  23 #define  PCI_MSIX_FLAGS_BIRMASK (7 << 0)
  24
  25 /* MSI-X capability structure */
  26 #define MSIX_TABLE_OFFSET 4
  27 #define MSIX_PBA_OFFSET 8
  28 #define MSIX_CAP_LENGTH 12
  29
  30 /* MSI enable bit is in byte 1 in FLAGS register */
  31 #define MSIX_ENABLE_OFFSET (PCI_MSIX_FLAGS + 1)
  32 #define MSIX_ENABLE_MASK (PCI_MSIX_FLAGS_ENABLE >> 8)
  33
  34 /* MSI-X table format */
  35 #define MSIX_MSG_ADDR 0
  36 #define MSIX_MSG_UPPER_ADDR 4
  37 #define MSIX_MSG_DATA 8
  38 #define MSIX_VECTOR_CTRL 12
  39 #define MSIX_ENTRY_SIZE 16
  40 #define MSIX_VECTOR_MASK 0x1
  41
  42 /* How much space does an MSIX table need. */
  43 /* The spec requires giving the table structure
  44  * a 4K aligned region all by itself. */
  45 #define MSIX_PAGE_SIZE 0x1000
  46 /* Reserve second half of the page for pending bits */
  47 #define MSIX_PAGE_PENDING (MSIX_PAGE_SIZE / 2)
  48 #define MSIX_MAX_ENTRIES 32
  49
  50
  51 #ifdef MSIX_DEBUG
  52 #define DEBUG(fmt, ...)                                       \
  53     do {                                                      \
  54       fprintf(stderr, "%s: " fmt, __func__ , __VA_ARGS__);    \
  55     } while (0)
  56 #else
  57 #define DEBUG(fmt, ...) do { } while(0)
  58 #endif
  59
  60 /* Flag for interrupt controller to declare MSI-X support */
  61 int msix_supported;
  62
  63 /* Add MSI-X capability to the config space for the device. */
  64 /* Given a bar and its size, add MSI-X table on top of it
  65  * and fill MSI-X capability in the config space.
  66  * Original bar size must be a power of 2 or 0.
  67  * New bar size is returned. */
  68 static int msix_add_config(struct PCIDevice *pdev, unsigned short nentries,
  69                            unsigned bar_nr, unsigned bar_size)
  70 {
  71     int config_offset;
  72     uint8_t *config;
  73     uint32_t new_size;
  74
  75     if (nentries < 1 || nentries > PCI_MSIX_FLAGS_QSIZE + 1)
  76         return -EINVAL;
  77     if (bar_size > 0x80000000)
  78         return -ENOSPC;
  79
  80     /* Add space for MSI-X structures */
  81     if (!bar_size) {
  82         new_size = MSIX_PAGE_SIZE;
  83     } else if (bar_size < MSIX_PAGE_SIZE) {
  84         bar_size = MSIX_PAGE_SIZE;
  85         new_size = MSIX_PAGE_SIZE * 2;
  86     } else {
  87         new_size = bar_size * 2;
  88     }
  89
  90     pdev->msix_bar_size = new_size;
  91     config_offset = pci_add_capability(pdev, PCI_CAP_ID_MSIX, MSIX_CAP_LENGTH);
  92     if (config_offset < 0)
  93         return config_offset;
  94     config = pdev->config + config_offset;
  95
  96     pci_set_word(config + PCI_MSIX_FLAGS, nentries - 1);
  97     /* Table on top of BAR */
  98     pci_set_long(config + MSIX_TABLE_OFFSET, bar_size | bar_nr);
  99     /* Pending bits on top of that */
 100     pci_set_long(config + MSIX_PBA_OFFSET, (bar_size + MSIX_PAGE_PENDING) |
 101                  bar_nr);
 102     pdev->msix_cap = config_offset;
 103     /* Make flags bit writeable. */
 104     pdev->wmask[config_offset + MSIX_ENABLE_OFFSET] |= MSIX_ENABLE_MASK;
 105     return 0;
 106 }
 107
 108 static void msix_free_irq_entries(PCIDevice *dev)
 109 {
 110     int vector;
 111
 112     for (vector = 0; vector < dev->msix_entries_nr; ++vector)
 113         dev->msix_entry_used[vector] = 0;
 114 }
 115
 116 /* Handle MSI-X capability config write. */
 117 void msix_write_config(PCIDevice *dev, uint32_t addr,
 118                        uint32_t val, int len)
 119 {
 120     unsigned enable_pos = dev->msix_cap + MSIX_ENABLE_OFFSET;
 121     if (addr + len <= enable_pos || addr > enable_pos)
 122         return;
 123
 124     if (msix_enabled(dev))
 125         qemu_set_irq(dev->irq[0], 0);
 126 }
 127
 128 static uint32_t msix_mmio_readl(void *opaque, target_phys_addr_t addr)
 129 {
 130     PCIDevice *dev = opaque;
 131     unsigned int offset = addr & (MSIX_PAGE_SIZE - 1);
 132     void *page = dev->msix_table_page;
 133     uint32_t val = 0;
 134
 135     memcpy(&val, (void *)((char *)page + offset), 4);
 136
 137     return val;
 138 }
 139
 140 static uint32_t msix_mmio_read_unallowed(void *opaque, target_phys_addr_t addr)
 141 {
 142     fprintf(stderr, "MSI-X: only dword read is allowed!\n");
 143     return 0;
 144 }
 145
 146 static uint8_t msix_pending_mask(int vector)
 147 {
 148     return 1 << (vector % 8);
 149 }
 150
 151 static uint8_t *msix_pending_byte(PCIDevice *dev, int vector)
 152 {
 153     return dev->msix_table_page + MSIX_PAGE_PENDING + vector / 8;
 154 }
 155
 156 static int msix_is_pending(PCIDevice *dev, int vector)
 157 {
 158     return *msix_pending_byte(dev, vector) & msix_pending_mask(vector);
 159 }
 160
 161 static void msix_set_pending(PCIDevice *dev, int vector)
 162 {
 163     *msix_pending_byte(dev, vector) |= msix_pending_mask(vector);
 164 }
 165
 166 static void msix_clr_pending(PCIDevice *dev, int vector)
 167 {
 168     *msix_pending_byte(dev, vector) &= ~msix_pending_mask(vector);
 169 }
 170
 171 static int msix_is_masked(PCIDevice *dev, int vector)
 172 {
 173     unsigned offset = vector * MSIX_ENTRY_SIZE + MSIX_VECTOR_CTRL;
 174     return dev->msix_table_page[offset] & MSIX_VECTOR_MASK;
 175 }
 176
 177 static void msix_mmio_writel(void *opaque, target_phys_addr_t addr,
 178                              uint32_t val)
 179 {
 180     PCIDevice *dev = opaque;
 181     unsigned int offset = addr & (MSIX_PAGE_SIZE - 1);
 182     int vector = offset / MSIX_ENTRY_SIZE;
 183     memcpy(dev->msix_table_page + offset, &val, 4);
 184     if (!msix_is_masked(dev, vector) && msix_is_pending(dev, vector)) {
 185         msix_clr_pending(dev, vector);
 186         msix_notify(dev, vector);
 187     }
 188 }
 189
 190 static void msix_mmio_write_unallowed(void *opaque, target_phys_addr_t addr,
 191                                       uint32_t val)
 192 {
 193     fprintf(stderr, "MSI-X: only dword write is allowed!\n");
 194 }
 195
 196 static CPUWriteMemoryFunc * const msix_mmio_write[] = {
 197     msix_mmio_write_unallowed, msix_mmio_write_unallowed, msix_mmio_writel
 198 };
 199
 200 static CPUReadMemoryFunc * const msix_mmio_read[] = {
 201     msix_mmio_read_unallowed, msix_mmio_read_unallowed, msix_mmio_readl
 202 };
 203
 204 /* Should be called from device's map method. */
 205 void msix_mmio_map(PCIDevice *d, int region_num,
 206                    uint32_t addr, uint32_t size, int type)
 207 {
 208     uint8_t *config = d->config + d->msix_cap;
 209     uint32_t table = pci_get_long(config + MSIX_TABLE_OFFSET);
 210     uint32_t offset = table & ~(MSIX_PAGE_SIZE - 1);
 211     /* TODO: for assigned devices, we'll want to make it possible to map
 212      * pending bits separately in case they are in a separate bar. */
 213     int table_bir = table & PCI_MSIX_FLAGS_BIRMASK;
 214
 215     if (table_bir != region_num)
 216         return;
 217     if (size <= offset)
 218         return;
 219     cpu_register_physical_memory(addr + offset, size - offset,
 220                                  d->msix_mmio_index);
 221 }
 222
 223 /* Initialize the MSI-X structures. Note: if MSI-X is supported, BAR size is
 224  * modified, it should be retrieved with msix_bar_size. */
 225 int msix_init(struct PCIDevice *dev, unsigned short nentries,
 226               unsigned bar_nr, unsigned bar_size)
 227 {
 228     int ret;
 229     /* Nothing to do if MSI is not supported by interrupt controller */
 230     if (!msix_supported)
 231         return -ENOTSUP;
 232
 233     if (nentries > MSIX_MAX_ENTRIES)
 234         return -EINVAL;
 235
 236     dev->msix_entry_used = qemu_mallocz(MSIX_MAX_ENTRIES *
 237                                         sizeof *dev->msix_entry_used);
 238
 239     dev->msix_table_page = qemu_mallocz(MSIX_PAGE_SIZE);
 240
 241     dev->msix_mmio_index = cpu_register_io_memory(msix_mmio_read,
 242                                                   msix_mmio_write, dev);
 243     if (dev->msix_mmio_index == -1) {
 244         ret = -EBUSY;
 245         goto err_index;
 246     }
 247
 248     dev->msix_entries_nr = nentries;
 249     ret = msix_add_config(dev, nentries, bar_nr, bar_size);
 250     if (ret)
 251         goto err_config;
 252
 253     dev->cap_present |= QEMU_PCI_CAP_MSIX;
 254     return 0;
 255
 256 err_config:
 257     dev->msix_entries_nr = 0;
 258     cpu_unregister_io_memory(dev->msix_mmio_index);
 259 err_index:
 260     qemu_free(dev->msix_table_page);
 261     dev->msix_table_page = NULL;
 262     qemu_free(dev->msix_entry_used);
 263     dev->msix_entry_used = NULL;
 264     return ret;
 265 }
 266
 267 /* Clean up resources for the device. */
 268 int msix_uninit(PCIDevice *dev)
 269 {
 270     if (!(dev->cap_present & QEMU_PCI_CAP_MSIX))
 271         return 0;
 272     pci_del_capability(dev, PCI_CAP_ID_MSIX, MSIX_CAP_LENGTH);
 273     dev->msix_cap = 0;
 274     msix_free_irq_entries(dev);
 275     dev->msix_entries_nr = 0;
 276     cpu_unregister_io_memory(dev->msix_mmio_index);
 277     qemu_free(dev->msix_table_page);
 278     dev->msix_table_page = NULL;
 279     qemu_free(dev->msix_entry_used);
 280     dev->msix_entry_used = NULL;
 281     dev->cap_present &= ~QEMU_PCI_CAP_MSIX;
 282     return 0;
 283 }
 284
 285 void msix_save(PCIDevice *dev, QEMUFile *f)
 286 {
 287     unsigned n = dev->msix_entries_nr;
 288
 289     if (!(dev->cap_present & QEMU_PCI_CAP_MSIX)) {
 290         return;
 291     }
 292
 293     qemu_put_buffer(f, dev->msix_table_page, n * MSIX_ENTRY_SIZE);
 294     qemu_put_buffer(f, dev->msix_table_page + MSIX_PAGE_PENDING, (n + 7) / 8);
 295 }
 296
 297 /* Should be called after restoring the config space. */
 298 void msix_load(PCIDevice *dev, QEMUFile *f)
 299 {
 300     unsigned n = dev->msix_entries_nr;
 301
 302     if (!(dev->cap_present & QEMU_PCI_CAP_MSIX)) {
 303         return;
 304     }
 305
 306     msix_free_irq_entries(dev);
 307     qemu_get_buffer(f, dev->msix_table_page, n * MSIX_ENTRY_SIZE);
 308     qemu_get_buffer(f, dev->msix_table_page + MSIX_PAGE_PENDING, (n + 7) / 8);
 309 }
 310
 311 /* Does device support MSI-X? */
 312 int msix_present(PCIDevice *dev)
 313 {
 314     return dev->cap_present & QEMU_PCI_CAP_MSIX;
 315 }
 316
 317 /* Is MSI-X enabled? */
 318 int msix_enabled(PCIDevice *dev)
 319 {
 320     return (dev->cap_present & QEMU_PCI_CAP_MSIX) &&
 321         (dev->config[dev->msix_cap + MSIX_ENABLE_OFFSET] &
 322          MSIX_ENABLE_MASK);
 323 }
 324
 325 /* Size of bar where MSI-X table resides, or 0 if MSI-X not supported. */
 326 uint32_t msix_bar_size(PCIDevice *dev)
 327 {
 328     return (dev->cap_present & QEMU_PCI_CAP_MSIX) ?
 329         dev->msix_bar_size : 0;
 330 }
 331
 332 /* Send an MSI-X message */
 333 void msix_notify(PCIDevice *dev, unsigned vector)
 334 {
 335     uint8_t *table_entry = dev->msix_table_page + vector * MSIX_ENTRY_SIZE;
 336     uint64_t address;
 337     uint32_t data;
 338
 339     if (vector >= dev->msix_entries_nr || !dev->msix_entry_used[vector])
 340         return;
 341     if (msix_is_masked(dev, vector)) {
 342         msix_set_pending(dev, vector);
 343         return;
 344     }
 345
 346     address = pci_get_long(table_entry + MSIX_MSG_UPPER_ADDR);
 347     address = (address << 32) | pci_get_long(table_entry + MSIX_MSG_ADDR);
 348     data = pci_get_long(table_entry + MSIX_MSG_DATA);
 349     stl_phys(address, data);
 350 }
 351
 352 void msix_reset(PCIDevice *dev)
 353 {
 354     if (!(dev->cap_present & QEMU_PCI_CAP_MSIX))
 355         return;
 356     msix_free_irq_entries(dev);
 357     dev->config[dev->msix_cap + MSIX_ENABLE_OFFSET] &= MSIX_ENABLE_MASK;
 358     memset(dev->msix_table_page, 0, MSIX_PAGE_SIZE);
 359 }
 360
 361 /* PCI spec suggests that devices make it possible for software to configure
 362  * less vectors than supported by the device, but does not specify a standard
 363  * mechanism for devices to do so.
 364  *
 365  * We support this by asking devices to declare vectors software is going to
 366  * actually use, and checking this on the notification path. Devices that
 367  * don't want to follow the spec suggestion can declare all vectors as used. */
 368
 369 /* Mark vector as used. */
 370 int msix_vector_use(PCIDevice *dev, unsigned vector)
 371 {
 372     if (vector >= dev->msix_entries_nr)
 373         return -EINVAL;
 374     dev->msix_entry_used[vector]++;
 375     return 0;
 376 }
 377
 378 /* Mark vector as unused. */
 379 void msix_vector_unuse(PCIDevice *dev, unsigned vector)
 380 {
 381     if (vector < dev->msix_entries_nr && dev->msix_entry_used[vector])
 382         --dev->msix_entry_used[vector];
 383 }