1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
|
/*
* Freescale Management Complex (MC) device passthrough using VFIO
*
* Copyright (C) 2013-2016 Freescale Semiconductor, Inc.
* Copyright 2016-2017 NXP
* Author: Bharat Bhushan <bharat.bhushan@nxp.com>
*
* This file is licensed under the terms of the GNU General Public
* License version 2. This program is licensed "as is" without any
* warranty of any kind, whether express or implied.
*/
#include <linux/device.h>
#include <linux/iommu.h>
#include <linux/module.h>
#include <linux/mutex.h>
#include <linux/slab.h>
#include <linux/types.h>
#include <linux/vfio.h>
#include "../../staging/fsl-mc/include/mc.h"
#include "../../staging/fsl-mc/include/mc-bus.h"
#include "../../staging/fsl-mc/include/mc-sys.h"
#include "vfio_fsl_mc_private.h"
#define DRIVER_VERSION "0.10"
#define DRIVER_AUTHOR "Bharat Bhushan <bharat.bhushan@nxp.com>"
#define DRIVER_DESC "VFIO for FSL-MC devices - User Level meta-driver"
static DEFINE_MUTEX(driver_lock);
/* FSl-MC device regions (address and size) are aligned to 64K.
* While MC firmware reports size less than 64K for some objects (it actually
* reports size which does not include reserved space beyond valid bytes).
* Align the size to PAGE_SIZE for userspace to mmap.
*/
static size_t aligned_region_size(struct fsl_mc_device *mc_dev, int index)
{
size_t size;
size = resource_size(&mc_dev->regions[index]);
return PAGE_ALIGN(size);
}
static int vfio_fsl_mc_regions_init(struct vfio_fsl_mc_device *vdev)
{
struct fsl_mc_device *mc_dev = vdev->mc_dev;
int count = mc_dev->obj_desc.region_count;
int i;
vdev->regions = kcalloc(count, sizeof(struct vfio_fsl_mc_region),
GFP_KERNEL);
if (!vdev->regions)
return -ENOMEM;
for (i = 0; i < mc_dev->obj_desc.region_count; i++) {
vdev->regions[i].addr = mc_dev->regions[i].start;
vdev->regions[i].size = aligned_region_size(mc_dev, i);
vdev->regions[i].type = VFIO_FSL_MC_REGION_TYPE_MMIO;
if (mc_dev->regions[i].flags & IORESOURCE_CACHEABLE)
vdev->regions[i].type |=
VFIO_FSL_MC_REGION_TYPE_CACHEABLE;
vdev->regions[i].flags = VFIO_REGION_INFO_FLAG_MMAP;
}
vdev->num_regions = mc_dev->obj_desc.region_count;
return 0;
}
static void vfio_fsl_mc_regions_cleanup(struct vfio_fsl_mc_device *vdev)
{
vdev->num_regions = 0;
kfree(vdev->regions);
}
static int vfio_fsl_mc_open(void *device_data)
{
struct vfio_fsl_mc_device *vdev = device_data;
int ret;
if (!try_module_get(THIS_MODULE))
return -ENODEV;
mutex_lock(&driver_lock);
if (!vdev->refcnt) {
ret = vfio_fsl_mc_regions_init(vdev);
if (ret)
goto error_region_init;
ret = vfio_fsl_mc_irqs_init(vdev);
if (ret)
goto error_irq_init;
}
vdev->refcnt++;
mutex_unlock(&driver_lock);
return 0;
error_irq_init:
vfio_fsl_mc_regions_cleanup(vdev);
error_region_init:
mutex_unlock(&driver_lock);
if (ret)
module_put(THIS_MODULE);
return ret;
}
static void vfio_fsl_mc_release(void *device_data)
{
struct vfio_fsl_mc_device *vdev = device_data;
mutex_lock(&driver_lock);
if (!(--vdev->refcnt)) {
vfio_fsl_mc_regions_cleanup(vdev);
vfio_fsl_mc_irqs_cleanup(vdev);
}
mutex_unlock(&driver_lock);
module_put(THIS_MODULE);
}
static long vfio_fsl_mc_ioctl(void *device_data, unsigned int cmd,
unsigned long arg)
{
struct vfio_fsl_mc_device *vdev = device_data;
struct fsl_mc_device *mc_dev = vdev->mc_dev;
unsigned long minsz;
if (WARN_ON(!mc_dev))
return -ENODEV;
switch (cmd) {
case VFIO_DEVICE_GET_INFO:
{
struct vfio_device_info info;
minsz = offsetofend(struct vfio_device_info, num_irqs);
if (copy_from_user(&info, (void __user *)arg, minsz))
return -EFAULT;
if (info.argsz < minsz)
return -EINVAL;
info.flags = VFIO_DEVICE_FLAGS_FSL_MC;
info.num_regions = mc_dev->obj_desc.region_count;
info.num_irqs = mc_dev->obj_desc.irq_count;
return copy_to_user((void __user *)arg, &info, minsz);
}
case VFIO_DEVICE_GET_REGION_INFO:
{
struct vfio_region_info info;
minsz = offsetofend(struct vfio_region_info, offset);
if (copy_from_user(&info, (void __user *)arg, minsz))
return -EFAULT;
if (info.argsz < minsz)
return -EINVAL;
if (info.index >= vdev->num_regions)
return -EINVAL;
/* map offset to the physical address */
info.offset = VFIO_FSL_MC_INDEX_TO_OFFSET(info.index);
info.size = vdev->regions[info.index].size;
info.flags = vdev->regions[info.index].flags;
return copy_to_user((void __user *)arg, &info, minsz);
}
case VFIO_DEVICE_GET_IRQ_INFO:
{
struct vfio_irq_info info;
minsz = offsetofend(struct vfio_irq_info, count);
if (copy_from_user(&info, (void __user *)arg, minsz))
return -EFAULT;
if (info.argsz < minsz)
return -EINVAL;
if (info.index >= mc_dev->obj_desc.irq_count)
return -EINVAL;
if (vdev->mc_irqs != NULL) {
info.flags = vdev->mc_irqs[info.index].flags;
info.count = vdev->mc_irqs[info.index].count;
} else {
/*
* If IRQs are not initialized then these can not
* be configuted and used by user-space/
*/
info.flags = 0;
info.count = 0;
}
return copy_to_user((void __user *)arg, &info, minsz);
}
case VFIO_DEVICE_SET_IRQS:
{
struct vfio_irq_set hdr;
u8 *data = NULL;
int ret = 0;
minsz = offsetofend(struct vfio_irq_set, count);
if (copy_from_user(&hdr, (void __user *)arg, minsz))
return -EFAULT;
if (hdr.argsz < minsz)
return -EINVAL;
if (hdr.index >= mc_dev->obj_desc.irq_count)
return -EINVAL;
if (hdr.start != 0 || hdr.count > 1)
return -EINVAL;
if (hdr.count == 0 &&
(!(hdr.flags & VFIO_IRQ_SET_DATA_NONE) ||
!(hdr.flags & VFIO_IRQ_SET_ACTION_TRIGGER)))
return -EINVAL;
if (hdr.flags & ~(VFIO_IRQ_SET_DATA_TYPE_MASK |
VFIO_IRQ_SET_ACTION_TYPE_MASK))
return -EINVAL;
if (!(hdr.flags & VFIO_IRQ_SET_DATA_NONE)) {
size_t size;
if (hdr.flags & VFIO_IRQ_SET_DATA_BOOL)
size = sizeof(uint8_t);
else if (hdr.flags & VFIO_IRQ_SET_DATA_EVENTFD)
size = sizeof(int32_t);
else
return -EINVAL;
if (hdr.argsz - minsz < hdr.count * size)
return -EINVAL;
data = memdup_user((void __user *)(arg + minsz),
hdr.count * size);
if (IS_ERR(data))
return PTR_ERR(data);
}
ret = vfio_fsl_mc_set_irqs_ioctl(vdev, hdr.flags,
hdr.index, hdr.start,
hdr.count, data);
return ret;
}
case VFIO_DEVICE_RESET:
{
return -EINVAL;
}
default:
return -EINVAL;
}
}
static ssize_t vfio_fsl_mc_read(void *device_data, char __user *buf,
size_t count, loff_t *ppos)
{
return -EINVAL;
}
static ssize_t vfio_fsl_mc_write(void *device_data, const char __user *buf,
size_t count, loff_t *ppos)
{
return -EINVAL;
}
static int vfio_fsl_mc_mmap_mmio(struct vfio_fsl_mc_region region,
struct vm_area_struct *vma)
{
u64 size = vma->vm_end - vma->vm_start;
u64 pgoff, base;
pgoff = vma->vm_pgoff &
((1U << (VFIO_FSL_MC_OFFSET_SHIFT - PAGE_SHIFT)) - 1);
base = pgoff << PAGE_SHIFT;
if (region.size < PAGE_SIZE || base + size > region.size)
return -EINVAL;
/*
* Set the REGION_TYPE_CACHEABLE (QBman CENA regs) to be the
* cache inhibited area of the portal to avoid coherency issues
* if a user migrates to another core.
*/
if (region.type & VFIO_FSL_MC_REGION_TYPE_CACHEABLE)
vma->vm_page_prot = pgprot_writecombine(vma->vm_page_prot);
else
vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
vma->vm_pgoff = (region.addr >> PAGE_SHIFT) + pgoff;
return remap_pfn_range(vma, vma->vm_start, vma->vm_pgoff,
size, vma->vm_page_prot);
}
/* Allows mmaping fsl_mc device regions in assigned DPRC */
static int vfio_fsl_mc_mmap(void *device_data, struct vm_area_struct *vma)
{
struct vfio_fsl_mc_device *vdev = device_data;
struct fsl_mc_device *mc_dev = vdev->mc_dev;
unsigned long size, addr;
int index;
index = vma->vm_pgoff >> (VFIO_FSL_MC_OFFSET_SHIFT - PAGE_SHIFT);
if (vma->vm_end < vma->vm_start)
return -EINVAL;
if (vma->vm_start & ~PAGE_MASK)
return -EINVAL;
if (vma->vm_end & ~PAGE_MASK)
return -EINVAL;
if (!(vma->vm_flags & VM_SHARED))
return -EINVAL;
if (index >= vdev->num_regions)
return -EINVAL;
if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_MMAP))
return -EINVAL;
if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_READ)
&& (vma->vm_flags & VM_READ))
return -EINVAL;
if (!(vdev->regions[index].flags & VFIO_REGION_INFO_FLAG_WRITE)
&& (vma->vm_flags & VM_WRITE))
return -EINVAL;
addr = vdev->regions[index].addr;
size = vdev->regions[index].size;
vma->vm_private_data = mc_dev;
if (vdev->regions[index].type & VFIO_FSL_MC_REGION_TYPE_MMIO)
return vfio_fsl_mc_mmap_mmio(vdev->regions[index], vma);
return -EFAULT;
}
static const struct vfio_device_ops vfio_fsl_mc_ops = {
.name = "vfio-fsl-mc",
.open = vfio_fsl_mc_open,
.release = vfio_fsl_mc_release,
.ioctl = vfio_fsl_mc_ioctl,
.read = vfio_fsl_mc_read,
.write = vfio_fsl_mc_write,
.mmap = vfio_fsl_mc_mmap,
};
static int vfio_fsl_mc_initialize_dprc(struct vfio_fsl_mc_device *vdev)
{
struct device *root_dprc_dev;
struct fsl_mc_device *mc_dev = vdev->mc_dev;
struct device *dev = &mc_dev->dev;
struct fsl_mc_bus *mc_bus;
struct irq_domain *mc_msi_domain;
unsigned int irq_count;
int ret;
/* device must be DPRC */
if (strcmp(mc_dev->obj_desc.type, "dprc"))
return -EINVAL;
/* mc_io must be un-initialized */
WARN_ON(mc_dev->mc_io);
/* allocate a portal from the root DPRC for vfio use */
fsl_mc_get_root_dprc(dev, &root_dprc_dev);
if (WARN_ON(!root_dprc_dev))
return -EINVAL;
ret = fsl_mc_portal_allocate(to_fsl_mc_device(root_dprc_dev),
FSL_MC_IO_ATOMIC_CONTEXT_PORTAL,
&mc_dev->mc_io);
if (ret < 0)
goto clean_msi_domain;
/* Reset MCP before move on */
ret = fsl_mc_portal_reset(mc_dev->mc_io);
if (ret < 0) {
dev_err(dev, "dprc portal reset failed: error = %d\n", ret);
goto free_mc_portal;
}
/* MSI domain set up */
ret = fsl_mc_find_msi_domain(root_dprc_dev->parent, &mc_msi_domain);
if (ret < 0)
goto free_mc_portal;
dev_set_msi_domain(&mc_dev->dev, mc_msi_domain);
ret = dprc_open(mc_dev->mc_io, 0, mc_dev->obj_desc.id,
&mc_dev->mc_handle);
if (ret) {
dev_err(dev, "dprc_open() failed: error = %d\n", ret);
goto free_mc_portal;
}
/* Initialize resource pool */
fsl_mc_init_all_resource_pools(mc_dev);
mc_bus = to_fsl_mc_bus(mc_dev);
if (!mc_bus->irq_resources) {
irq_count = FSL_MC_IRQ_POOL_MAX_TOTAL_IRQS;
ret = fsl_mc_populate_irq_pool(mc_bus, irq_count);
if (ret < 0) {
dev_err(dev, "%s: Failed to init irq-pool\n", __func__);
goto clean_resource_pool;
}
}
mutex_init(&mc_bus->scan_mutex);
mutex_lock(&mc_bus->scan_mutex);
ret = dprc_scan_objects(mc_dev, mc_dev->driver_override,
&irq_count);
mutex_unlock(&mc_bus->scan_mutex);
if (ret) {
dev_err(dev, "dprc_scan_objects() fails (%d)\n", ret);
goto clean_irq_pool;
}
if (irq_count > FSL_MC_IRQ_POOL_MAX_TOTAL_IRQS) {
dev_warn(&mc_dev->dev,
"IRQs needed (%u) exceed IRQs preallocated (%u)\n",
irq_count, FSL_MC_IRQ_POOL_MAX_TOTAL_IRQS);
}
return 0;
clean_irq_pool:
fsl_mc_cleanup_irq_pool(mc_bus);
clean_resource_pool:
fsl_mc_cleanup_all_resource_pools(mc_dev);
dprc_close(mc_dev->mc_io, 0, mc_dev->mc_handle);
free_mc_portal:
fsl_mc_portal_free(mc_dev->mc_io);
clean_msi_domain:
dev_set_msi_domain(&mc_dev->dev, NULL);
return ret;
}
static int vfio_fsl_mc_device_remove(struct device *dev, void *data)
{
struct fsl_mc_device *mc_dev;
WARN_ON(dev == NULL);
mc_dev = to_fsl_mc_device(dev);
if (WARN_ON(mc_dev == NULL))
return -ENODEV;
fsl_mc_device_remove(mc_dev);
return 0;
}
static void vfio_fsl_mc_cleanup_dprc(struct vfio_fsl_mc_device *vdev)
{
struct fsl_mc_device *mc_dev = vdev->mc_dev;
struct fsl_mc_bus *mc_bus;
/* device must be DPRC */
if (strcmp(mc_dev->obj_desc.type, "dprc"))
return;
device_for_each_child(&mc_dev->dev, NULL, vfio_fsl_mc_device_remove);
mc_bus = to_fsl_mc_bus(mc_dev);
if (dev_get_msi_domain(&mc_dev->dev))
fsl_mc_cleanup_irq_pool(mc_bus);
dev_set_msi_domain(&mc_dev->dev, NULL);
fsl_mc_cleanup_all_resource_pools(mc_dev);
dprc_close(mc_dev->mc_io, 0, mc_dev->mc_handle);
fsl_mc_portal_free(mc_dev->mc_io);
}
static int vfio_fsl_mc_probe(struct fsl_mc_device *mc_dev)
{
struct iommu_group *group;
struct vfio_fsl_mc_device *vdev;
struct device *dev = &mc_dev->dev;
int ret;
group = vfio_iommu_group_get(dev);
if (!group) {
dev_err(dev, "%s: VFIO: No IOMMU group\n", __func__);
return -EINVAL;
}
vdev = kzalloc(sizeof(*vdev), GFP_KERNEL);
if (!vdev) {
vfio_iommu_group_put(group, dev);
return -ENOMEM;
}
vdev->mc_dev = mc_dev;
ret = vfio_add_group_dev(dev, &vfio_fsl_mc_ops, vdev);
if (ret) {
dev_err(dev, "%s: Failed to add to vfio group\n", __func__);
goto free_vfio_device;
}
/* DPRC container scanned and it's chilren bound with vfio driver */
if (strcmp(mc_dev->obj_desc.type, "dprc") == 0) {
ret = vfio_fsl_mc_initialize_dprc(vdev);
if (ret) {
vfio_del_group_dev(dev);
goto free_vfio_device;
}
} else {
struct fsl_mc_device *mc_bus_dev;
/* Non-dprc devices share mc_io from the parent dprc */
mc_bus_dev = to_fsl_mc_device(mc_dev->dev.parent);
if (mc_bus_dev == NULL) {
vfio_del_group_dev(dev);
goto free_vfio_device;
}
mc_dev->mc_io = mc_bus_dev->mc_io;
/* Inherit parent MSI domain */
dev_set_msi_domain(&mc_dev->dev,
dev_get_msi_domain(mc_dev->dev.parent));
}
return 0;
free_vfio_device:
kfree(vdev);
vfio_iommu_group_put(group, dev);
return ret;
}
static int vfio_fsl_mc_remove(struct fsl_mc_device *mc_dev)
{
struct vfio_fsl_mc_device *vdev;
struct device *dev = &mc_dev->dev;
vdev = vfio_del_group_dev(dev);
if (!vdev)
return -EINVAL;
if (strcmp(mc_dev->obj_desc.type, "dprc") == 0)
vfio_fsl_mc_cleanup_dprc(vdev);
else
dev_set_msi_domain(&mc_dev->dev, NULL);
mc_dev->mc_io = NULL;
vfio_iommu_group_put(mc_dev->dev.iommu_group, dev);
kfree(vdev);
return 0;
}
/*
* vfio-fsl_mc is a meta-driver, so use driver_override interface to
* bind a fsl_mc container with this driver and match_id_table is NULL.
*/
static struct fsl_mc_driver vfio_fsl_mc_driver = {
.probe = vfio_fsl_mc_probe,
.remove = vfio_fsl_mc_remove,
.match_id_table = NULL,
.driver = {
.name = "vfio-fsl-mc",
.owner = THIS_MODULE,
},
};
static int __init vfio_fsl_mc_driver_init(void)
{
return fsl_mc_driver_register(&vfio_fsl_mc_driver);
}
static void __exit vfio_fsl_mc_driver_exit(void)
{
fsl_mc_driver_unregister(&vfio_fsl_mc_driver);
}
module_init(vfio_fsl_mc_driver_init);
module_exit(vfio_fsl_mc_driver_exit);
MODULE_VERSION(DRIVER_VERSION);
MODULE_LICENSE("GPL v2");
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
|