virtio_pci.h File Reference

#include "linux/types.h"
#include "linux/virtio_config.h"

Include dependency graph for virtio_pci.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	virtio_pci_cap
struct	virtio_pci_notify_cap
struct	virtio_pci_common_cfg
struct	virtio_queue_info
struct	virtio_system_ops
struct	virtio_device_ops
struct	virtio_device

Macros
#define	VIRTIO_PCI_HOST_FEATURES   0
#define	VIRTIO_PCI_GUEST_FEATURES   4
#define	VIRTIO_PCI_QUEUE_PFN   8
#define	VIRTIO_PCI_QUEUE_NUM   12
#define	VIRTIO_PCI_QUEUE_SEL   14
#define	VIRTIO_PCI_QUEUE_NOTIFY   16
#define	VIRTIO_PCI_STATUS   18
#define	VIRTIO_PCI_ISR   19
#define	VIRTIO_MSI_CONFIG_VECTOR   20
#define	VIRTIO_MSI_QUEUE_VECTOR   22
#define	VIRTIO_PCI_CONFIG_OFF(msix_enabled)   ((msix_enabled) ? 24 : 20)
#define	VIRTIO_PCI_CONFIG(msix_enabled)   VIRTIO_PCI_CONFIG_OFF(msix_enabled)
#define	VIRTIO_PCI_QUEUE_ADDR_SHIFT   12
#define	VIRTIO_PCI_VRING_ALIGN   4096
#define	VIRTIO_PCI_ISR_CONFIG   0x2
#define	VIRTIO_MSI_NO_VECTOR   0xffff
#define	VIRTIO_PCI_CAP_COMMON_CFG   1
#define	VIRTIO_PCI_CAP_NOTIFY_CFG   2
#define	VIRTIO_PCI_CAP_ISR_CFG   3
#define	VIRTIO_PCI_CAP_DEVICE_CFG   4
#define	VIRTIO_PCI_CAP_PCI_CFG   5
#define	MAX_QUEUES_PER_DEVICE_DEFAULT   8
#define	virtio_is_feature_enabled(FeaturesList, Feature)   (!!((FeaturesList) & (1ULL << (Feature))))
#define	virtio_feature_enable(FeaturesList, Feature)   ((FeaturesList) |= (1ULL << (Feature)))
#define	virtio_feature_disable(FeaturesList, Feature)   ((FeaturesList) &= ~(1ULL << (Feature)))

Typedefs
typedef struct virtio_queue_info	VirtIOQueueInfo
typedef struct virtio_system_ops	VirtIOSystemOps
typedef struct virtio_device	VirtIODevice

Functions
NTSTATUS	virtio_device_initialize (VirtIODevice *vdev, const VirtIOSystemOps *pSystemOps, void *DeviceContext, bool msix_used)
void	virtio_device_shutdown (VirtIODevice *vdev)
u8	virtio_get_status (VirtIODevice *vdev)
void	virtio_set_status (VirtIODevice *vdev, u8 status)
void	virtio_add_status (VirtIODevice *vdev, u8 status)
void	virtio_device_reset (VirtIODevice *vdev)
void	virtio_device_ready (VirtIODevice *vdev)
u64	virtio_get_features (VirtIODevice *dev)
NTSTATUS	virtio_set_features (VirtIODevice *vdev, u64 features)
void	virtio_get_config (VirtIODevice *vdev, unsigned offset, void *buf, unsigned len)
void	virtio_set_config (VirtIODevice *vdev, unsigned offset, void *buf, unsigned len)
NTSTATUS	virtio_query_queue_allocation (VirtIODevice *vdev, unsigned index, unsigned short *pNumEntries, unsigned long *pRingSize, unsigned long *pHeapSize)
NTSTATUS	virtio_reserve_queue_memory (VirtIODevice *vdev, unsigned nvqs)
NTSTATUS	virtio_find_queue (VirtIODevice *vdev, unsigned index, struct virtqueue **vq)
NTSTATUS	virtio_find_queues (VirtIODevice *vdev, unsigned nvqs, struct virtqueue *vqs[])
void	virtio_delete_queue (struct virtqueue *vq)
void	virtio_delete_queues (VirtIODevice *vdev)
u32	virtio_get_queue_size (struct virtqueue *vq)
unsigned long	virtio_get_indirect_page_capacity ()
static ULONG FORCEINLINE	virtio_get_queue_descriptor_size ()
u16	virtio_set_config_vector (VirtIODevice *vdev, u16 vector)
u16	virtio_set_queue_vector (struct virtqueue *vq, u16 vector)
u8	virtio_read_isr_status (VirtIODevice *vdev)
int	virtio_get_bar_index (PPCI_COMMON_HEADER pPCIHeader, PHYSICAL_ADDRESS BasePA)

