virtio_pci.h revision 330897
1/*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright IBM Corp. 2007 5 * 6 * Authors: 7 * Anthony Liguori <aliguori@us.ibm.com> 8 * 9 * This header is BSD licensed so anyone can use the definitions to implement 10 * compatible drivers/servers. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. Neither the name of IBM nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 24 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 25 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 26 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 * 35 * $FreeBSD: stable/11/sys/dev/virtio/pci/virtio_pci.h 330897 2018-03-14 03:19:51Z eadler $ 36 */ 37 38#ifndef _VIRTIO_PCI_H 39#define _VIRTIO_PCI_H 40 41/* VirtIO PCI vendor/device ID. */ 42#define VIRTIO_PCI_VENDORID 0x1AF4 43#define VIRTIO_PCI_DEVICEID_MIN 0x1000 44#define VIRTIO_PCI_DEVICEID_MAX 0x103F 45 46/* VirtIO ABI version, this must match exactly. */ 47#define VIRTIO_PCI_ABI_VERSION 0 48 49/* 50 * VirtIO Header, located in BAR 0. 51 */ 52#define VIRTIO_PCI_HOST_FEATURES 0 /* host's supported features (32bit, RO)*/ 53#define VIRTIO_PCI_GUEST_FEATURES 4 /* guest's supported features (32, RW) */ 54#define VIRTIO_PCI_QUEUE_PFN 8 /* physical address of VQ (32, RW) */ 55#define VIRTIO_PCI_QUEUE_NUM 12 /* number of ring entries (16, RO) */ 56#define VIRTIO_PCI_QUEUE_SEL 14 /* current VQ selection (16, RW) */ 57#define VIRTIO_PCI_QUEUE_NOTIFY 16 /* notify host regarding VQ (16, RW) */ 58#define VIRTIO_PCI_STATUS 18 /* device status register (8, RW) */ 59#define VIRTIO_PCI_ISR 19 /* interrupt status register, reading 60 * also clears the register (8, RO) */ 61/* Only if MSIX is enabled: */ 62#define VIRTIO_MSI_CONFIG_VECTOR 20 /* configuration change vector (16, RW) */ 63#define VIRTIO_MSI_QUEUE_VECTOR 22 /* vector for selected VQ notifications 64 (16, RW) */ 65 66/* The bit of the ISR which indicates a device has an interrupt. */ 67#define VIRTIO_PCI_ISR_INTR 0x1 68/* The bit of the ISR which indicates a device configuration change. */ 69#define VIRTIO_PCI_ISR_CONFIG 0x2 70/* Vector value used to disable MSI for queue. */ 71#define VIRTIO_MSI_NO_VECTOR 0xFFFF 72 73/* 74 * The remaining space is defined by each driver as the per-driver 75 * configuration space. 76 */ 77#define VIRTIO_PCI_CONFIG_OFF(msix_enabled) ((msix_enabled) ? 24 : 20) 78 79/* 80 * How many bits to shift physical queue address written to QUEUE_PFN. 81 * 12 is historical, and due to x86 page size. 82 */ 83#define VIRTIO_PCI_QUEUE_ADDR_SHIFT 12 84 85/* The alignment to use between consumer and producer parts of vring. */ 86#define VIRTIO_PCI_VRING_ALIGN 4096 87 88#endif /* _VIRTIO_PCI_H */ 89