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.h>
16 #include <linux/poll.h>
17 #include <linux/pid.h>
20 #include <linux/slab.h>
21 #include <asm/cputable.h>
22 #include <asm/current.h>
23 #include <asm/copro.h>
28 #define CXL_NUM_MINORS 256 /* Total to reserve */
29 #define CXL_DEV_MINORS 13 /* 1 control + 4 AFUs * 3 (dedicated/master/shared) */
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))
39 #define CXL_DEVT_ADAPTER(dev) (MINOR(dev) / CXL_DEV_MINORS)
40 #define CXL_DEVT_AFU(dev) ((MINOR(dev) % CXL_DEV_MINORS - 1) / 3)
42 #define CXL_DEVT_IS_CARD(dev) (MINOR(dev) % CXL_DEV_MINORS == 0)
46 static struct class *cxl_class
;
48 static int __afu_open(struct inode
*inode
, struct file
*file
, bool master
)
52 struct cxl_context
*ctx
;
53 int adapter_num
= CXL_DEVT_ADAPTER(inode
->i_rdev
);
54 int slice
= CXL_DEVT_AFU(inode
->i_rdev
);
57 pr_devel("afu_open afu%i.%i\n", slice
, adapter_num
);
59 if (!(adapter
= get_cxl_adapter(adapter_num
)))
62 if (slice
> adapter
->slices
)
65 spin_lock(&adapter
->afu_list_lock
);
66 if (!(afu
= adapter
->afu
[slice
])) {
67 spin_unlock(&adapter
->afu_list_lock
);
70 get_device(&afu
->dev
);
71 spin_unlock(&adapter
->afu_list_lock
);
73 if (!afu
->current_mode
)
76 if (!cxl_adapter_link_ok(adapter
)) {
81 if (!(ctx
= cxl_context_alloc())) {
86 if ((rc
= cxl_context_init(ctx
, afu
, master
, inode
->i_mapping
)))
89 pr_devel("afu_open pe: %i\n", ctx
->pe
);
90 file
->private_data
= ctx
;
93 /* Our ref on the AFU will now hold the adapter */
94 put_device(&adapter
->dev
);
99 put_device(&afu
->dev
);
101 put_device(&adapter
->dev
);
105 int afu_open(struct inode
*inode
, struct file
*file
)
107 return __afu_open(inode
, file
, false);
110 static int afu_master_open(struct inode
*inode
, struct file
*file
)
112 return __afu_open(inode
, file
, true);
115 int afu_release(struct inode
*inode
, struct file
*file
)
117 struct cxl_context
*ctx
= file
->private_data
;
119 pr_devel("%s: closing cxl file descriptor. pe: %i\n",
121 cxl_context_detach(ctx
);
123 mutex_lock(&ctx
->mapping_lock
);
125 mutex_unlock(&ctx
->mapping_lock
);
127 put_device(&ctx
->afu
->dev
);
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
135 cxl_context_free(ctx
);
140 static long afu_ioctl_start_work(struct cxl_context
*ctx
,
141 struct cxl_ioctl_start_work __user
*uwork
)
143 struct cxl_ioctl_start_work work
;
147 pr_devel("%s: pe: %i\n", __func__
, ctx
->pe
);
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
))) {
157 mutex_lock(&ctx
->status_mutex
);
158 if (ctx
->status
!= OPENED
) {
164 * if any of the reserved fields are set or any of the unused
165 * flags are set it's invalid
167 if (work
.reserved1
|| work
.reserved2
|| work
.reserved3
||
168 work
.reserved4
|| work
.reserved5
|| work
.reserved6
||
169 (work
.flags
& ~CXL_START_WORK_ALL
)) {
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
)) {
181 if ((rc
= afu_register_irqs(ctx
, work
.num_interrupts
)))
184 if (work
.flags
& CXL_START_WORK_AMR
)
185 amr
= work
.amr
& mfspr(SPRN_UAMOR
);
188 * We grab the PID here and not in the file open to allow for the case
189 * where a process (master, some daemon, etc) has opened the chardev on
190 * behalf of another process, so the AFU's mm gets bound to the process
191 * that performs this ioctl and not the process that opened the file.
193 ctx
->pid
= get_pid(get_task_pid(current
, PIDTYPE_PID
));
195 trace_cxl_attach(ctx
, work
.work_element_descriptor
, work
.num_interrupts
, amr
);
197 if ((rc
= cxl_attach_process(ctx
, false, work
.work_element_descriptor
,
199 afu_release_irqs(ctx
, ctx
);
203 ctx
->status
= STARTED
;
206 mutex_unlock(&ctx
->status_mutex
);
209 static long afu_ioctl_process_element(struct cxl_context
*ctx
,
212 pr_devel("%s: pe: %i\n", __func__
, ctx
->pe
);
214 if (copy_to_user(upe
, &ctx
->pe
, sizeof(__u32
)))
220 static long afu_ioctl_get_afu_id(struct cxl_context
*ctx
,
221 struct cxl_afu_id __user
*upafuid
)
223 struct cxl_afu_id afuid
= { 0 };
225 afuid
.card_id
= ctx
->afu
->adapter
->adapter_num
;
226 afuid
.afu_offset
= ctx
->afu
->slice
;
227 afuid
.afu_mode
= ctx
->afu
->current_mode
;
229 /* set the flag bit in case the afu is a slave */
230 if (ctx
->afu
->current_mode
== CXL_MODE_DIRECTED
&& !ctx
->master
)
231 afuid
.flags
|= CXL_AFUID_FLAG_SLAVE
;
233 if (copy_to_user(upafuid
, &afuid
, sizeof(afuid
)))
239 long afu_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
241 struct cxl_context
*ctx
= file
->private_data
;
243 if (ctx
->status
== CLOSED
)
246 if (!cxl_adapter_link_ok(ctx
->afu
->adapter
))
249 pr_devel("afu_ioctl\n");
251 case CXL_IOCTL_START_WORK
:
252 return afu_ioctl_start_work(ctx
, (struct cxl_ioctl_start_work __user
*)arg
);
253 case CXL_IOCTL_GET_PROCESS_ELEMENT
:
254 return afu_ioctl_process_element(ctx
, (__u32 __user
*)arg
);
255 case CXL_IOCTL_GET_AFU_ID
:
256 return afu_ioctl_get_afu_id(ctx
, (struct cxl_afu_id __user
*)
262 static long afu_compat_ioctl(struct file
*file
, unsigned int cmd
,
265 return afu_ioctl(file
, cmd
, arg
);
268 int afu_mmap(struct file
*file
, struct vm_area_struct
*vm
)
270 struct cxl_context
*ctx
= file
->private_data
;
272 /* AFU must be started before we can MMIO */
273 if (ctx
->status
!= STARTED
)
276 if (!cxl_adapter_link_ok(ctx
->afu
->adapter
))
279 return cxl_context_iomap(ctx
, vm
);
282 unsigned int afu_poll(struct file
*file
, struct poll_table_struct
*poll
)
284 struct cxl_context
*ctx
= file
->private_data
;
289 poll_wait(file
, &ctx
->wq
, poll
);
291 pr_devel("afu_poll wait done pe: %i\n", ctx
->pe
);
293 spin_lock_irqsave(&ctx
->lock
, flags
);
294 if (ctx
->pending_irq
|| ctx
->pending_fault
||
295 ctx
->pending_afu_err
)
296 mask
|= POLLIN
| POLLRDNORM
;
297 else if (ctx
->status
== CLOSED
)
298 /* Only error on closed when there are no futher events pending
301 spin_unlock_irqrestore(&ctx
->lock
, flags
);
303 pr_devel("afu_poll pe: %i returning %#x\n", ctx
->pe
, mask
);
308 static inline int ctx_event_pending(struct cxl_context
*ctx
)
310 return (ctx
->pending_irq
|| ctx
->pending_fault
||
311 ctx
->pending_afu_err
|| (ctx
->status
== CLOSED
));
314 ssize_t
afu_read(struct file
*file
, char __user
*buf
, size_t count
,
317 struct cxl_context
*ctx
= file
->private_data
;
318 struct cxl_event event
;
323 if (!cxl_adapter_link_ok(ctx
->afu
->adapter
))
326 if (count
< CXL_READ_MIN_SIZE
)
329 spin_lock_irqsave(&ctx
->lock
, flags
);
332 prepare_to_wait(&ctx
->wq
, &wait
, TASK_INTERRUPTIBLE
);
333 if (ctx_event_pending(ctx
))
336 if (!cxl_adapter_link_ok(ctx
->afu
->adapter
)) {
341 if (file
->f_flags
& O_NONBLOCK
) {
346 if (signal_pending(current
)) {
351 spin_unlock_irqrestore(&ctx
->lock
, flags
);
352 pr_devel("afu_read going to sleep...\n");
354 pr_devel("afu_read woken up\n");
355 spin_lock_irqsave(&ctx
->lock
, flags
);
358 finish_wait(&ctx
->wq
, &wait
);
360 memset(&event
, 0, sizeof(event
));
361 event
.header
.process_element
= ctx
->pe
;
362 event
.header
.size
= sizeof(struct cxl_event_header
);
363 if (ctx
->pending_irq
) {
364 pr_devel("afu_read delivering AFU interrupt\n");
365 event
.header
.size
+= sizeof(struct cxl_event_afu_interrupt
);
366 event
.header
.type
= CXL_EVENT_AFU_INTERRUPT
;
367 event
.irq
.irq
= find_first_bit(ctx
->irq_bitmap
, ctx
->irq_count
) + 1;
368 clear_bit(event
.irq
.irq
- 1, ctx
->irq_bitmap
);
369 if (bitmap_empty(ctx
->irq_bitmap
, ctx
->irq_count
))
370 ctx
->pending_irq
= false;
371 } else if (ctx
->pending_fault
) {
372 pr_devel("afu_read delivering data storage fault\n");
373 event
.header
.size
+= sizeof(struct cxl_event_data_storage
);
374 event
.header
.type
= CXL_EVENT_DATA_STORAGE
;
375 event
.fault
.addr
= ctx
->fault_addr
;
376 event
.fault
.dsisr
= ctx
->fault_dsisr
;
377 ctx
->pending_fault
= false;
378 } else if (ctx
->pending_afu_err
) {
379 pr_devel("afu_read delivering afu error\n");
380 event
.header
.size
+= sizeof(struct cxl_event_afu_error
);
381 event
.header
.type
= CXL_EVENT_AFU_ERROR
;
382 event
.afu_error
.error
= ctx
->afu_err
;
383 ctx
->pending_afu_err
= false;
384 } else if (ctx
->status
== CLOSED
) {
385 pr_devel("afu_read fatal error\n");
386 spin_unlock_irqrestore(&ctx
->lock
, flags
);
389 WARN(1, "afu_read must be buggy\n");
391 spin_unlock_irqrestore(&ctx
->lock
, flags
);
393 if (copy_to_user(buf
, &event
, event
.header
.size
))
395 return event
.header
.size
;
398 finish_wait(&ctx
->wq
, &wait
);
399 spin_unlock_irqrestore(&ctx
->lock
, flags
);
404 * Note: if this is updated, we need to update api.c to patch the new ones in
407 const struct file_operations afu_fops
= {
408 .owner
= THIS_MODULE
,
412 .release
= afu_release
,
413 .unlocked_ioctl
= afu_ioctl
,
414 .compat_ioctl
= afu_compat_ioctl
,
418 static const struct file_operations afu_master_fops
= {
419 .owner
= THIS_MODULE
,
420 .open
= afu_master_open
,
423 .release
= afu_release
,
424 .unlocked_ioctl
= afu_ioctl
,
425 .compat_ioctl
= afu_compat_ioctl
,
430 static char *cxl_devnode(struct device
*dev
, umode_t
*mode
)
432 if (CXL_DEVT_IS_CARD(dev
->devt
)) {
434 * These minor numbers will eventually be used to program the
435 * PSL and AFUs once we have dynamic reprogramming support
439 return kasprintf(GFP_KERNEL
, "cxl/%s", dev_name(dev
));
442 extern struct class *cxl_class
;
444 static int cxl_add_chardev(struct cxl_afu
*afu
, dev_t devt
, struct cdev
*cdev
,
445 struct device
**chardev
, char *postfix
, char *desc
,
446 const struct file_operations
*fops
)
451 cdev_init(cdev
, fops
);
452 if ((rc
= cdev_add(cdev
, devt
, 1))) {
453 dev_err(&afu
->dev
, "Unable to add %s chardev: %i\n", desc
, rc
);
457 dev
= device_create(cxl_class
, &afu
->dev
, devt
, afu
,
458 "afu%i.%i%s", afu
->adapter
->adapter_num
, afu
->slice
, postfix
);
460 dev_err(&afu
->dev
, "Unable to create %s chardev in sysfs: %i\n", desc
, rc
);
473 int cxl_chardev_d_afu_add(struct cxl_afu
*afu
)
475 return cxl_add_chardev(afu
, CXL_AFU_MKDEV_D(afu
), &afu
->afu_cdev_d
,
476 &afu
->chardev_d
, "d", "dedicated",
477 &afu_master_fops
); /* Uses master fops */
480 int cxl_chardev_m_afu_add(struct cxl_afu
*afu
)
482 return cxl_add_chardev(afu
, CXL_AFU_MKDEV_M(afu
), &afu
->afu_cdev_m
,
483 &afu
->chardev_m
, "m", "master",
487 int cxl_chardev_s_afu_add(struct cxl_afu
*afu
)
489 return cxl_add_chardev(afu
, CXL_AFU_MKDEV_S(afu
), &afu
->afu_cdev_s
,
490 &afu
->chardev_s
, "s", "shared",
494 void cxl_chardev_afu_remove(struct cxl_afu
*afu
)
496 if (afu
->chardev_d
) {
497 cdev_del(&afu
->afu_cdev_d
);
498 device_unregister(afu
->chardev_d
);
499 afu
->chardev_d
= NULL
;
501 if (afu
->chardev_m
) {
502 cdev_del(&afu
->afu_cdev_m
);
503 device_unregister(afu
->chardev_m
);
504 afu
->chardev_m
= NULL
;
506 if (afu
->chardev_s
) {
507 cdev_del(&afu
->afu_cdev_s
);
508 device_unregister(afu
->chardev_s
);
509 afu
->chardev_s
= NULL
;
513 int cxl_register_afu(struct cxl_afu
*afu
)
515 afu
->dev
.class = cxl_class
;
517 return device_register(&afu
->dev
);
520 int cxl_register_adapter(struct cxl
*adapter
)
522 adapter
->dev
.class = cxl_class
;
525 * Future: When we support dynamically reprogramming the PSL & AFU we
526 * will expose the interface to do that via a chardev:
527 * adapter->dev.devt = CXL_CARD_MKDEV(adapter);
530 return device_register(&adapter
->dev
);
533 int __init
cxl_file_init(void)
538 * If these change we really need to update API. Either change some
539 * flags or update API version number CXL_API_VERSION.
541 BUILD_BUG_ON(CXL_API_VERSION
!= 1);
542 BUILD_BUG_ON(sizeof(struct cxl_ioctl_start_work
) != 64);
543 BUILD_BUG_ON(sizeof(struct cxl_event_header
) != 8);
544 BUILD_BUG_ON(sizeof(struct cxl_event_afu_interrupt
) != 8);
545 BUILD_BUG_ON(sizeof(struct cxl_event_data_storage
) != 32);
546 BUILD_BUG_ON(sizeof(struct cxl_event_afu_error
) != 16);
548 if ((rc
= alloc_chrdev_region(&cxl_dev
, 0, CXL_NUM_MINORS
, "cxl"))) {
549 pr_err("Unable to allocate CXL major number: %i\n", rc
);
553 pr_devel("CXL device allocated, MAJOR %i\n", MAJOR(cxl_dev
));
555 cxl_class
= class_create(THIS_MODULE
, "cxl");
556 if (IS_ERR(cxl_class
)) {
557 pr_err("Unable to create CXL class\n");
558 rc
= PTR_ERR(cxl_class
);
561 cxl_class
->devnode
= cxl_devnode
;
566 unregister_chrdev_region(cxl_dev
, CXL_NUM_MINORS
);
570 void cxl_file_exit(void)
572 unregister_chrdev_region(cxl_dev
, CXL_NUM_MINORS
);
573 class_destroy(cxl_class
);