2 * Copyright 2014 IBM Corp.
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.
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>
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>
29 #define CXL_NUM_MINORS 256 /* Total to reserve */
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))
38 #define CXL_DEVT_AFU(dev) ((MINOR(dev) % CXL_DEV_MINORS - 1) / 3)
40 #define CXL_DEVT_IS_CARD(dev) (MINOR(dev) % CXL_DEV_MINORS == 0)
44 static struct class *cxl_class;
46 static int __afu_open(struct inode *inode, struct file *file, bool master)
50 struct cxl_context *ctx;
51 int adapter_num = CXL_DEVT_ADAPTER(inode->i_rdev);
52 int slice = CXL_DEVT_AFU(inode->i_rdev);
55 pr_devel("afu_open afu%i.%i\n", slice, adapter_num);
57 if (!(adapter = get_cxl_adapter(adapter_num)))
60 if (slice > adapter->slices)
63 spin_lock(&adapter->afu_list_lock);
64 if (!(afu = adapter->afu[slice])) {
65 spin_unlock(&adapter->afu_list_lock);
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
75 spin_unlock(&adapter->afu_list_lock);
77 if (!afu->current_mode)
80 if (!cxl_ops->link_ok(adapter, afu)) {
85 if (!(ctx = cxl_context_alloc())) {
90 rc = cxl_context_init(ctx, afu, master);
94 cxl_context_set_mapping(ctx, inode->i_mapping);
96 pr_devel("afu_open pe: %i\n", ctx->pe);
97 file->private_data = ctx;
99 /* indicate success */
103 /* release the ref taken earlier */
106 put_device(&adapter->dev);
110 int afu_open(struct inode *inode, struct file *file)
112 return __afu_open(inode, file, false);
115 static int afu_master_open(struct inode *inode, struct file *file)
117 return __afu_open(inode, file, true);
120 int afu_release(struct inode *inode, struct file *file)
122 struct cxl_context *ctx = file->private_data;
124 pr_devel("%s: closing cxl file descriptor. pe: %i\n",
126 cxl_context_detach(ctx);
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()
133 if (!ctx->kernelapi) {
134 mutex_lock(&ctx->mapping_lock);
136 mutex_unlock(&ctx->mapping_lock);
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
145 cxl_context_free(ctx);
150 static long afu_ioctl_start_work(struct cxl_context *ctx,
151 struct cxl_ioctl_start_work __user *uwork)
153 struct cxl_ioctl_start_work work;
157 pr_devel("%s: pe: %i\n", __func__, ctx->pe);
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)))
164 mutex_lock(&ctx->status_mutex);
165 if (ctx->status != OPENED) {
171 * if any of the reserved fields are set or any of the unused
172 * flags are set it's invalid
174 if (work.reserved1 || work.reserved2 || work.reserved3 ||
175 work.reserved4 || work.reserved5 || work.reserved6 ||
176 (work.flags & ~CXL_START_WORK_ALL)) {
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)) {
188 if ((rc = afu_register_irqs(ctx, work.num_interrupts)))
191 if (work.flags & CXL_START_WORK_AMR)
192 amr = work.amr & mfspr(SPRN_UAMOR);
194 ctx->mmio_err_ff = !!(work.flags & CXL_START_WORK_ERR_FF);
197 * Increment the mapped context count for adapter. This also checks
198 * if adapter_context_lock is taken.
200 rc = cxl_adapter_context_get(ctx->afu->adapter);
202 afu_release_irqs(ctx, ctx);
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.
215 ctx->pid = get_task_pid(current, PIDTYPE_PID);
217 /* acquire a reference to the task's mm */
218 ctx->mm = get_task_mm(current);
220 /* ensure this mm_struct can't be freed */
221 cxl_context_mm_count_get(ctx);
223 /* decrement the use count */
228 * Increment driver use count. Enables global TLBIs for hash
229 * and callbacks to handle the segment table
233 trace_cxl_attach(ctx, work.work_element_descriptor, work.num_interrupts, amr);
235 if ((rc = cxl_ops->attach_process(ctx, false, work.work_element_descriptor,
237 afu_release_irqs(ctx, ctx);
238 cxl_adapter_context_put(ctx->afu->adapter);
242 cxl_context_mm_count_put(ctx);
246 ctx->status = STARTED;
249 mutex_unlock(&ctx->status_mutex);
253 static long afu_ioctl_process_element(struct cxl_context *ctx,
256 pr_devel("%s: pe: %i\n", __func__, ctx->pe);
258 if (copy_to_user(upe, &ctx->external_pe, sizeof(__u32)))
264 static long afu_ioctl_get_afu_id(struct cxl_context *ctx,
265 struct cxl_afu_id __user *upafuid)
267 struct cxl_afu_id afuid = { 0 };
269 afuid.card_id = ctx->afu->adapter->adapter_num;
270 afuid.afu_offset = ctx->afu->slice;
271 afuid.afu_mode = ctx->afu->current_mode;
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;
277 if (copy_to_user(upafuid, &afuid, sizeof(afuid)))
283 long afu_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
285 struct cxl_context *ctx = file->private_data;
287 if (ctx->status == CLOSED)
290 if (!cxl_ops->link_ok(ctx->afu->adapter, ctx->afu))
293 pr_devel("afu_ioctl\n");
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 *)
306 static long afu_compat_ioctl(struct file *file, unsigned int cmd,
309 return afu_ioctl(file, cmd, arg);
312 int afu_mmap(struct file *file, struct vm_area_struct *vm)
314 struct cxl_context *ctx = file->private_data;
316 /* AFU must be started before we can MMIO */
317 if (ctx->status != STARTED)
320 if (!cxl_ops->link_ok(ctx->afu->adapter, ctx->afu))
323 return cxl_context_iomap(ctx, vm);
326 static inline bool ctx_event_pending(struct cxl_context *ctx)
328 if (ctx->pending_irq || ctx->pending_fault || ctx->pending_afu_err)
331 if (ctx->afu_driver_ops && atomic_read(&ctx->afu_driver_events))
337 unsigned int afu_poll(struct file *file, struct poll_table_struct *poll)
339 struct cxl_context *ctx = file->private_data;
344 poll_wait(file, &ctx->wq, poll);
346 pr_devel("afu_poll wait done pe: %i\n", ctx->pe);
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
355 spin_unlock_irqrestore(&ctx->lock, flags);
357 pr_devel("afu_poll pe: %i returning %#x\n", ctx->pe, mask);
362 static ssize_t afu_driver_event_copy(struct cxl_context *ctx,
364 struct cxl_event *event,
365 struct cxl_event_afu_driver_reserved *pl)
369 ctx->afu_driver_ops->event_delivered(ctx, pl, -EINVAL);
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);
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);
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);
393 ctx->afu_driver_ops->event_delivered(ctx, pl, 0); /* Success */
394 return event->header.size;
397 ssize_t afu_read(struct file *file, char __user *buf, size_t count,
400 struct cxl_context *ctx = file->private_data;
401 struct cxl_event_afu_driver_reserved *pl = NULL;
402 struct cxl_event event;
407 if (!cxl_ops->link_ok(ctx->afu->adapter, ctx->afu))
410 if (count < CXL_READ_MIN_SIZE)
413 spin_lock_irqsave(&ctx->lock, flags);
416 prepare_to_wait(&ctx->wq, &wait, TASK_INTERRUPTIBLE);
417 if (ctx_event_pending(ctx) || (ctx->status == CLOSED))
420 if (!cxl_ops->link_ok(ctx->afu->adapter, ctx->afu)) {
425 if (file->f_flags & O_NONBLOCK) {
430 if (signal_pending(current)) {
435 spin_unlock_irqrestore(&ctx->lock, flags);
436 pr_devel("afu_read going to sleep...\n");
438 pr_devel("afu_read woken up\n");
439 spin_lock_irqsave(&ctx->lock, flags);
442 finish_wait(&ctx->wq, &wait);
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);
478 WARN(1, "afu_read must be buggy\n");
480 spin_unlock_irqrestore(&ctx->lock, flags);
482 if (event.header.type == CXL_EVENT_AFU_DRIVER)
483 return afu_driver_event_copy(ctx, buf, &event, pl);
485 if (copy_to_user(buf, &event, event.header.size))
487 return event.header.size;
490 finish_wait(&ctx->wq, &wait);
491 spin_unlock_irqrestore(&ctx->lock, flags);
496 * Note: if this is updated, we need to update api.c to patch the new ones in
499 const struct file_operations afu_fops = {
500 .owner = THIS_MODULE,
504 .release = afu_release,
505 .unlocked_ioctl = afu_ioctl,
506 .compat_ioctl = afu_compat_ioctl,
510 static const struct file_operations afu_master_fops = {
511 .owner = THIS_MODULE,
512 .open = afu_master_open,
515 .release = afu_release,
516 .unlocked_ioctl = afu_ioctl,
517 .compat_ioctl = afu_compat_ioctl,
522 static char *cxl_devnode(struct device *dev, umode_t *mode)
524 if (cpu_has_feature(CPU_FTR_HVMODE) &&
525 CXL_DEVT_IS_CARD(dev->devt)) {
527 * These minor numbers will eventually be used to program the
528 * PSL and AFUs once we have dynamic reprogramming support
532 return kasprintf(GFP_KERNEL, "cxl/%s", dev_name(dev));
535 extern struct class *cxl_class;
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)
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);
550 dev = device_create(cxl_class, &afu->dev, devt, afu,
551 "afu%i.%i%s", afu->adapter->adapter_num, afu->slice, postfix);
553 dev_err(&afu->dev, "Unable to create %s chardev in sysfs: %i\n", desc, rc);
566 int cxl_chardev_d_afu_add(struct cxl_afu *afu)
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 */
573 int cxl_chardev_m_afu_add(struct cxl_afu *afu)
575 return cxl_add_chardev(afu, CXL_AFU_MKDEV_M(afu), &afu->afu_cdev_m,
576 &afu->chardev_m, "m", "master",
580 int cxl_chardev_s_afu_add(struct cxl_afu *afu)
582 return cxl_add_chardev(afu, CXL_AFU_MKDEV_S(afu), &afu->afu_cdev_s,
583 &afu->chardev_s, "s", "shared",
587 void cxl_chardev_afu_remove(struct cxl_afu *afu)
589 if (afu->chardev_d) {
590 cdev_del(&afu->afu_cdev_d);
591 device_unregister(afu->chardev_d);
592 afu->chardev_d = NULL;
594 if (afu->chardev_m) {
595 cdev_del(&afu->afu_cdev_m);
596 device_unregister(afu->chardev_m);
597 afu->chardev_m = NULL;
599 if (afu->chardev_s) {
600 cdev_del(&afu->afu_cdev_s);
601 device_unregister(afu->chardev_s);
602 afu->chardev_s = NULL;
606 int cxl_register_afu(struct cxl_afu *afu)
608 afu->dev.class = cxl_class;
610 return device_register(&afu->dev);
613 int cxl_register_adapter(struct cxl *adapter)
615 adapter->dev.class = cxl_class;
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);
623 return device_register(&adapter->dev);
626 dev_t cxl_get_dev(void)
631 int __init cxl_file_init(void)
636 * If these change we really need to update API. Either change some
637 * flags or update API version number CXL_API_VERSION.
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);
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);
651 pr_devel("CXL device allocated, MAJOR %i\n", MAJOR(cxl_dev));
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);
659 cxl_class->devnode = cxl_devnode;
664 unregister_chrdev_region(cxl_dev, CXL_NUM_MINORS);
668 void cxl_file_exit(void)
670 unregister_chrdev_region(cxl_dev, CXL_NUM_MINORS);
671 class_destroy(cxl_class);