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