Macro Definition Documentation

MAX_QUEUES_PER_DEVICE_DEFAULT

#define MAX_QUEUES_PER_DEVICE_DEFAULT   8

Definition at line 156 of file virtio_pci.h.

virtio_feature_disable

#define virtio_feature_disable	(		FeaturesList,
			Feature
	)		((FeaturesList) &= ~(1ULL << (Feature)))

Definition at line 313 of file virtio_pci.h.

virtio_feature_enable

#define virtio_feature_enable	(		FeaturesList,
			Feature
	)		((FeaturesList) |= (1ULL << (Feature)))

Definition at line 312 of file virtio_pci.h.

virtio_is_feature_enabled

#define virtio_is_feature_enabled	(		FeaturesList,
			Feature
	)		(!!((FeaturesList) & (1ULL << (Feature))))

Definition at line 311 of file virtio_pci.h.

VIRTIO_MSI_CONFIG_VECTOR

#define VIRTIO_MSI_CONFIG_VECTOR   20

Definition at line 75 of file virtio_pci.h.

VIRTIO_MSI_NO_VECTOR

#define VIRTIO_MSI_NO_VECTOR   0xffff

Definition at line 98 of file virtio_pci.h.

VIRTIO_MSI_QUEUE_VECTOR

#define VIRTIO_MSI_QUEUE_VECTOR   22

Definition at line 77 of file virtio_pci.h.

VIRTIO_PCI_CAP_COMMON_CFG

#define VIRTIO_PCI_CAP_COMMON_CFG   1

Definition at line 103 of file virtio_pci.h.

VIRTIO_PCI_CAP_DEVICE_CFG

#define VIRTIO_PCI_CAP_DEVICE_CFG   4

Definition at line 109 of file virtio_pci.h.

VIRTIO_PCI_CAP_ISR_CFG

#define VIRTIO_PCI_CAP_ISR_CFG   3

Definition at line 107 of file virtio_pci.h.

VIRTIO_PCI_CAP_NOTIFY_CFG

#define VIRTIO_PCI_CAP_NOTIFY_CFG   2

Definition at line 105 of file virtio_pci.h.

VIRTIO_PCI_CAP_PCI_CFG

#define VIRTIO_PCI_CAP_PCI_CFG   5

Definition at line 111 of file virtio_pci.h.

VIRTIO_PCI_CONFIG

#define VIRTIO_PCI_CONFIG

(

msix_enabled

)

VIRTIO_PCI_CONFIG_OFF(msix_enabled)

Definition at line 83 of file virtio_pci.h.

VIRTIO_PCI_CONFIG_OFF

#define VIRTIO_PCI_CONFIG_OFF

(

msix_enabled

)

((msix_enabled) ? 24 : 20)

Definition at line 81 of file virtio_pci.h.

VIRTIO_PCI_GUEST_FEATURES

#define VIRTIO_PCI_GUEST_FEATURES   4

Definition at line 51 of file virtio_pci.h.

VIRTIO_PCI_HOST_FEATURES

#define VIRTIO_PCI_HOST_FEATURES   0

Definition at line 48 of file virtio_pci.h.

VIRTIO_PCI_ISR

#define VIRTIO_PCI_ISR   19

Definition at line 71 of file virtio_pci.h.

VIRTIO_PCI_ISR_CONFIG

#define VIRTIO_PCI_ISR_CONFIG   0x2

Definition at line 96 of file virtio_pci.h.

VIRTIO_PCI_QUEUE_ADDR_SHIFT

#define VIRTIO_PCI_QUEUE_ADDR_SHIFT   12

Definition at line 87 of file virtio_pci.h.

VIRTIO_PCI_QUEUE_NOTIFY

#define VIRTIO_PCI_QUEUE_NOTIFY   16

Definition at line 63 of file virtio_pci.h.

VIRTIO_PCI_QUEUE_NUM

#define VIRTIO_PCI_QUEUE_NUM   12

Definition at line 57 of file virtio_pci.h.

VIRTIO_PCI_QUEUE_PFN

#define VIRTIO_PCI_QUEUE_PFN   8

Definition at line 54 of file virtio_pci.h.

VIRTIO_PCI_QUEUE_SEL

