1 /*
2  * Copyright (C) 2013 - Virtual Open Systems
3  * Author: Antonios Motakis <a.motakis@virtualopensystems.com>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License, version 2, as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  */
14 
15 #ifndef VFIO_PLATFORM_PRIVATE_H
16 #define VFIO_PLATFORM_PRIVATE_H
17 
18 #include <linux/types.h>
19 #include <linux/interrupt.h>
20 
21 #define VFIO_PLATFORM_OFFSET_SHIFT   40
22 #define VFIO_PLATFORM_OFFSET_MASK (((u64)(1) << VFIO_PLATFORM_OFFSET_SHIFT) - 1)
23 
24 #define VFIO_PLATFORM_OFFSET_TO_INDEX(off)	\
25 	(off >> VFIO_PLATFORM_OFFSET_SHIFT)
26 
27 #define VFIO_PLATFORM_INDEX_TO_OFFSET(index)	\
28 	((u64)(index) << VFIO_PLATFORM_OFFSET_SHIFT)
29 
30 struct vfio_platform_irq {
31 	u32			flags;
32 	u32			count;
33 	int			hwirq;
34 	char			*name;
35 	struct eventfd_ctx	*trigger;
36 	bool			masked;
37 	spinlock_t		lock;
38 	struct virqfd		*unmask;
39 	struct virqfd		*mask;
40 };
41 
42 struct vfio_platform_region {
43 	u64			addr;
44 	resource_size_t		size;
45 	u32			flags;
46 	u32			type;
47 #define VFIO_PLATFORM_REGION_TYPE_MMIO	1
48 #define VFIO_PLATFORM_REGION_TYPE_PIO	2
49 	void __iomem		*ioaddr;
50 };
51 
52 struct vfio_platform_device {
53 	struct vfio_platform_region	*regions;
54 	u32				num_regions;
55 	struct vfio_platform_irq	*irqs;
56 	u32				num_irqs;
57 	int				refcnt;
58 	struct mutex			igate;
59 
60 	/*
61 	 * These fields should be filled by the bus specific binder
62 	 */
63 	void		*opaque;
64 	const char	*name;
65 	uint32_t	flags;
66 	/* callbacks to discover device resources */
67 	struct resource*
68 		(*get_resource)(struct vfio_platform_device *vdev, int i);
69 	int	(*get_irq)(struct vfio_platform_device *vdev, int i);
70 	int	(*reset)(struct vfio_platform_device *vdev);
71 };
72 
73 struct vfio_platform_reset_combo {
74 	const char *compat;
75 	const char *reset_function_name;
76 	const char *module_name;
77 };
78 
79 extern int vfio_platform_probe_common(struct vfio_platform_device *vdev,
80 				      struct device *dev);
81 extern struct vfio_platform_device *vfio_platform_remove_common
82 				     (struct device *dev);
83 
84 extern int vfio_platform_irq_init(struct vfio_platform_device *vdev);
85 extern void vfio_platform_irq_cleanup(struct vfio_platform_device *vdev);
86 
87 extern int vfio_platform_set_irqs_ioctl(struct vfio_platform_device *vdev,
88 					uint32_t flags, unsigned index,
89 					unsigned start, unsigned count,
90 					void *data);
91 
92 #endif /* VFIO_PLATFORM_PRIVATE_H */
93