4 * This module includes support for MSI-X in pci devices.
6 * Author: Michael S. Tsirkin <mst@redhat.com>
8 * Copyright (c) 2009, Red Hat Inc, Michael S. Tsirkin (mst@redhat.com)
10 * This work is licensed under the terms of the GNU GPL, version 2. See
11 * the COPYING file in the top-level directory.
20 /* MSI-X capability structure */
21 #define MSIX_TABLE_OFFSET 4
22 #define MSIX_PBA_OFFSET 8
23 #define MSIX_CAP_LENGTH 12
25 /* MSI enable bit and maskall bit are in byte 1 in FLAGS register */
26 #define MSIX_CONTROL_OFFSET (PCI_MSIX_FLAGS + 1)
27 #define MSIX_ENABLE_MASK (PCI_MSIX_FLAGS_ENABLE >> 8)
28 #define MSIX_MASKALL_MASK (PCI_MSIX_FLAGS_MASKALL >> 8)
30 /* MSI-X table format */
31 #define MSIX_MSG_ADDR 0
32 #define MSIX_MSG_UPPER_ADDR 4
33 #define MSIX_MSG_DATA 8
34 #define MSIX_VECTOR_CTRL 12
35 #define MSIX_ENTRY_SIZE 16
36 #define MSIX_VECTOR_MASK 0x1
38 /* How much space does an MSIX table need. */
39 /* The spec requires giving the table structure
40 * a 4K aligned region all by itself. */
41 #define MSIX_PAGE_SIZE 0x1000
42 /* Reserve second half of the page for pending bits */
43 #define MSIX_PAGE_PENDING (MSIX_PAGE_SIZE / 2)
44 #define MSIX_MAX_ENTRIES 32
47 /* Flag for interrupt controller to declare MSI-X support */
50 /* KVM specific MSIX helpers */
51 static void kvm_msix_free(PCIDevice
*dev
)
53 int vector
, changed
= 0;
55 for (vector
= 0; vector
< dev
->msix_entries_nr
; ++vector
) {
56 if (dev
->msix_entry_used
[vector
]) {
57 kvm_msi_message_del(&dev
->msix_irq_entries
[vector
]);
62 kvm_commit_irq_routes();
66 static void kvm_msix_message_from_vector(PCIDevice
*dev
, unsigned vector
,
69 uint8_t *table_entry
= dev
->msix_table_page
+ vector
* MSIX_ENTRY_SIZE
;
71 kmm
->addr_lo
= pci_get_long(table_entry
+ MSIX_MSG_ADDR
);
72 kmm
->addr_hi
= pci_get_long(table_entry
+ MSIX_MSG_UPPER_ADDR
);
73 kmm
->data
= pci_get_long(table_entry
+ MSIX_MSG_DATA
);
76 static void kvm_msix_update(PCIDevice
*dev
, int vector
,
77 int was_masked
, int is_masked
)
79 KVMMsiMessage new_entry
, *entry
;
80 int mask_cleared
= was_masked
&& !is_masked
;
83 /* It is only legal to change an entry when it is masked. Therefore, it is
84 * enough to update the routing in kernel when mask is being cleared. */
88 if (!dev
->msix_entry_used
[vector
]) {
92 entry
= dev
->msix_irq_entries
+ vector
;
93 kvm_msix_message_from_vector(dev
, vector
, &new_entry
);
94 r
= kvm_msi_message_update(entry
, &new_entry
);
96 fprintf(stderr
, "%s: kvm_update_msix failed: %s\n", __func__
,
102 r
= kvm_commit_irq_routes();
104 fprintf(stderr
, "%s: kvm_commit_irq_routes failed: %s\n", __func__
,
111 static int kvm_msix_vector_add(PCIDevice
*dev
, unsigned vector
)
113 KVMMsiMessage
*kmm
= dev
->msix_irq_entries
+ vector
;
116 kvm_msix_message_from_vector(dev
, vector
, kmm
);
117 r
= kvm_msi_message_add(kmm
);
119 fprintf(stderr
, "%s: kvm_add_msix failed: %s\n", __func__
, strerror(-r
));
123 r
= kvm_commit_irq_routes();
125 fprintf(stderr
, "%s: kvm_commit_irq_routes failed: %s\n", __func__
, strerror(-r
));
131 static void kvm_msix_vector_del(PCIDevice
*dev
, unsigned vector
)
133 kvm_msi_message_del(&dev
->msix_irq_entries
[vector
]);
134 kvm_commit_irq_routes();
137 /* Add MSI-X capability to the config space for the device. */
138 /* Given a bar and its size, add MSI-X table on top of it
139 * and fill MSI-X capability in the config space.
140 * Original bar size must be a power of 2 or 0.
141 * New bar size is returned. */
142 static int msix_add_config(struct PCIDevice
*pdev
, unsigned short nentries
,
143 unsigned bar_nr
, unsigned bar_size
)
148 pdev
->msix_bar_size
= bar_size
;
150 config_offset
= pci_find_capability(pdev
, PCI_CAP_ID_MSIX
);
152 if (!config_offset
) {
155 if (nentries
< 1 || nentries
> PCI_MSIX_FLAGS_QSIZE
+ 1)
157 if (bar_size
> 0x80000000)
160 /* Add space for MSI-X structures */
162 new_size
= MSIX_PAGE_SIZE
;
163 } else if (bar_size
< MSIX_PAGE_SIZE
) {
164 bar_size
= MSIX_PAGE_SIZE
;
165 new_size
= MSIX_PAGE_SIZE
* 2;
167 new_size
= bar_size
* 2;
170 pdev
->msix_bar_size
= new_size
;
171 config_offset
= pci_add_capability(pdev
, PCI_CAP_ID_MSIX
,
173 if (config_offset
< 0)
174 return config_offset
;
175 config
= pdev
->config
+ config_offset
;
177 pci_set_word(config
+ PCI_MSIX_FLAGS
, nentries
- 1);
178 /* Table on top of BAR */
179 pci_set_long(config
+ MSIX_TABLE_OFFSET
, bar_size
| bar_nr
);
180 /* Pending bits on top of that */
181 pci_set_long(config
+ MSIX_PBA_OFFSET
, (bar_size
+ MSIX_PAGE_PENDING
) |
184 pdev
->msix_cap
= config_offset
;
185 /* Make flags bit writable. */
186 pdev
->wmask
[config_offset
+ MSIX_CONTROL_OFFSET
] |= MSIX_ENABLE_MASK
|
191 static uint32_t msix_mmio_readl(void *opaque
, target_phys_addr_t addr
)
193 PCIDevice
*dev
= opaque
;
194 unsigned int offset
= addr
& (MSIX_PAGE_SIZE
- 1) & ~0x3;
195 void *page
= dev
->msix_table_page
;
197 return pci_get_long(page
+ offset
);
200 static uint32_t msix_mmio_read_unallowed(void *opaque
, target_phys_addr_t addr
)
202 fprintf(stderr
, "MSI-X: only dword read is allowed!\n");
206 static uint8_t msix_pending_mask(int vector
)
208 return 1 << (vector
% 8);
211 static uint8_t *msix_pending_byte(PCIDevice
*dev
, int vector
)
213 return dev
->msix_table_page
+ MSIX_PAGE_PENDING
+ vector
/ 8;
216 static int msix_is_pending(PCIDevice
*dev
, int vector
)
218 return *msix_pending_byte(dev
, vector
) & msix_pending_mask(vector
);
221 static void msix_set_pending(PCIDevice
*dev
, int vector
)
223 *msix_pending_byte(dev
, vector
) |= msix_pending_mask(vector
);
226 static void msix_clr_pending(PCIDevice
*dev
, int vector
)
228 *msix_pending_byte(dev
, vector
) &= ~msix_pending_mask(vector
);
231 static int msix_function_masked(PCIDevice
*dev
)
233 return dev
->config
[dev
->msix_cap
+ MSIX_CONTROL_OFFSET
] & MSIX_MASKALL_MASK
;
236 static int msix_is_masked(PCIDevice
*dev
, int vector
)
238 unsigned offset
= vector
* MSIX_ENTRY_SIZE
+ MSIX_VECTOR_CTRL
;
239 return msix_function_masked(dev
) ||
240 dev
->msix_table_page
[offset
] & MSIX_VECTOR_MASK
;
243 static void msix_handle_mask_update(PCIDevice
*dev
, int vector
)
245 if (!msix_is_masked(dev
, vector
) && msix_is_pending(dev
, vector
)) {
246 msix_clr_pending(dev
, vector
);
247 msix_notify(dev
, vector
);
251 /* Handle MSI-X capability config write. */
252 void msix_write_config(PCIDevice
*dev
, uint32_t addr
,
253 uint32_t val
, int len
)
255 unsigned enable_pos
= dev
->msix_cap
+ MSIX_CONTROL_OFFSET
;
258 if (!range_covers_byte(addr
, len
, enable_pos
)) {
262 if (!msix_enabled(dev
)) {
266 pci_device_deassert_intx(dev
);
268 if (msix_function_masked(dev
)) {
272 for (vector
= 0; vector
< dev
->msix_entries_nr
; ++vector
) {
273 msix_handle_mask_update(dev
, vector
);
277 static void msix_mmio_writel(void *opaque
, target_phys_addr_t addr
,
280 PCIDevice
*dev
= opaque
;
281 unsigned int offset
= addr
& (MSIX_PAGE_SIZE
- 1) & ~0x3;
282 int vector
= offset
/ MSIX_ENTRY_SIZE
;
283 int was_masked
= msix_is_masked(dev
, vector
);
284 pci_set_long(dev
->msix_table_page
+ offset
, val
);
285 if (kvm_enabled() && kvm_irqchip_in_kernel()) {
286 kvm_msix_update(dev
, vector
, was_masked
, msix_is_masked(dev
, vector
));
288 if (was_masked
!= msix_is_masked(dev
, vector
) && dev
->msix_mask_notifier
) {
289 int r
= dev
->msix_mask_notifier(dev
, vector
,
290 msix_is_masked(dev
, vector
));
293 msix_handle_mask_update(dev
, vector
);
296 static void msix_mmio_write_unallowed(void *opaque
, target_phys_addr_t addr
,
299 fprintf(stderr
, "MSI-X: only dword write is allowed!\n");
302 static CPUWriteMemoryFunc
* const msix_mmio_write
[] = {
303 msix_mmio_write_unallowed
, msix_mmio_write_unallowed
, msix_mmio_writel
306 static CPUReadMemoryFunc
* const msix_mmio_read
[] = {
307 msix_mmio_read_unallowed
, msix_mmio_read_unallowed
, msix_mmio_readl
310 /* Should be called from device's map method. */
311 void msix_mmio_map(PCIDevice
*d
, int region_num
,
312 pcibus_t addr
, pcibus_t size
, int type
)
314 uint8_t *config
= d
->config
+ d
->msix_cap
;
315 uint32_t table
= pci_get_long(config
+ MSIX_TABLE_OFFSET
);
316 uint32_t offset
= table
& ~(MSIX_PAGE_SIZE
- 1);
317 /* TODO: for assigned devices, we'll want to make it possible to map
318 * pending bits separately in case they are in a separate bar. */
319 int table_bir
= table
& PCI_MSIX_FLAGS_BIRMASK
;
321 if (table_bir
!= region_num
)
325 cpu_register_physical_memory(addr
+ offset
,
326 MIN(size
- offset
, MSIX_PAGE_SIZE
),
330 static void msix_mask_all(struct PCIDevice
*dev
, unsigned nentries
)
333 for (vector
= 0; vector
< nentries
; ++vector
) {
334 unsigned offset
= vector
* MSIX_ENTRY_SIZE
+ MSIX_VECTOR_CTRL
;
335 int was_masked
= msix_is_masked(dev
, vector
);
336 dev
->msix_table_page
[offset
] |= MSIX_VECTOR_MASK
;
337 if (was_masked
!= msix_is_masked(dev
, vector
) &&
338 dev
->msix_mask_notifier
) {
339 r
= dev
->msix_mask_notifier(dev
, vector
,
340 msix_is_masked(dev
, vector
));
346 /* Initialize the MSI-X structures. Note: if MSI-X is supported, BAR size is
347 * modified, it should be retrieved with msix_bar_size. */
348 int msix_init(struct PCIDevice
*dev
, unsigned short nentries
,
349 unsigned bar_nr
, unsigned bar_size
)
352 /* Nothing to do if MSI is not supported by interrupt controller */
353 if (!msix_supported
||
354 (kvm_enabled() && kvm_irqchip_in_kernel() && !kvm_has_gsi_routing())) {
358 if (nentries
> MSIX_MAX_ENTRIES
)
361 dev
->msix_mask_notifier
= NULL
;
362 dev
->msix_entry_used
= qemu_mallocz(MSIX_MAX_ENTRIES
*
363 sizeof *dev
->msix_entry_used
);
365 dev
->msix_table_page
= qemu_mallocz(MSIX_PAGE_SIZE
);
366 msix_mask_all(dev
, nentries
);
368 dev
->msix_mmio_index
= cpu_register_io_memory(msix_mmio_read
,
369 msix_mmio_write
, dev
,
370 DEVICE_NATIVE_ENDIAN
);
371 if (dev
->msix_mmio_index
== -1) {
376 dev
->msix_entries_nr
= nentries
;
377 ret
= msix_add_config(dev
, nentries
, bar_nr
, bar_size
);
381 if (kvm_enabled() && kvm_irqchip_in_kernel()) {
382 dev
->msix_irq_entries
= qemu_malloc(nentries
*
383 sizeof *dev
->msix_irq_entries
);
386 dev
->cap_present
|= QEMU_PCI_CAP_MSIX
;
390 dev
->msix_entries_nr
= 0;
391 cpu_unregister_io_memory(dev
->msix_mmio_index
);
393 qemu_free(dev
->msix_table_page
);
394 dev
->msix_table_page
= NULL
;
395 qemu_free(dev
->msix_entry_used
);
396 dev
->msix_entry_used
= NULL
;
400 static void msix_free_irq_entries(PCIDevice
*dev
)
404 if (kvm_enabled() && kvm_irqchip_in_kernel()) {
408 for (vector
= 0; vector
< dev
->msix_entries_nr
; ++vector
) {
409 dev
->msix_entry_used
[vector
] = 0;
410 msix_clr_pending(dev
, vector
);
414 /* Clean up resources for the device. */
415 int msix_uninit(PCIDevice
*dev
)
417 if (!(dev
->cap_present
& QEMU_PCI_CAP_MSIX
))
419 pci_del_capability(dev
, PCI_CAP_ID_MSIX
, MSIX_CAP_LENGTH
);
421 msix_free_irq_entries(dev
);
422 dev
->msix_entries_nr
= 0;
423 cpu_unregister_io_memory(dev
->msix_mmio_index
);
424 qemu_free(dev
->msix_table_page
);
425 dev
->msix_table_page
= NULL
;
426 qemu_free(dev
->msix_entry_used
);
427 dev
->msix_entry_used
= NULL
;
428 qemu_free(dev
->msix_irq_entries
);
429 dev
->msix_irq_entries
= NULL
;
430 dev
->cap_present
&= ~QEMU_PCI_CAP_MSIX
;
434 void msix_save(PCIDevice
*dev
, QEMUFile
*f
)
436 unsigned n
= dev
->msix_entries_nr
;
438 if (!msix_supported
) {
442 if (!(dev
->cap_present
& QEMU_PCI_CAP_MSIX
)) {
445 qemu_put_buffer(f
, dev
->msix_table_page
, n
* MSIX_ENTRY_SIZE
);
446 qemu_put_buffer(f
, dev
->msix_table_page
+ MSIX_PAGE_PENDING
, (n
+ 7) / 8);
449 /* Should be called after restoring the config space. */
450 void msix_load(PCIDevice
*dev
, QEMUFile
*f
)
452 unsigned n
= dev
->msix_entries_nr
;
457 if (!(dev
->cap_present
& QEMU_PCI_CAP_MSIX
)) {
461 msix_free_irq_entries(dev
);
462 qemu_get_buffer(f
, dev
->msix_table_page
, n
* MSIX_ENTRY_SIZE
);
463 qemu_get_buffer(f
, dev
->msix_table_page
+ MSIX_PAGE_PENDING
, (n
+ 7) / 8);
466 /* Does device support MSI-X? */
467 int msix_present(PCIDevice
*dev
)
469 return dev
->cap_present
& QEMU_PCI_CAP_MSIX
;
472 /* Is MSI-X enabled? */
473 int msix_enabled(PCIDevice
*dev
)
475 return (dev
->cap_present
& QEMU_PCI_CAP_MSIX
) &&
476 (dev
->config
[dev
->msix_cap
+ MSIX_CONTROL_OFFSET
] &
480 /* Size of bar where MSI-X table resides, or 0 if MSI-X not supported. */
481 uint32_t msix_bar_size(PCIDevice
*dev
)
483 return (dev
->cap_present
& QEMU_PCI_CAP_MSIX
) ?
484 dev
->msix_bar_size
: 0;
487 /* Send an MSI-X message */
488 void msix_notify(PCIDevice
*dev
, unsigned vector
)
490 uint8_t *table_entry
= dev
->msix_table_page
+ vector
* MSIX_ENTRY_SIZE
;
494 if (vector
>= dev
->msix_entries_nr
|| !dev
->msix_entry_used
[vector
])
496 if (msix_is_masked(dev
, vector
)) {
497 msix_set_pending(dev
, vector
);
501 if (kvm_enabled() && kvm_irqchip_in_kernel()) {
502 kvm_set_irq(dev
->msix_irq_entries
[vector
].gsi
, 1, NULL
);
506 address
= pci_get_long(table_entry
+ MSIX_MSG_UPPER_ADDR
);
507 address
= (address
<< 32) | pci_get_long(table_entry
+ MSIX_MSG_ADDR
);
508 data
= pci_get_long(table_entry
+ MSIX_MSG_DATA
);
509 stl_phys(address
, data
);
512 void msix_reset(PCIDevice
*dev
)
514 if (!(dev
->cap_present
& QEMU_PCI_CAP_MSIX
))
516 msix_free_irq_entries(dev
);
517 dev
->config
[dev
->msix_cap
+ MSIX_CONTROL_OFFSET
] &=
518 ~dev
->wmask
[dev
->msix_cap
+ MSIX_CONTROL_OFFSET
];
519 memset(dev
->msix_table_page
, 0, MSIX_PAGE_SIZE
);
520 msix_mask_all(dev
, dev
->msix_entries_nr
);
523 /* PCI spec suggests that devices make it possible for software to configure
524 * less vectors than supported by the device, but does not specify a standard
525 * mechanism for devices to do so.
527 * We support this by asking devices to declare vectors software is going to
528 * actually use, and checking this on the notification path. Devices that
529 * don't want to follow the spec suggestion can declare all vectors as used. */
531 /* Mark vector as used. */
532 int msix_vector_use(PCIDevice
*dev
, unsigned vector
)
535 if (vector
>= dev
->msix_entries_nr
)
537 if (kvm_enabled() && kvm_irqchip_in_kernel() &&
538 !dev
->msix_entry_used
[vector
]) {
539 ret
= kvm_msix_vector_add(dev
, vector
);
544 ++dev
->msix_entry_used
[vector
];
548 /* Mark vector as unused. */
549 void msix_vector_unuse(PCIDevice
*dev
, unsigned vector
)
551 if (vector
>= dev
->msix_entries_nr
|| !dev
->msix_entry_used
[vector
]) {
554 if (--dev
->msix_entry_used
[vector
]) {
557 if (kvm_enabled() && kvm_irqchip_in_kernel()) {
558 kvm_msix_vector_del(dev
, vector
);
560 msix_clr_pending(dev
, vector
);
563 void msix_unuse_all_vectors(PCIDevice
*dev
)
565 if (!(dev
->cap_present
& QEMU_PCI_CAP_MSIX
))
567 msix_free_irq_entries(dev
);
570 /* Invoke the notifier if vector entry is used and unmasked. */
571 static int msix_notify_if_unmasked(PCIDevice
*dev
, unsigned vector
, int masked
)
573 assert(dev
->msix_mask_notifier
);
574 if (!dev
->msix_entry_used
[vector
] || msix_is_masked(dev
, vector
)) {
577 return dev
->msix_mask_notifier(dev
, vector
, masked
);
580 static int msix_set_mask_notifier_for_vector(PCIDevice
*dev
, unsigned vector
)
582 /* Notifier has been set. Invoke it on unmasked vectors. */
583 return msix_notify_if_unmasked(dev
, vector
, 0);
586 static int msix_unset_mask_notifier_for_vector(PCIDevice
*dev
, unsigned vector
)
588 /* Notifier will be unset. Invoke it to mask unmasked entries. */
589 return msix_notify_if_unmasked(dev
, vector
, 1);
592 int msix_set_mask_notifier(PCIDevice
*dev
, msix_mask_notifier_func f
)
595 assert(!dev
->msix_mask_notifier
);
596 dev
->msix_mask_notifier
= f
;
597 for (n
= 0; n
< dev
->msix_entries_nr
; ++n
) {
598 r
= msix_set_mask_notifier_for_vector(dev
, n
);
607 msix_unset_mask_notifier_for_vector(dev
, n
);
609 dev
->msix_mask_notifier
= NULL
;
613 int msix_unset_mask_notifier(PCIDevice
*dev
)
616 assert(dev
->msix_mask_notifier
);
617 for (n
= 0; n
< dev
->msix_entries_nr
; ++n
) {
618 r
= msix_unset_mask_notifier_for_vector(dev
, n
);
623 dev
->msix_mask_notifier
= NULL
;
628 msix_set_mask_notifier_for_vector(dev
, n
);