msi.h revision 0b3b01870e655dcc6d81d895331243af358ba6f3
/** @file
* MSI - Message signalled interrupts support.
*/
/*
* Copyright (C) 2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___VBox_msi_h
#define ___VBox_msi_h
#include <VBox/cdefs.h>
#include <VBox/types.h>
#include <iprt/assert.h>
#include <VBox/pci.h>
/* Constants for Intel APIC MSI messages */
#define VBOX_MSI_DATA_VECTOR_SHIFT 0
#define VBOX_MSI_DATA_VECTOR_MASK 0x000000ff
#define VBOX_MSI_DATA_VECTOR(v) (((v) << VBOX_MSI_DATA_VECTOR_SHIFT) & \
VBOX_MSI_DATA_VECTOR_MASK)
#define VBOX_MSI_DATA_DELIVERY_MODE_SHIFT 8
#define VBOX_MSI_DATA_DELIVERY_FIXED (0 << VBOX_MSI_DATA_DELIVERY_MODE_SHIFT)
#define VBOX_MSI_DATA_DELIVERY_LOWPRI (1 << VBOX_MSI_DATA_DELIVERY_MODE_SHIFT)
#define VBOX_MSI_DATA_LEVEL_SHIFT 14
#define VBOX_MSI_DATA_LEVEL_DEASSERT (0 << VBOX_MSI_DATA_LEVEL_SHIFT)
#define VBOX_MSI_DATA_LEVEL_ASSERT (1 << VBOX_MSI_DATA_LEVEL_SHIFT)
#define VBOX_MSI_DATA_TRIGGER_SHIFT 15
#define VBOX_MSI_DATA_TRIGGER_EDGE (0 << VBOX_MSI_DATA_TRIGGER_SHIFT)
#define VBOX_MSI_DATA_TRIGGER_LEVEL (1 << VBOX_MSI_DATA_TRIGGER_SHIFT)
/**
* MSI region, actually same as LAPIC MMIO region, but listens on bus,
* not CPU, accesses.
*/
#define VBOX_MSI_ADDR_BASE 0xfee00000
#define VBOX_MSI_ADDR_SIZE 0x100000
#define VBOX_MSI_ADDR_DEST_MODE_SHIFT 2
#define VBOX_MSI_ADDR_DEST_MODE_PHYSICAL (0 << VBOX_MSI_ADDR_DEST_MODE_SHIFT)
#define VBOX_MSI_ADDR_DEST_MODE_LOGICAL (1 << VBOX_MSI_ADDR_DEST_MODE_SHIFT)
#define VBOX_MSI_ADDR_REDIRECTION_SHIFT 3
#define VBOX_MSI_ADDR_REDIRECTION_CPU (0 << VBOX_MSI_ADDR_REDIRECTION_SHIFT)
/* dedicated cpu */
#define VBOX_MSI_ADDR_REDIRECTION_LOWPRI (1 << VBOX_MSI_ADDR_REDIRECTION_SHIFT)
/* lowest priority */
#define VBOX_MSI_ADDR_DEST_ID_SHIFT 12
#define VBOX_MSI_ADDR_DEST_ID_MASK 0x00ffff0
#define VBOX_MSI_ADDR_DEST_ID(dest) (((dest) << VBOX_MSI_ADDR_DEST_ID_SHIFT) & \
VBOX_MSI_ADDR_DEST_ID_MASK)
#define VBOX_MSI_ADDR_EXT_DEST_ID(dest) ((dest) & 0xffffff00)
#define VBOX_MSI_ADDR_IR_EXT_INT (1 << 4)
#define VBOX_MSI_ADDR_IR_SHV (1 << 3)
#define VBOX_MSI_ADDR_IR_INDEX1(index) ((index & 0x8000) >> 13)
#define VBOX_MSI_ADDR_IR_INDEX2(index) ((index & 0x7fff) << 5)
/* Maximum number of vectors, per device/function */
#define VBOX_MSI_MAX_ENTRIES 32
/* Offsets in MSI PCI capability structure (VBOX_PCI_CAP_ID_MSI) */
#define VBOX_MSI_CAP_MESSAGE_CONTROL 0x02
#define VBOX_MSI_CAP_MESSAGE_ADDRESS_32 0x04
#define VBOX_MSI_CAP_MESSAGE_ADDRESS_LO 0x04
#define VBOX_MSI_CAP_MESSAGE_ADDRESS_HI 0x08
#define VBOX_MSI_CAP_MESSAGE_DATA_32 0x08
#define VBOX_MSI_CAP_MESSAGE_DATA_64 0x0c
#define VBOX_MSI_CAP_MASK_BITS_32 0x0c
#define VBOX_MSI_CAP_PENDING_BITS_32 0x10
#define VBOX_MSI_CAP_MASK_BITS_64 0x10
#define VBOX_MSI_CAP_PENDING_BITS_64 0x14
/* We implement MSI with per-vector masking */
#define VBOX_MSI_CAP_SIZE_32 0x14
#define VBOX_MSI_CAP_SIZE_64 0x18
/**
* MSI-X different from MSI by the fact that dedicated physical page
* (in device memory) is assigned for MSI-X table, and Pending Bit Array (PBA),
* which is recommended to be separated from the main table by at least 2K.
*/
/* Size of a MSI-X page */
#define VBOX_MSIX_PAGE_SIZE 0x1000
/* Pending interrupts (PBA) */
#define VBOX_MSIX_PAGE_PENDING (VBOX_MSIX_PAGE_SIZE / 2)
/* Maximum number of vectors, per device/function */
#define VBOX_MSIX_MAX_ENTRIES 32
#define VBOX_MSIX_ENTRY_SIZE 16
#endif