[linux-2.6-block.git] / drivers / virtio / virtio_pci_common.h

#ifndef _DRIVERS_VIRTIO_VIRTIO_PCI_COMMON_H
#define _DRIVERS_VIRTIO_VIRTIO_PCI_COMMON_H
/*
 * Virtio PCI driver - APIs for common functionality for all device versions
 *
 * This module allows virtio devices to be used over a virtual PCI device.
 * This can be used with QEMU based VMMs like KVM or Xen.
 *
 * Copyright IBM Corp. 2007
 * Copyright Red Hat, Inc. 2014
 *
 * Authors:
 *  Anthony Liguori  <aliguori@us.ibm.com>
 *  Rusty Russell <rusty@rustcorp.com.au>
 *  Michael S. Tsirkin <mst@redhat.com>
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or later.
 * See the COPYING file in the top-level directory.
 *
 */

#include <linux/module.h>
#include <linux/list.h>
#include <linux/pci.h>
#include <linux/slab.h>
#include <linux/interrupt.h>
#include <linux/virtio.h>
#include <linux/virtio_config.h>
#include <linux/virtio_ring.h>
#include <linux/virtio_pci.h>
#include <linux/highmem.h>
#include <linux/spinlock.h>

struct virtio_pci_vq_info {
	/* the actual virtqueue */
	struct virtqueue *vq;

	/* the number of entries in the queue */
	int num;

	/* the virtual address of the ring queue */
	void *queue;

	/* the list node for the virtqueues list */
	struct list_head node;

	/* MSI-X vector (or none) */
	unsigned msix_vector;
};

/* Our device structure */
struct virtio_pci_device {
	struct virtio_device vdev;
	struct pci_dev *pci_dev;

	/* the IO mapping for the PCI config space */
	void __iomem *ioaddr;

	/* the IO mapping for ISR operation */
	void __iomem *isr;

	/* a list of queues so we can dispatch IRQs */
	spinlock_t lock;
	struct list_head virtqueues;

	/* array of all queues for house-keeping */
	struct virtio_pci_vq_info **vqs;

	/* MSI-X support */
	int msix_enabled;
	int intx_enabled;
	struct msix_entry *msix_entries;
	cpumask_var_t *msix_affinity_masks;
	/* Name strings for interrupts. This size should be enough,
	 * and I'm too lazy to allocate each name separately. */
	char (*msix_names)[256];
	/* Number of available vectors */
	unsigned msix_vectors;
	/* Vectors allocated, excluding per-vq vectors if any */
	unsigned msix_used_vectors;

	/* Whether we have vector per vq */
	bool per_vq_vectors;

	struct virtqueue *(*setup_vq)(struct virtio_pci_device *vp_dev,
				      struct virtio_pci_vq_info *info,
				      unsigned idx,
				      void (*callback)(struct virtqueue *vq),
				      const char *name,
				      u16 msix_vec);
	void (*del_vq)(struct virtio_pci_vq_info *info);

	u16 (*config_vector)(struct virtio_pci_device *vp_dev, u16 vector);
};

/* Constants for MSI-X */
/* Use first vector for configuration changes, second and the rest for
 * virtqueues Thus, we need at least 2 vectors for MSI. */
enum {
	VP_MSIX_CONFIG_VECTOR = 0,
	VP_MSIX_VQ_VECTOR = 1,
};

/* Convert a generic virtio device to our structure */
static struct virtio_pci_device *to_vp_device(struct virtio_device *vdev)
{
	return container_of(vdev, struct virtio_pci_device, vdev);
}

/* wait for pending irq handlers */
void vp_synchronize_vectors(struct virtio_device *vdev);
/* the notify function used when creating a virt queue */
bool vp_notify(struct virtqueue *vq);
/* the config->del_vqs() implementation */
void vp_del_vqs(struct virtio_device *vdev);
/* the config->find_vqs() implementation */
int vp_find_vqs(struct virtio_device *vdev, unsigned nvqs,
		       struct virtqueue *vqs[],
		       vq_callback_t *callbacks[],
		       const char *names[]);
const char *vp_bus_name(struct virtio_device *vdev);

/* Setup the affinity for a virtqueue:
 * - force the affinity for per vq vector
 * - OR over all affinities for shared MSI
 * - ignore the affinity request if we're using INTX
 */
int vp_set_vq_affinity(struct virtqueue *vq, int cpu);
void virtio_pci_release_dev(struct device *);

int virtio_pci_legacy_probe(struct pci_dev *pci_dev,
			    const struct pci_device_id *id);
void virtio_pci_legacy_remove(struct pci_dev *pci_dev);