#define VIRTIO_PCI_QUEUE_SEL   14

Definition at line 60 of file virtio_pci.h.

VIRTIO_PCI_STATUS

#define VIRTIO_PCI_STATUS   18

Definition at line 66 of file virtio_pci.h.

VIRTIO_PCI_VRING_ALIGN

#define VIRTIO_PCI_VRING_ALIGN   4096

Definition at line 91 of file virtio_pci.h.

Typedef Documentation

VirtIODevice

typedef struct virtio_device VirtIODevice

Definition at line 199 of file virtio_pci.h.

VirtIOQueueInfo

typedef struct virtio_queue_info VirtIOQueueInfo

VirtIOSystemOps

typedef struct virtio_system_ops VirtIOSystemOps

Function Documentation

virtio_add_status()

void virtio_add_status	(	VirtIODevice *	vdev,
		u8	status
	)

Definition at line 96 of file VirtIOPCICommon.c.

{
    vdev->device->set_status(vdev, (u8)(vdev->device->get_status(vdev) | status));
}

Referenced by ParaNdis_FinishInitialization(), ParaNdis_InitializeContext(), ParaNdis_PowerOn(), virtio_device_initialize(), and virtio_set_features().

virtio_delete_queue()

void virtio_delete_queue

(

struct virtqueue *

vq

)

Definition at line 311 of file VirtIOPCICommon.c.

{
    VirtIODevice *vdev = vq->vdev;
    unsigned i = vq->index;
 
    vdev->device->delete_queue(&vdev->info[i]);
    vdev->info[i].vq = NULL;
}

virtio_delete_queues()

void virtio_delete_queues

(

VirtIODevice *

vdev

)

Definition at line 320 of file VirtIOPCICommon.c.

{
    struct virtqueue *vq;
    unsigned i;
 
    if (vdev->info == NULL)
        return;
 
    for (i = 0; i < vdev->maxQueues; i++) {
        vq = vdev->info[i].vq;
        if (vq != NULL) {
            vdev->device->delete_queue(&vdev->info[i]);
            vdev->info[i].vq = NULL;
        }
    }
}

Referenced by DeleteNetQueues(), and virtio_find_queues().

virtio_device_initialize()

NTSTATUS virtio_device_initialize	(	VirtIODevice *	vdev,
		const VirtIOSystemOps *	pSystemOps,
		void *	DeviceContext,
		bool	msix_used
	)

Referenced by ParaNdis_InitializeContext().

virtio_device_ready()

void virtio_device_ready

(

VirtIODevice *

vdev

)

Definition at line 106 of file VirtIOPCICommon.c.

{
    unsigned status = vdev->device->get_status(vdev);
 
    ASSERT(!(status & VIRTIO_CONFIG_S_DRIVER_OK));
    vdev->device->set_status(vdev, (u8)(status | VIRTIO_CONFIG_S_DRIVER_OK));
}

Referenced by ParaNdis_FinishInitialization(), and ParaNdis_PowerOn().

virtio_device_reset()

void virtio_device_reset

(

VirtIODevice *

vdev

)

Definition at line 101 of file VirtIOPCICommon.c.

{
    vdev->device->reset(vdev);
}

Referenced by ParaNdis_ResetVirtIONetDevice(), and virtio_device_initialize().

virtio_device_shutdown()

void virtio_device_shutdown

(

VirtIODevice *

vdev

)

Definition at line 77 of file VirtIOPCICommon.c.

{
    if (vdev->info &&
        vdev->info != vdev->inline_info) {
        mem_free_nonpaged_block(vdev, vdev->info);
        vdev->info = NULL;
    }
}

Referenced by VirtIONetRelease().

virtio_find_queue()

NTSTATUS virtio_find_queue	(	VirtIODevice *	vdev,
		unsigned	index,
		struct virtqueue **	vq
	)

Definition at line 256 of file VirtIOPCICommon.c.

{
    u16 msix_vec = vdev_get_msix_vector(vdev, index);
    return vp_setup_vq(
        vq,
        vdev,
        index,
        msix_vec);
}

virtio_find_queues()

NTSTATUS virtio_find_queues	(	VirtIODevice *	vdev,
		unsigned	nvqs,
		struct virtqueue *	vqs[]
	)

Definition at line 267 of file VirtIOPCICommon.c.

