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
36#ifndef _VIRTIO_PCI_LEGACY_VAR_H
37#define _VIRTIO_PCI_LEGACY_VAR_H
38
39#include <dev/virtio/pci/virtio_pci_var.h>
40
41/* VirtIO ABI version, this must match exactly. */
42#define VIRTIO_PCI_ABI_VERSION	0
43
44/*
45 * VirtIO Header, located in BAR 0.
46 */
47#define VIRTIO_PCI_HOST_FEATURES  0  /* host's supported features (32bit, RO)*/
48#define VIRTIO_PCI_GUEST_FEATURES 4  /* guest's supported features (32, RW) */
49#define VIRTIO_PCI_QUEUE_PFN      8  /* physical address of VQ (32, RW) */
50#define VIRTIO_PCI_QUEUE_NUM      12 /* number of ring entries (16, RO) */
51#define VIRTIO_PCI_QUEUE_SEL      14 /* current VQ selection (16, RW) */
52#define VIRTIO_PCI_QUEUE_NOTIFY	  16 /* notify host regarding VQ (16, RW) */
53#define VIRTIO_PCI_STATUS         18 /* device status register (8, RW) */
54#define VIRTIO_PCI_ISR            19 /* interrupt status register, reading
55				      * also clears the register (8, RO) */
56/* Only if MSIX is enabled: */
57#define VIRTIO_MSI_CONFIG_VECTOR  20 /* configuration change vector (16, RW) */
58#define VIRTIO_MSI_QUEUE_VECTOR   22 /* vector for selected VQ notifications
59					(16, RW) */
60
61/*
62 * The remaining space is defined by each driver as the per-driver
63 * configuration space.
64 */
65#define VIRTIO_PCI_CONFIG_OFF(msix_enabled)     ((msix_enabled) ? 24 : 20)
66
67/*
68 * How many bits to shift physical queue address written to QUEUE_PFN.
69 * 12 is historical, and due to x86 page size.
70 */
71#define VIRTIO_PCI_QUEUE_ADDR_SHIFT	12
72
73/* The alignment to use between consumer and producer parts of vring. */
74#define VIRTIO_PCI_VRING_ALIGN	4096
75
76#endif /* _VIRTIO_PCI_LEGACY_VAR_H */
77