#endif
Commit	Line	Data
5f4c9760 MT	1	#ifndef _DRIVERS_VIRTIO_VIRTIO_PCI_COMMON_H
5f4c9760 MT	2	#define _DRIVERS_VIRTIO_VIRTIO_PCI_COMMON_H
38eb4a29	3	/*
a90fdce9	4	* Virtio PCI driver - APIs for common functionality for all device versions
38eb4a29 MT	5	*
	6	* This module allows virtio devices to be used over a virtual PCI device.
	7	* This can be used with QEMU based VMMs like KVM or Xen.
	8	*
	9	* Copyright IBM Corp. 2007
a90fdce9	10	* Copyright Red Hat, Inc. 2014
38eb4a29 MT	11	*
	12	* Authors:
	13	* Anthony Liguori <aliguori@us.ibm.com>
a90fdce9 MT	14	* Rusty Russell <rusty@rustcorp.com.au>
a90fdce9 MT	15	* Michael S. Tsirkin <mst@redhat.com>
38eb4a29 MT	16	*
	17	* This work is licensed under the terms of the GNU GPL, version 2 or later.
	18	* See the COPYING file in the top-level directory.
	19	*
	20	*/
	21
	22	#include <linux/module.h>
	23	#include <linux/list.h>
	24	#include <linux/pci.h>
	25	#include <linux/slab.h>
	26	#include <linux/interrupt.h>
	27	#include <linux/virtio.h>
	28	#include <linux/virtio_config.h>
	29	#include <linux/virtio_ring.h>
38eb4a29 MT	30	#include <linux/virtio_pci.h>
	31	#include <linux/highmem.h>
	32	#include <linux/spinlock.h>
	33
	34	struct virtio_pci_vq_info {
	35	/* the actual virtqueue */
	36	struct virtqueue *vq;
	37
	38	/* the number of entries in the queue */
	39	int num;
	40
	41	/* the virtual address of the ring queue */
	42	void *queue;
	43
	44	/* the list node for the virtqueues list */
	45	struct list_head node;
	46
	47	/* MSI-X vector (or none) */
	48	unsigned msix_vector;
	49	};
	50
	51	/* Our device structure */
	52	struct virtio_pci_device {
	53	struct virtio_device vdev;
	54	struct pci_dev *pci_dev;
	55
	56	/* the IO mapping for the PCI config space */
	57	void __iomem *ioaddr;
	58
	59	/* the IO mapping for ISR operation */
	60	void __iomem *isr;
	61
	62	/* a list of queues so we can dispatch IRQs */
	63	spinlock_t lock;
	64	struct list_head virtqueues;
	65
	66	/* array of all queues for house-keeping */
	67	struct virtio_pci_vq_info **vqs;
	68
	69	/* MSI-X support */
	70	int msix_enabled;
	71	int intx_enabled;
	72	struct msix_entry *msix_entries;
	73	cpumask_var_t *msix_affinity_masks;
	74	/* Name strings for interrupts. This size should be enough,
	75	* and I'm too lazy to allocate each name separately. */
	76	char (*msix_names)[256];
	77	/* Number of available vectors */
	78	unsigned msix_vectors;
	79	/* Vectors allocated, excluding per-vq vectors if any */
	80	unsigned msix_used_vectors;
	81
	82	/* Whether we have vector per vq */
	83	bool per_vq_vectors;
	84
	85	struct virtqueue (setup_vq)(struct virtio_pci_device *vp_dev,
	86	struct virtio_pci_vq_info *info,
	87	unsigned idx,
	88	void (callback)(struct virtqueue vq),
	89	const char *name,
	90	u16 msix_vec);
	91	void (del_vq)(struct virtio_pci_vq_info info);
	92
	93	u16 (config_vector)(struct virtio_pci_device vp_dev, u16 vector);
94	};
95
96	/* Constants for MSI-X */
97	/* Use first vector for configuration changes, second and the rest for
98	* virtqueues Thus, we need at least 2 vectors for MSI. */
99	enum {
100	VP_MSIX_CONFIG_VECTOR = 0,
101	VP_MSIX_VQ_VECTOR = 1,
102	};
103
104	/* Convert a generic virtio device to our structure */
105	static struct virtio_pci_device to_vp_device(struct virtio_device vdev)
106	{
107	return container_of(vdev, struct virtio_pci_device, vdev);
108	}
109
110	/* wait for pending irq handlers */
111	void vp_synchronize_vectors(struct virtio_device *vdev);
112	/* the notify function used when creating a virt queue */
113	bool vp_notify(struct virtqueue *vq);
114	/* the config->del_vqs() implementation */
115	void vp_del_vqs(struct virtio_device *vdev);
116	/* the config->find_vqs() implementation */
117	int vp_find_vqs(struct virtio_device *vdev, unsigned nvqs,
118	struct virtqueue *vqs[],
119	vq_callback_t *callbacks[],
120	const char *names[]);
121	const char vp_bus_name(struct virtio_device vdev);
122
123	/* Setup the affinity for a virtqueue:
124	* - force the affinity for per vq vector
125	* - OR over all affinities for shared MSI
126	* - ignore the affinity request if we're using INTX
127	*/
128	int vp_set_vq_affinity(struct virtqueue *vq, int cpu);
129	void virtio_pci_release_dev(struct device *);
130
9a4253db MT	131	int virtio_pci_legacy_probe(struct pci_dev *pci_dev,
	132	const struct pci_device_id *id);
	133	void virtio_pci_legacy_remove(struct pci_dev *pci_dev);
38eb4a29 MT	134
38eb4a29 MT	135	#endif