{
    unsigned i;
    NTSTATUS status;
    u16 msix_vec;
 
    status = virtio_reserve_queue_memory(vdev, nvqs);
    if (!NT_SUCCESS(status)) {
        return status;
    }
 
    /* set up the device config interrupt */
    msix_vec = vdev_get_msix_vector(vdev, -1);
 
    if (msix_vec != VIRTIO_MSI_NO_VECTOR) {
        msix_vec = vdev->device->set_config_vector(vdev, msix_vec);
        /* Verify we had enough resources to assign the vector */
        if (msix_vec == VIRTIO_MSI_NO_VECTOR) {
            status = STATUS_DEVICE_BUSY;
            goto error_find;
        }
    }
 
    /* set up queue interrupts */
    for (i = 0; i < nvqs; i++) {
        msix_vec = vdev_get_msix_vector(vdev, i);
        status = vp_setup_vq(
            &vqs[i],
            vdev,
            i,
            msix_vec);
        if (!NT_SUCCESS(status)) {
            goto error_find;
        }
    }
    return STATUS_SUCCESS;
 
error_find:
    virtio_delete_queues(vdev);
    return status;
}

Referenced by FindNetQueues().

virtio_get_bar_index()

int virtio_get_bar_index	(	PPCI_COMMON_HEADER	pPCIHeader,
		PHYSICAL_ADDRESS	BasePA
	)

Definition at line 357 of file VirtIOPCICommon.c.

{
    int iBar, i;
 
    /* no point in supporting PCI and CardBus bridges */
    ASSERT((pPCIHeader->HeaderType & ~PCI_MULTIFUNCTION) == PCI_DEVICE_TYPE);
 
    for (i = 0; i < PCI_TYPE0_ADDRESSES; i++) {
        PHYSICAL_ADDRESS BAR;
        BAR.LowPart = pPCIHeader->u.type0.BaseAddresses[i];
 
        iBar = i;
        if (BAR.LowPart & PCI_ADDRESS_IO_SPACE) {
            /* I/O space */
            BAR.LowPart &= PCI_ADDRESS_IO_ADDRESS_MASK;
            BAR.HighPart = 0;
        } else if ((BAR.LowPart & PCI_ADDRESS_MEMORY_TYPE_MASK) == PCI_TYPE_64BIT) {
            /* memory space 64-bit */
            BAR.LowPart &= PCI_ADDRESS_MEMORY_ADDRESS_MASK;
            BAR.HighPart = pPCIHeader->u.type0.BaseAddresses[++i];
        } else {
            /* memory space 32-bit */
            BAR.LowPart &= PCI_ADDRESS_MEMORY_ADDRESS_MASK;
            BAR.HighPart = 0;
        }
 
        if (BAR.QuadPart == BasePA.QuadPart) {
            return iBar;
        }
    }
    return -1;
}

Referenced by GetAdapterResources().

virtio_get_config()

void virtio_get_config	(	VirtIODevice *	vdev,
		unsigned	offset,
		void *	buf,
		unsigned	len
	)

Definition at line 167 of file VirtIOPCICommon.c.

{
    switch (len) {
    case 1:
    case 2:
    case 4:
        vdev->device->get_config(vdev, offset, buf, len);
        break;
    case 8:
        virtio_cread_many(vdev, offset, buf, 2, sizeof(u32));
        break;
    default:
        virtio_cread_many(vdev, offset, buf, len, 1);
        break;
    }
}

Referenced by ParaNdis_InitializeContext(), and ParaNdis_ReportLinkStatus().

virtio_get_features()

u64 virtio_get_features

(

VirtIODevice *

dev

)

Definition at line 114 of file VirtIOPCICommon.c.

{
    return vdev->device->get_features(vdev);
}

Referenced by ParaNdis_InitializeContext(), and ParaNdis_PowerOn().

virtio_get_indirect_page_capacity()

unsigned long virtio_get_indirect_page_capacity

(

)

Definition at line 550 of file VirtIORing.c.

{
    return PAGE_SIZE / sizeof(struct vring_desc);
}

virtio_get_queue_descriptor_size()

static ULONG FORCEINLINE virtio_get_queue_descriptor_size ( )

static

Definition at line 366 of file virtio_pci.h.

{
    return sizeof(VirtIOQueueInfo);
}

Referenced by virtio_reserve_queue_memory().

virtio_get_queue_size()

u32 virtio_get_queue_size

(

struct virtqueue *

vq

)

Definition at line 337 of file VirtIOPCICommon.c.

{
    return vq->vdev->info[vq->index].num;
}

Referenced by PrepareTransmitBuffers().

virtio_get_status()

u8 virtio_get_status

