GNU Linux-libre 4.14.324-gnu1
[releases.git] / drivers / misc / cxl / file.c
1 /*
2  * Copyright 2014 IBM Corp.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version
7  * 2 of the License, or (at your option) any later version.
8  */
9
10 #include <linux/spinlock.h>
11 #include <linux/module.h>
12 #include <linux/export.h>
13 #include <linux/kernel.h>
14 #include <linux/bitmap.h>
15 #include <linux/sched/signal.h>
16 #include <linux/poll.h>
17 #include <linux/pid.h>
18 #include <linux/fs.h>
19 #include <linux/mm.h>
20 #include <linux/slab.h>
21 #include <linux/sched/mm.h>
22 #include <asm/cputable.h>
23 #include <asm/current.h>
24 #include <asm/copro.h>
25
26 #include "cxl.h"
27 #include "trace.h"
28
29 #define CXL_NUM_MINORS 256 /* Total to reserve */
30
31 #define CXL_AFU_MINOR_D(afu) (CXL_CARD_MINOR(afu->adapter) + 1 + (3 * afu->slice))
32 #define CXL_AFU_MINOR_M(afu) (CXL_AFU_MINOR_D(afu) + 1)
33 #define CXL_AFU_MINOR_S(afu) (CXL_AFU_MINOR_D(afu) + 2)
34 #define CXL_AFU_MKDEV_D(afu) MKDEV(MAJOR(cxl_dev), CXL_AFU_MINOR_D(afu))
35 #define CXL_AFU_MKDEV_M(afu) MKDEV(MAJOR(cxl_dev), CXL_AFU_MINOR_M(afu))
36 #define CXL_AFU_MKDEV_S(afu) MKDEV(MAJOR(cxl_dev), CXL_AFU_MINOR_S(afu))
37
38 #define CXL_DEVT_AFU(dev) ((MINOR(dev) % CXL_DEV_MINORS - 1) / 3)
39
40 #define CXL_DEVT_IS_CARD(dev) (MINOR(dev) % CXL_DEV_MINORS == 0)
41
42 static dev_t cxl_dev;
43
44 static struct class *cxl_class;
45
46 static int __afu_open(struct inode *inode, struct file *file, bool master)
47 {
48         struct cxl *adapter;
49         struct cxl_afu *afu;
50         struct cxl_context *ctx;
51         int adapter_num = CXL_DEVT_ADAPTER(inode->i_rdev);
52         int slice = CXL_DEVT_AFU(inode->i_rdev);
53         int rc = -ENODEV;
54
55         pr_devel("afu_open afu%i.%i\n", slice, adapter_num);
56
57         if (!(adapter = get_cxl_adapter(adapter_num)))
58                 return -ENODEV;
59
60         if (slice > adapter->slices)
61                 goto err_put_adapter;
62
63         spin_lock(&adapter->afu_list_lock);
64         if (!(afu = adapter->afu[slice])) {
65                 spin_unlock(&adapter->afu_list_lock);
66                 goto err_put_adapter;
67         }
68
69         /*
70          * taking a ref to the afu so that it doesn't go away
71          * for rest of the function. This ref is released before
72          * we return.
73          */
74         cxl_afu_get(afu);
75         spin_unlock(&adapter->afu_list_lock);
76
77         if (!afu->current_mode)
78                 goto err_put_afu;
79
80         if (!cxl_ops->link_ok(adapter, afu)) {
81                 rc = -EIO;
82                 goto err_put_afu;
83         }
84
85         if (!(ctx = cxl_context_alloc())) {
86                 rc = -ENOMEM;
87                 goto err_put_afu;
88         }
89
90         rc = cxl_context_init(ctx, afu, master);
91         if (rc)
92                 goto err_put_afu;
93
94         cxl_context_set_mapping(ctx, inode->i_mapping);
95
96         pr_devel("afu_open pe: %i\n", ctx->pe);
97         file->private_data = ctx;
98
99         /* indicate success */
100         rc = 0;
101
102 err_put_afu:
103         /* release the ref taken earlier */
104         cxl_afu_put(afu);
105 err_put_adapter:
106         put_device(&adapter->dev);
107         return rc;
108 }
109
110 int afu_open(struct inode *inode, struct file *file)
111 {
112         return __afu_open(inode, file, false);
113 }
114
115 static int afu_master_open(struct inode *inode, struct file *file)
116 {
117         return __afu_open(inode, file, true);
118 }
119
120 int afu_release(struct inode *inode, struct file *file)
121 {
122         struct cxl_context *ctx = file->private_data;
123
124         pr_devel("%s: closing cxl file descriptor. pe: %i\n",
125                  __func__, ctx->pe);
126         cxl_context_detach(ctx);
127
128
129         /*
130          * Delete the context's mapping pointer, unless it's created by the
131          * kernel API, in which case leave it so it can be freed by reclaim_ctx()
132          */
133         if (!ctx->kernelapi) {
134                 mutex_lock(&ctx->mapping_lock);
135                 ctx->mapping = NULL;
136                 mutex_unlock(&ctx->mapping_lock);
137         }
138
139         /*
140          * At this this point all bottom halfs have finished and we should be
141          * getting no more IRQs from the hardware for this context.  Once it's
142          * removed from the IDR (and RCU synchronised) it's safe to free the
143          * sstp and context.
144          */
145         cxl_context_free(ctx);
146
147         return 0;
148 }
149
150 static long afu_ioctl_start_work(struct cxl_context *ctx,
151                                  struct cxl_ioctl_start_work __user *uwork)
152 {
153         struct cxl_ioctl_start_work work;
154         u64 amr = 0;
155         int rc;
156
157         pr_devel("%s: pe: %i\n", __func__, ctx->pe);
158
159         /* Do this outside the status_mutex to avoid a circular dependency with
160          * the locking in cxl_mmap_fault() */
161         if (copy_from_user(&work, uwork, sizeof(work)))
162                 return -EFAULT;
163
164         mutex_lock(&ctx->status_mutex);
165         if (ctx->status != OPENED) {
166                 rc = -EIO;
167                 goto out;
168         }
169
170         /*
171          * if any of the reserved fields are set or any of the unused
172          * flags are set it's invalid
173          */
174         if (work.reserved1 || work.reserved2 || work.reserved3 ||
175             work.reserved4 || work.reserved5 || work.reserved6 ||
176             (work.flags & ~CXL_START_WORK_ALL)) {
177                 rc = -EINVAL;
178                 goto out;
179         }
180
181         if (!(work.flags & CXL_START_WORK_NUM_IRQS))
182                 work.num_interrupts = ctx->afu->pp_irqs;
183         else if ((work.num_interrupts < ctx->afu->pp_irqs) ||
184                  (work.num_interrupts > ctx->afu->irqs_max)) {
185                 rc =  -EINVAL;
186                 goto out;
187         }
188         if ((rc = afu_register_irqs(ctx, work.num_interrupts)))
189                 goto out;
190
191         if (work.flags & CXL_START_WORK_AMR)
192                 amr = work.amr & mfspr(SPRN_UAMOR);
193
194         ctx->mmio_err_ff = !!(work.flags & CXL_START_WORK_ERR_FF);
195
196         /*
197          * Increment the mapped context count for adapter. This also checks
198          * if adapter_context_lock is taken.
199          */
200         rc = cxl_adapter_context_get(ctx->afu->adapter);
201         if (rc) {
202                 afu_release_irqs(ctx, ctx);
203                 goto out;
204         }
205
206         /*
207          * We grab the PID here and not in the file open to allow for the case
208          * where a process (master, some daemon, etc) has opened the chardev on
209          * behalf of another process, so the AFU's mm gets bound to the process
210          * that performs this ioctl and not the process that opened the file.
211          * Also we grab the PID of the group leader so that if the task that
212          * has performed the attach operation exits the mm context of the
213          * process is still accessible.
214          */
215         ctx->pid = get_task_pid(current, PIDTYPE_PID);
216
217         /* acquire a reference to the task's mm */
218         ctx->mm = get_task_mm(current);
219
220         /* ensure this mm_struct can't be freed */
221         cxl_context_mm_count_get(ctx);
222
223         /* decrement the use count */
224         if (ctx->mm)
225                 mmput(ctx->mm);
226
227         /*
228          * Increment driver use count. Enables global TLBIs for hash
229          * and callbacks to handle the segment table
230          */
231         cxl_ctx_get();
232
233         trace_cxl_attach(ctx, work.work_element_descriptor, work.num_interrupts, amr);
234
235         if ((rc = cxl_ops->attach_process(ctx, false, work.work_element_descriptor,
236                                                         amr))) {
237                 afu_release_irqs(ctx, ctx);
238                 cxl_adapter_context_put(ctx->afu->adapter);
239                 put_pid(ctx->pid);
240                 ctx->pid = NULL;
241                 cxl_ctx_put();
242                 cxl_context_mm_count_put(ctx);
243                 goto out;
244         }
245
246         ctx->status = STARTED;
247         rc = 0;
248 out:
249         mutex_unlock(&ctx->status_mutex);
250         return rc;
251 }
252
253 static long afu_ioctl_process_element(struct cxl_context *ctx,
254                                       int __user *upe)
255 {
256         pr_devel("%s: pe: %i\n", __func__, ctx->pe);
257
258         if (copy_to_user(upe, &ctx->external_pe, sizeof(__u32)))
259                 return -EFAULT;
260
261         return 0;
262 }
263
264 static long afu_ioctl_get_afu_id(struct cxl_context *ctx,
265                                  struct cxl_afu_id __user *upafuid)
266 {
267         struct cxl_afu_id afuid = { 0 };
268
269         afuid.card_id = ctx->afu->adapter->adapter_num;
270         afuid.afu_offset = ctx->afu->slice;
271         afuid.afu_mode = ctx->afu->current_mode;
272
273         /* set the flag bit in case the afu is a slave */
274         if (ctx->afu->current_mode == CXL_MODE_DIRECTED && !ctx->master)
275                 afuid.flags |= CXL_AFUID_FLAG_SLAVE;
276
277         if (copy_to_user(upafuid, &afuid, sizeof(afuid)))
278                 return -EFAULT;
279
280         return 0;
281 }
282
283 long afu_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
284 {
285         struct cxl_context *ctx = file->private_data;
286
287         if (ctx->status == CLOSED)
288                 return -EIO;
289
290         if (!cxl_ops->link_ok(ctx->afu->adapter, ctx->afu))
291                 return -EIO;
292
293         pr_devel("afu_ioctl\n");
294         switch (cmd) {
295         case CXL_IOCTL_START_WORK:
296                 return afu_ioctl_start_work(ctx, (struct cxl_ioctl_start_work __user *)arg);
297         case CXL_IOCTL_GET_PROCESS_ELEMENT:
298                 return afu_ioctl_process_element(ctx, (__u32 __user *)arg);
299         case CXL_IOCTL_GET_AFU_ID:
300                 return afu_ioctl_get_afu_id(ctx, (struct cxl_afu_id __user *)
301                                             arg);
302         }
303         return -EINVAL;
304 }
305
306 static long afu_compat_ioctl(struct file *file, unsigned int cmd,
307                              unsigned long arg)
308 {
309         return afu_ioctl(file, cmd, arg);
310 }
311
312 int afu_mmap(struct file *file, struct vm_area_struct *vm)
313 {
314         struct cxl_context *ctx = file->private_data;
315
316         /* AFU must be started before we can MMIO */
317         if (ctx->status != STARTED)
318                 return -EIO;
319
320         if (!cxl_ops->link_ok(ctx->afu->adapter, ctx->afu))
321                 return -EIO;
322
323         return cxl_context_iomap(ctx, vm);
324 }
325
326 static inline bool ctx_event_pending(struct cxl_context *ctx)
327 {
328         if (ctx->pending_irq || ctx->pending_fault || ctx->pending_afu_err)
329                 return true;
330
331         if (ctx->afu_driver_ops && atomic_read(&ctx->afu_driver_events))
332                 return true;
333
334         return false;
335 }
336
337 unsigned int afu_poll(struct file *file, struct poll_table_struct *poll)
338 {
339         struct cxl_context *ctx = file->private_data;
340         int mask = 0;
341         unsigned long flags;
342
343
344         poll_wait(file, &ctx->wq, poll);
345
346         pr_devel("afu_poll wait done pe: %i\n", ctx->pe);
347
348         spin_lock_irqsave(&ctx->lock, flags);
349         if (ctx_event_pending(ctx))
350                 mask |= POLLIN | POLLRDNORM;
351         else if (ctx->status == CLOSED)
352                 /* Only error on closed when there are no futher events pending
353                  */
354                 mask |= POLLERR;
355         spin_unlock_irqrestore(&ctx->lock, flags);
356
357         pr_devel("afu_poll pe: %i returning %#x\n", ctx->pe, mask);
358
359         return mask;
360 }
361
362 static ssize_t afu_driver_event_copy(struct cxl_context *ctx,
363                                      char __user *buf,
364                                      struct cxl_event *event,
365                                      struct cxl_event_afu_driver_reserved *pl)
366 {
367         /* Check event */
368         if (!pl) {
369                 ctx->afu_driver_ops->event_delivered(ctx, pl, -EINVAL);
370                 return -EFAULT;
371         }
372
373         /* Check event size */
374         event->header.size += pl->data_size;
375         if (event->header.size > CXL_READ_MIN_SIZE) {
376                 ctx->afu_driver_ops->event_delivered(ctx, pl, -EINVAL);
377                 return -EFAULT;
378         }
379
380         /* Copy event header */
381         if (copy_to_user(buf, event, sizeof(struct cxl_event_header))) {
382                 ctx->afu_driver_ops->event_delivered(ctx, pl, -EFAULT);
383                 return -EFAULT;
384         }
385
386         /* Copy event data */
387         buf += sizeof(struct cxl_event_header);
388         if (copy_to_user(buf, &pl->data, pl->data_size)) {
389                 ctx->afu_driver_ops->event_delivered(ctx, pl, -EFAULT);
390                 return -EFAULT;
391         }
392
393         ctx->afu_driver_ops->event_delivered(ctx, pl, 0); /* Success */
394         return event->header.size;
395 }
396
397 ssize_t afu_read(struct file *file, char __user *buf, size_t count,
398                         loff_t *off)
399 {
400         struct cxl_context *ctx = file->private_data;
401         struct cxl_event_afu_driver_reserved *pl = NULL;
402         struct cxl_event event;
403         unsigned long flags;
404         int rc;
405         DEFINE_WAIT(wait);
406
407         if (!cxl_ops->link_ok(ctx->afu->adapter, ctx->afu))
408                 return -EIO;
409
410         if (count < CXL_READ_MIN_SIZE)
411                 return -EINVAL;
412
413         spin_lock_irqsave(&ctx->lock, flags);
414
415         for (;;) {
416                 prepare_to_wait(&ctx->wq, &wait, TASK_INTERRUPTIBLE);
417                 if (ctx_event_pending(ctx) || (ctx->status == CLOSED))
418                         break;
419
420                 if (!cxl_ops->link_ok(ctx->afu->adapter, ctx->afu)) {
421                         rc = -EIO;
422                         goto out;
423                 }
424
425                 if (file->f_flags & O_NONBLOCK) {
426                         rc = -EAGAIN;
427                         goto out;
428                 }
429
430                 if (signal_pending(current)) {
431                         rc = -ERESTARTSYS;
432                         goto out;
433                 }
434
435                 spin_unlock_irqrestore(&ctx->lock, flags);
436                 pr_devel("afu_read going to sleep...\n");
437                 schedule();
438                 pr_devel("afu_read woken up\n");
439                 spin_lock_irqsave(&ctx->lock, flags);
440         }
441
442         finish_wait(&ctx->wq, &wait);
443
444         memset(&event, 0, sizeof(event));
445         event.header.process_element = ctx->pe;
446         event.header.size = sizeof(struct cxl_event_header);
447         if (ctx->afu_driver_ops && atomic_read(&ctx->afu_driver_events)) {
448                 pr_devel("afu_read delivering AFU driver specific event\n");
449                 pl = ctx->afu_driver_ops->fetch_event(ctx);
450                 atomic_dec(&ctx->afu_driver_events);
451                 event.header.type = CXL_EVENT_AFU_DRIVER;
452         } else if (ctx->pending_irq) {
453                 pr_devel("afu_read delivering AFU interrupt\n");
454                 event.header.size += sizeof(struct cxl_event_afu_interrupt);
455                 event.header.type = CXL_EVENT_AFU_INTERRUPT;
456                 event.irq.irq = find_first_bit(ctx->irq_bitmap, ctx->irq_count) + 1;
457                 clear_bit(event.irq.irq - 1, ctx->irq_bitmap);
458                 if (bitmap_empty(ctx->irq_bitmap, ctx->irq_count))
459                         ctx->pending_irq = false;
460         } else if (ctx->pending_fault) {
461                 pr_devel("afu_read delivering data storage fault\n");
462                 event.header.size += sizeof(struct cxl_event_data_storage);
463                 event.header.type = CXL_EVENT_DATA_STORAGE;
464                 event.fault.addr = ctx->fault_addr;
465                 event.fault.dsisr = ctx->fault_dsisr;
466                 ctx->pending_fault = false;
467         } else if (ctx->pending_afu_err) {
468                 pr_devel("afu_read delivering afu error\n");
469                 event.header.size += sizeof(struct cxl_event_afu_error);
470                 event.header.type = CXL_EVENT_AFU_ERROR;
471                 event.afu_error.error = ctx->afu_err;
472                 ctx->pending_afu_err = false;
473         } else if (ctx->status == CLOSED) {
474                 pr_devel("afu_read fatal error\n");
475                 spin_unlock_irqrestore(&ctx->lock, flags);
476                 return -EIO;
477         } else
478                 WARN(1, "afu_read must be buggy\n");
479
480         spin_unlock_irqrestore(&ctx->lock, flags);
481
482         if (event.header.type == CXL_EVENT_AFU_DRIVER)
483                 return afu_driver_event_copy(ctx, buf, &event, pl);
484
485         if (copy_to_user(buf, &event, event.header.size))
486                 return -EFAULT;
487         return event.header.size;
488
489 out:
490         finish_wait(&ctx->wq, &wait);
491         spin_unlock_irqrestore(&ctx->lock, flags);
492         return rc;
493 }
494
495 /* 
496  * Note: if this is updated, we need to update api.c to patch the new ones in
497  * too
498  */
499 const struct file_operations afu_fops = {
500         .owner          = THIS_MODULE,
501         .open           = afu_open,
502         .poll           = afu_poll,
503         .read           = afu_read,
504         .release        = afu_release,
505         .unlocked_ioctl = afu_ioctl,
506         .compat_ioctl   = afu_compat_ioctl,
507         .mmap           = afu_mmap,
508 };
509
510 static const struct file_operations afu_master_fops = {
511         .owner          = THIS_MODULE,
512         .open           = afu_master_open,
513         .poll           = afu_poll,
514         .read           = afu_read,
515         .release        = afu_release,
516         .unlocked_ioctl = afu_ioctl,
517         .compat_ioctl   = afu_compat_ioctl,
518         .mmap           = afu_mmap,
519 };
520
521
522 static char *cxl_devnode(struct device *dev, umode_t *mode)
523 {
524         if (cpu_has_feature(CPU_FTR_HVMODE) &&
525             CXL_DEVT_IS_CARD(dev->devt)) {
526                 /*
527                  * These minor numbers will eventually be used to program the
528                  * PSL and AFUs once we have dynamic reprogramming support
529                  */
530                 return NULL;
531         }
532         return kasprintf(GFP_KERNEL, "cxl/%s", dev_name(dev));
533 }
534
535 extern struct class *cxl_class;
536
537 static int cxl_add_chardev(struct cxl_afu *afu, dev_t devt, struct cdev *cdev,
538                            struct device **chardev, char *postfix, char *desc,
539                            const struct file_operations *fops)
540 {
541         struct device *dev;
542         int rc;
543
544         cdev_init(cdev, fops);
545         if ((rc = cdev_add(cdev, devt, 1))) {
546                 dev_err(&afu->dev, "Unable to add %s chardev: %i\n", desc, rc);
547                 return rc;
548         }
549
550         dev = device_create(cxl_class, &afu->dev, devt, afu,
551                         "afu%i.%i%s", afu->adapter->adapter_num, afu->slice, postfix);
552         if (IS_ERR(dev)) {
553                 dev_err(&afu->dev, "Unable to create %s chardev in sysfs: %i\n", desc, rc);
554                 rc = PTR_ERR(dev);
555                 goto err;
556         }
557
558         *chardev = dev;
559
560         return 0;
561 err:
562         cdev_del(cdev);
563         return rc;
564 }
565
566 int cxl_chardev_d_afu_add(struct cxl_afu *afu)
567 {
568         return cxl_add_chardev(afu, CXL_AFU_MKDEV_D(afu), &afu->afu_cdev_d,
569                                &afu->chardev_d, "d", "dedicated",
570                                &afu_master_fops); /* Uses master fops */
571 }
572
573 int cxl_chardev_m_afu_add(struct cxl_afu *afu)
574 {
575         return cxl_add_chardev(afu, CXL_AFU_MKDEV_M(afu), &afu->afu_cdev_m,
576                                &afu->chardev_m, "m", "master",
577                                &afu_master_fops);
578 }
579
580 int cxl_chardev_s_afu_add(struct cxl_afu *afu)
581 {
582         return cxl_add_chardev(afu, CXL_AFU_MKDEV_S(afu), &afu->afu_cdev_s,
583                                &afu->chardev_s, "s", "shared",
584                                &afu_fops);
585 }
586
587 void cxl_chardev_afu_remove(struct cxl_afu *afu)
588 {
589         if (afu->chardev_d) {
590                 cdev_del(&afu->afu_cdev_d);
591                 device_unregister(afu->chardev_d);
592                 afu->chardev_d = NULL;
593         }
594         if (afu->chardev_m) {
595                 cdev_del(&afu->afu_cdev_m);
596                 device_unregister(afu->chardev_m);
597                 afu->chardev_m = NULL;
598         }
599         if (afu->chardev_s) {
600                 cdev_del(&afu->afu_cdev_s);
601                 device_unregister(afu->chardev_s);
602                 afu->chardev_s = NULL;
603         }
604 }
605
606 int cxl_register_afu(struct cxl_afu *afu)
607 {
608         afu->dev.class = cxl_class;
609
610         return device_register(&afu->dev);
611 }
612
613 int cxl_register_adapter(struct cxl *adapter)
614 {
615         adapter->dev.class = cxl_class;
616
617         /*
618          * Future: When we support dynamically reprogramming the PSL & AFU we
619          * will expose the interface to do that via a chardev:
620          * adapter->dev.devt = CXL_CARD_MKDEV(adapter);
621          */
622
623         return device_register(&adapter->dev);
624 }
625
626 dev_t cxl_get_dev(void)
627 {
628         return cxl_dev;
629 }
630
631 int __init cxl_file_init(void)
632 {
633         int rc;
634
635         /*
636          * If these change we really need to update API.  Either change some
637          * flags or update API version number CXL_API_VERSION.
638          */
639         BUILD_BUG_ON(CXL_API_VERSION != 3);
640         BUILD_BUG_ON(sizeof(struct cxl_ioctl_start_work) != 64);
641         BUILD_BUG_ON(sizeof(struct cxl_event_header) != 8);
642         BUILD_BUG_ON(sizeof(struct cxl_event_afu_interrupt) != 8);
643         BUILD_BUG_ON(sizeof(struct cxl_event_data_storage) != 32);
644         BUILD_BUG_ON(sizeof(struct cxl_event_afu_error) != 16);
645
646         if ((rc = alloc_chrdev_region(&cxl_dev, 0, CXL_NUM_MINORS, "cxl"))) {
647                 pr_err("Unable to allocate CXL major number: %i\n", rc);
648                 return rc;
649         }
650
651         pr_devel("CXL device allocated, MAJOR %i\n", MAJOR(cxl_dev));
652
653         cxl_class = class_create(THIS_MODULE, "cxl");
654         if (IS_ERR(cxl_class)) {
655                 pr_err("Unable to create CXL class\n");
656                 rc = PTR_ERR(cxl_class);
657                 goto err;
658         }
659         cxl_class->devnode = cxl_devnode;
660
661         return 0;
662
663 err:
664         unregister_chrdev_region(cxl_dev, CXL_NUM_MINORS);
665         return rc;
666 }
667
668 void cxl_file_exit(void)
669 {
670         unregister_chrdev_region(cxl_dev, CXL_NUM_MINORS);
671         class_destroy(cxl_class);
672 }