1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright (C) 2013 - Virtual Open Systems 4 * Author: Antonios Motakis <a.motakis@virtualopensystems.com> 5 */ 6 7 #ifndef VFIO_PLATFORM_PRIVATE_H 8 #define VFIO_PLATFORM_PRIVATE_H 9 10 #include <linux/types.h> 11 #include <linux/interrupt.h> 12 #include <linux/vfio.h> 13 14 #define VFIO_PLATFORM_OFFSET_SHIFT 40 15 #define VFIO_PLATFORM_OFFSET_MASK (((u64)(1) << VFIO_PLATFORM_OFFSET_SHIFT) - 1) 16 17 #define VFIO_PLATFORM_OFFSET_TO_INDEX(off) \ 18 (off >> VFIO_PLATFORM_OFFSET_SHIFT) 19 20 #define VFIO_PLATFORM_INDEX_TO_OFFSET(index) \ 21 ((u64)(index) << VFIO_PLATFORM_OFFSET_SHIFT) 22 23 struct vfio_platform_irq { 24 u32 flags; 25 u32 count; 26 int hwirq; 27 char *name; 28 struct eventfd_ctx *trigger; 29 bool masked; 30 spinlock_t lock; 31 struct virqfd *unmask; 32 struct virqfd *mask; 33 }; 34 35 struct vfio_platform_region { 36 u64 addr; 37 resource_size_t size; 38 u32 flags; 39 u32 type; 40 #define VFIO_PLATFORM_REGION_TYPE_MMIO 1 41 #define VFIO_PLATFORM_REGION_TYPE_PIO 2 42 void __iomem *ioaddr; 43 }; 44 45 struct vfio_platform_device { 46 struct vfio_device vdev; 47 struct vfio_platform_region *regions; 48 u32 num_regions; 49 struct vfio_platform_irq *irqs; 50 u32 num_irqs; 51 int refcnt; 52 struct mutex igate; 53 const char *compat; 54 const char *acpihid; 55 struct module *reset_module; 56 struct device *device; 57 58 /* 59 * These fields should be filled by the bus specific binder 60 */ 61 void *opaque; 62 const char *name; 63 uint32_t flags; 64 /* callbacks to discover device resources */ 65 struct resource* 66 (*get_resource)(struct vfio_platform_device *vdev, int i); 67 int (*get_irq)(struct vfio_platform_device *vdev, int i); 68 int (*of_reset)(struct vfio_platform_device *vdev); 69 70 bool reset_required; 71 }; 72 73 typedef int (*vfio_platform_reset_fn_t)(struct vfio_platform_device *vdev); 74 75 struct vfio_platform_reset_node { 76 struct list_head link; 77 char *compat; 78 struct module *owner; 79 vfio_platform_reset_fn_t of_reset; 80 }; 81 82 extern int vfio_platform_probe_common(struct vfio_platform_device *vdev, 83 struct device *dev); 84 void vfio_platform_remove_common(struct vfio_platform_device *vdev); 85 86 extern int vfio_platform_irq_init(struct vfio_platform_device *vdev); 87 extern void vfio_platform_irq_cleanup(struct vfio_platform_device *vdev); 88 89 extern int vfio_platform_set_irqs_ioctl(struct vfio_platform_device *vdev, 90 uint32_t flags, unsigned index, 91 unsigned start, unsigned count, 92 void *data); 93 94 extern void __vfio_platform_register_reset(struct vfio_platform_reset_node *n); 95 extern void vfio_platform_unregister_reset(const char *compat, 96 vfio_platform_reset_fn_t fn); 97 #define vfio_platform_register_reset(__compat, __reset) \ 98 static struct vfio_platform_reset_node __reset ## _node = { \ 99 .owner = THIS_MODULE, \ 100 .compat = __compat, \ 101 .of_reset = __reset, \ 102 }; \ 103 __vfio_platform_register_reset(&__reset ## _node) 104 105 #define module_vfio_reset_handler(compat, reset) \ 106 MODULE_ALIAS("vfio-reset:" compat); \ 107 static int __init reset ## _module_init(void) \ 108 { \ 109 vfio_platform_register_reset(compat, reset); \ 110 return 0; \ 111 }; \ 112 static void __exit reset ## _module_exit(void) \ 113 { \ 114 vfio_platform_unregister_reset(compat, reset); \ 115 }; \ 116 module_init(reset ## _module_init); \ 117 module_exit(reset ## _module_exit) 118 119 #endif /* VFIO_PLATFORM_PRIVATE_H */ 120