(

VirtIODevice *

vdev

)

Definition at line 86 of file VirtIOPCICommon.c.

{
    return vdev->device->get_status(vdev);
}

Referenced by ParaNdis_ResetVirtIONetDevice(), and VirtIODeviceRemoveStatus().

virtio_query_queue_allocation()

NTSTATUS virtio_query_queue_allocation	(	VirtIODevice *	vdev,
		unsigned	index,
		unsigned short *	pNumEntries,
		unsigned long *	pRingSize,
		unsigned long *	pHeapSize
	)

Definition at line 215 of file VirtIOPCICommon.c.

{
    return vdev->device->query_queue_alloc(vdev, index, pNumEntries, pRingSize, pHeapSize);
}

virtio_read_isr_status()

u8 virtio_read_isr_status

(

VirtIODevice *

vdev

)

Definition at line 352 of file VirtIOPCICommon.c.

{
    return ioread8(vdev, vdev->isr);
}

Referenced by CheckRunningDpc(), JustForCheckClearInterrupt(), and ParaNdis_OnLegacyInterrupt().

virtio_reserve_queue_memory()

NTSTATUS virtio_reserve_queue_memory	(	VirtIODevice *	vdev,
		unsigned	nvqs
	)

Definition at line 224 of file VirtIOPCICommon.c.

{
    if (nvqs > vdev->maxQueues) {
        /* allocate new space for queue infos */
        void *new_info = mem_alloc_nonpaged_block(vdev, nvqs * virtio_get_queue_descriptor_size());
        if (!new_info) {
            return STATUS_INSUFFICIENT_RESOURCES;
        }
 
        if (vdev->info && vdev->info != vdev->inline_info) {
            mem_free_nonpaged_block(vdev, vdev->info);
        }
        vdev->info = new_info;
        vdev->maxQueues = nvqs;
    }
    return STATUS_SUCCESS;
}

Referenced by virtio_find_queues().

virtio_set_config()

void virtio_set_config	(	VirtIODevice *	vdev,
		unsigned	offset,
		void *	buf,
		unsigned	len
	)

Definition at line 197 of file VirtIOPCICommon.c.

{
    switch (len) {
    case 1:
    case 2:
    case 4:
        vdev->device->set_config(vdev, offset, buf, len);
        break;
    case 8:
        virtio_cwrite_many(vdev, offset, buf, 2, sizeof(u32));
        break;
    default:
        virtio_cwrite_many(vdev, offset, buf, len, 1);
        break;
    }
}

virtio_set_config_vector()

u16 virtio_set_config_vector	(	VirtIODevice *	vdev,
		u16	vector
	)

Definition at line 342 of file VirtIOPCICommon.c.

{
    return vdev->device->set_config_vector(vdev, vector);
}

virtio_set_features()

NTSTATUS virtio_set_features	(	VirtIODevice *	vdev,
		u64	features
	)

Definition at line 119 of file VirtIOPCICommon.c.

{
    unsigned char dev_status;
    NTSTATUS status;
 
    vdev->event_suppression_enabled = virtio_is_feature_enabled(features, VIRTIO_RING_F_EVENT_IDX);
    vdev->packed_ring = virtio_is_feature_enabled(features, VIRTIO_F_RING_PACKED);
 
    status = vdev->device->set_features(vdev, features);
    if (!NT_SUCCESS(status)) {
        return status;
    }
 
    if (!virtio_is_feature_enabled(features, VIRTIO_F_VERSION_1)) {
        return status;
    }
 
    virtio_add_status(vdev, VIRTIO_CONFIG_S_FEATURES_OK);
    dev_status = vdev->device->get_status(vdev);
    if (!(dev_status & VIRTIO_CONFIG_S_FEATURES_OK)) {
        DPrintf(0, "virtio: device refuses features: %x\n", dev_status);
        status = STATUS_INVALID_PARAMETER;
    }
    return status;
}

Referenced by FinalizeFeatures().

virtio_set_queue_vector()

u16 virtio_set_queue_vector	(	struct virtqueue *	vq,
		u16	vector
	)

Definition at line 347 of file VirtIOPCICommon.c.

{
    return vq->vdev->device->set_queue_vector(vq, vector);
}

virtio_set_status()

void virtio_set_status	(	VirtIODevice *	vdev,
		u8	status
	)

Definition at line 91 of file VirtIOPCICommon.c.

{
    vdev->device->set_status(vdev, status);
}

Referenced by VirtIODeviceRemoveStatus().