/* SPDX-License-Identifier: GPL-2.0 */ #ifndef _LINUX_VIRTIO_CONFIG_H #define _LINUX_VIRTIO_CONFIG_H #include <linux/err.h> #include <linux/bug.h> #include <linux/virtio.h> #include <linux/virtio_byteorder.h> #include <linux/compiler_types.h> #include <uapi/linux/virtio_config.h> struct irq_affinity; struct virtio_shm_region { … }; vq_callback_t; /** * struct virtqueue_info - Info for a virtqueue passed to find_vqs(). * @name: virtqueue description. Used mainly for debugging, NULL for * a virtqueue unused by the driver. * @callback: A callback to invoke on a used buffer notification. * NULL for a virtqueue that does not need a callback. * @ctx: A flag to indicate to maintain an extra context per virtqueue. */ struct virtqueue_info { … }; /** * struct virtio_config_ops - operations for configuring a virtio device * Note: Do not assume that a transport implements all of the operations * getting/setting a value as a simple read/write! Generally speaking, * any of @get/@set, @get_status/@set_status, or @get_features/ * @finalize_features are NOT safe to be called from an atomic * context. * @get: read the value of a configuration field * vdev: the virtio_device * offset: the offset of the configuration field * buf: the buffer to write the field value into. * len: the length of the buffer * @set: write the value of a configuration field * vdev: the virtio_device * offset: the offset of the configuration field * buf: the buffer to read the field value from. * len: the length of the buffer * @generation: config generation counter (optional) * vdev: the virtio_device * Returns the config generation counter * @get_status: read the status byte * vdev: the virtio_device * Returns the status byte * @set_status: write the status byte * vdev: the virtio_device * status: the new status byte * @reset: reset the device * vdev: the virtio device * After this, status and feature negotiation must be done again * Device must not be reset from its vq/config callbacks, or in * parallel with being added/removed. * @find_vqs: find virtqueues and instantiate them. * vdev: the virtio_device * nvqs: the number of virtqueues to find * vqs: on success, includes new virtqueues * vqs_info: array of virtqueue info structures * Returns 0 on success or error status * @del_vqs: free virtqueues found by find_vqs(). * @synchronize_cbs: synchronize with the virtqueue callbacks (optional) * The function guarantees that all memory operations on the * queue before it are visible to the vring_interrupt() that is * called after it. * vdev: the virtio_device * @get_features: get the array of feature bits for this device. * vdev: the virtio_device * Returns the first 64 feature bits (all we currently need). * @finalize_features: confirm what device features we'll be using. * vdev: the virtio_device * This sends the driver feature bits to the device: it can change * the dev->feature bits if it wants. * Note that despite the name this can be called any number of * times. * Returns 0 on success or error status * @bus_name: return the bus name associated with the device (optional) * vdev: the virtio_device * This returns a pointer to the bus name a la pci_name from which * the caller can then copy. * @set_vq_affinity: set the affinity for a virtqueue (optional). * @get_vq_affinity: get the affinity for a virtqueue (optional). * @get_shm_region: get a shared memory region based on the index. * @disable_vq_and_reset: reset a queue individually (optional). * vq: the virtqueue * Returns 0 on success or error status * disable_vq_and_reset will guarantee that the callbacks are disabled and * synchronized. * Except for the callback, the caller should guarantee that the vring is * not accessed by any functions of virtqueue. * @enable_vq_after_reset: enable a reset queue * vq: the virtqueue * Returns 0 on success or error status * If disable_vq_and_reset is set, then enable_vq_after_reset must also be * set. */ struct virtio_config_ops { … }; /* If driver didn't advertise the feature, it will never appear. */ void virtio_check_driver_offered_feature(const struct virtio_device *vdev, unsigned int fbit); /** * __virtio_test_bit - helper to test feature bits. For use by transports. * Devices should normally use virtio_has_feature, * which includes more checks. * @vdev: the device * @fbit: the feature bit */ static inline bool __virtio_test_bit(const struct virtio_device *vdev, unsigned int fbit) { … } /** * __virtio_set_bit - helper to set feature bits. For use by transports. * @vdev: the device * @fbit: the feature bit */ static inline void __virtio_set_bit(struct virtio_device *vdev, unsigned int fbit) { … } /** * __virtio_clear_bit - helper to clear feature bits. For use by transports. * @vdev: the device * @fbit: the feature bit */ static inline void __virtio_clear_bit(struct virtio_device *vdev, unsigned int fbit) { … } /** * virtio_has_feature - helper to determine if this device has this feature. * @vdev: the device * @fbit: the feature bit */ static inline bool virtio_has_feature(const struct virtio_device *vdev, unsigned int fbit) { … } /** * virtio_has_dma_quirk - determine whether this device has the DMA quirk * @vdev: the device */ static inline bool virtio_has_dma_quirk(const struct virtio_device *vdev) { … } static inline int virtio_find_vqs(struct virtio_device *vdev, unsigned int nvqs, struct virtqueue *vqs[], struct virtqueue_info vqs_info[], struct irq_affinity *desc) { … } static inline struct virtqueue *virtio_find_single_vq(struct virtio_device *vdev, vq_callback_t *c, const char *n) { … } /** * virtio_synchronize_cbs - synchronize with virtqueue callbacks * @dev: the virtio device */ static inline void virtio_synchronize_cbs(struct virtio_device *dev) { … } /** * virtio_device_ready - enable vq use in probe function * @dev: the virtio device * * Driver must call this to use vqs in the probe function. * * Note: vqs are enabled automatically after probe returns. */ static inline void virtio_device_ready(struct virtio_device *dev) { … } static inline const char *virtio_bus_name(struct virtio_device *vdev) { … } /** * virtqueue_set_affinity - setting affinity for a virtqueue * @vq: the virtqueue * @cpu_mask: the cpu mask * * Pay attention the function are best-effort: the affinity hint may not be set * due to config support, irq type and sharing. * */ static inline int virtqueue_set_affinity(struct virtqueue *vq, const struct cpumask *cpu_mask) { … } static inline bool virtio_get_shm_region(struct virtio_device *vdev, struct virtio_shm_region *region, u8 id) { … } static inline bool virtio_is_little_endian(struct virtio_device *vdev) { … } /* Memory accessors */ static inline u16 virtio16_to_cpu(struct virtio_device *vdev, __virtio16 val) { … } static inline __virtio16 cpu_to_virtio16(struct virtio_device *vdev, u16 val) { … } static inline u32 virtio32_to_cpu(struct virtio_device *vdev, __virtio32 val) { … } static inline __virtio32 cpu_to_virtio32(struct virtio_device *vdev, u32 val) { … } static inline u64 virtio64_to_cpu(struct virtio_device *vdev, __virtio64 val) { … } static inline __virtio64 cpu_to_virtio64(struct virtio_device *vdev, u64 val) { … } #define virtio_to_cpu(vdev, x) … #define cpu_to_virtio(vdev, x, m) … #define __virtio_native_type(structname, member) … /* Config space accessors. */ #define virtio_cread(vdev, structname, member, ptr) … /* Config space accessors. */ #define virtio_cwrite(vdev, structname, member, ptr) … /* * Nothing virtio-specific about these, but let's worry about generalizing * these later. */ #define virtio_le_to_cpu(x) … #define virtio_cpu_to_le(x, m) … /* LE (e.g. modern) Config space accessors. */ #define virtio_cread_le(vdev, structname, member, ptr) … #define virtio_cwrite_le(vdev, structname, member, ptr) … /* Read @count fields, @bytes each. */ static inline void __virtio_cread_many(struct virtio_device *vdev, unsigned int offset, void *buf, size_t count, size_t bytes) { … } static inline void virtio_cread_bytes(struct virtio_device *vdev, unsigned int offset, void *buf, size_t len) { … } static inline u8 virtio_cread8(struct virtio_device *vdev, unsigned int offset) { … } static inline void virtio_cwrite8(struct virtio_device *vdev, unsigned int offset, u8 val) { … } static inline u16 virtio_cread16(struct virtio_device *vdev, unsigned int offset) { … } static inline void virtio_cwrite16(struct virtio_device *vdev, unsigned int offset, u16 val) { … } static inline u32 virtio_cread32(struct virtio_device *vdev, unsigned int offset) { … } static inline void virtio_cwrite32(struct virtio_device *vdev, unsigned int offset, u32 val) { … } static inline u64 virtio_cread64(struct virtio_device *vdev, unsigned int offset) { … } static inline void virtio_cwrite64(struct virtio_device *vdev, unsigned int offset, u64 val) { … } /* Conditional config space accessors. */ #define virtio_cread_feature(vdev, fbit, structname, member, ptr) … /* Conditional config space accessors. */ #define virtio_cread_le_feature(vdev, fbit, structname, member, ptr) … #endif /* _LINUX_VIRTIO_CONFIG_H */
Codebase Browser
linux