1 // SPDX-License-Identifier: GPL-2.0-only
3 * OPAL Runtime Diagnostics interface driver
4 * Supported on POWERNV platform
6 * Copyright IBM Corporation 2015
9 #define pr_fmt(fmt) "opal-prd: " fmt
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/platform_device.h>
14 #include <linux/miscdevice.h>
17 #include <linux/of_address.h>
18 #include <linux/poll.h>
20 #include <linux/slab.h>
21 #include <asm/opal-prd.h>
24 #include <linux/uaccess.h>
28 * The msg member must be at the end of the struct, as it's followed by the
31 struct opal_prd_msg_queue_item {
32 struct list_head list;
33 struct opal_prd_msg_header msg;
36 static struct device_node *prd_node;
37 static LIST_HEAD(opal_prd_msg_queue);
38 static DEFINE_SPINLOCK(opal_prd_msg_queue_lock);
39 static DECLARE_WAIT_QUEUE_HEAD(opal_prd_msg_wait);
40 static atomic_t prd_usage;
42 static bool opal_prd_range_is_valid(uint64_t addr, uint64_t size)
44 struct device_node *parent, *node;
47 if (addr + size < addr)
50 parent = of_find_node_by_path("/reserved-memory");
56 for_each_child_of_node(parent, node) {
57 uint64_t range_addr, range_size, range_end;
61 addrp = of_get_address(node, 0, &range_size, NULL);
63 range_addr = of_read_number(addrp, 2);
64 range_end = range_addr + range_size;
66 label = of_get_property(node, "ibm,prd-label", NULL);
68 /* PRD ranges need a label */
72 if (range_end <= range_addr)
75 if (addr >= range_addr && addr + size <= range_end) {
86 static int opal_prd_open(struct inode *inode, struct file *file)
89 * Prevent multiple (separate) processes from concurrent interactions
90 * with the FW PRD channel
92 if (atomic_xchg(&prd_usage, 1) == 1)
99 * opal_prd_mmap - maps firmware-provided ranges into userspace
100 * @file: file structure for the device
101 * @vma: VMA to map the registers into
104 static int opal_prd_mmap(struct file *file, struct vm_area_struct *vma)
109 pr_devel("opal_prd_mmap(0x%016lx, 0x%016lx, 0x%lx, 0x%lx)\n",
110 vma->vm_start, vma->vm_end, vma->vm_pgoff,
113 addr = vma->vm_pgoff << PAGE_SHIFT;
114 size = vma->vm_end - vma->vm_start;
116 /* ensure we're mapping within one of the allowable ranges */
117 if (!opal_prd_range_is_valid(addr, size))
120 page_prot = phys_mem_access_prot(file, vma->vm_pgoff,
121 size, vma->vm_page_prot);
123 return remap_pfn_range(vma, vma->vm_start, vma->vm_pgoff, size,
127 static bool opal_msg_queue_empty(void)
132 spin_lock_irqsave(&opal_prd_msg_queue_lock, flags);
133 ret = list_empty(&opal_prd_msg_queue);
134 spin_unlock_irqrestore(&opal_prd_msg_queue_lock, flags);
139 static __poll_t opal_prd_poll(struct file *file,
140 struct poll_table_struct *wait)
142 poll_wait(file, &opal_prd_msg_wait, wait);
144 if (!opal_msg_queue_empty())
145 return EPOLLIN | EPOLLRDNORM;
150 static ssize_t opal_prd_read(struct file *file, char __user *buf,
151 size_t count, loff_t *ppos)
153 struct opal_prd_msg_queue_item *item;
158 /* we need at least a header's worth of data */
159 if (count < sizeof(item->msg))
169 spin_lock_irqsave(&opal_prd_msg_queue_lock, flags);
170 if (!list_empty(&opal_prd_msg_queue)) {
171 item = list_first_entry(&opal_prd_msg_queue,
172 struct opal_prd_msg_queue_item, list);
173 list_del(&item->list);
175 spin_unlock_irqrestore(&opal_prd_msg_queue_lock, flags);
180 if (file->f_flags & O_NONBLOCK)
183 rc = wait_event_interruptible(opal_prd_msg_wait,
184 !opal_msg_queue_empty());
189 size = be16_to_cpu(item->msg.size);
195 rc = copy_to_user(buf, &item->msg, size);
206 /* eep! re-queue at the head of the list */
207 spin_lock_irqsave(&opal_prd_msg_queue_lock, flags);
208 list_add(&item->list, &opal_prd_msg_queue);
209 spin_unlock_irqrestore(&opal_prd_msg_queue_lock, flags);
213 static ssize_t opal_prd_write(struct file *file, const char __user *buf,
214 size_t count, loff_t *ppos)
216 struct opal_prd_msg_header hdr;
226 /* grab the header */
227 rc = copy_from_user(&hdr, buf, sizeof(hdr));
231 size = be16_to_cpu(hdr.size);
233 msg = memdup_user(buf, size);
237 rc = opal_prd_msg(msg);
239 pr_warn("write: opal_prd_msg returned %d\n", rc);
248 static int opal_prd_release(struct inode *inode, struct file *file)
250 struct opal_prd_msg_header msg;
252 msg.size = cpu_to_be16(sizeof(msg));
253 msg.type = OPAL_PRD_MSG_TYPE_FINI;
255 opal_prd_msg((struct opal_prd_msg *)&msg);
257 atomic_xchg(&prd_usage, 0);
262 static long opal_prd_ioctl(struct file *file, unsigned int cmd,
265 struct opal_prd_info info;
266 struct opal_prd_scom scom;
270 case OPAL_PRD_GET_INFO:
271 memset(&info, 0, sizeof(info));
272 info.version = OPAL_PRD_KERNEL_VERSION;
273 rc = copy_to_user((void __user *)param, &info, sizeof(info));
278 case OPAL_PRD_SCOM_READ:
279 rc = copy_from_user(&scom, (void __user *)param, sizeof(scom));
283 scom.rc = opal_xscom_read(scom.chip, scom.addr,
284 (__be64 *)&scom.data);
285 scom.data = be64_to_cpu(scom.data);
286 pr_devel("ioctl SCOM_READ: chip %llx addr %016llx data %016llx rc %lld\n",
287 scom.chip, scom.addr, scom.data, scom.rc);
289 rc = copy_to_user((void __user *)param, &scom, sizeof(scom));
294 case OPAL_PRD_SCOM_WRITE:
295 rc = copy_from_user(&scom, (void __user *)param, sizeof(scom));
299 scom.rc = opal_xscom_write(scom.chip, scom.addr, scom.data);
300 pr_devel("ioctl SCOM_WRITE: chip %llx addr %016llx data %016llx rc %lld\n",
301 scom.chip, scom.addr, scom.data, scom.rc);
303 rc = copy_to_user((void __user *)param, &scom, sizeof(scom));
315 static const struct file_operations opal_prd_fops = {
316 .open = opal_prd_open,
317 .mmap = opal_prd_mmap,
318 .poll = opal_prd_poll,
319 .read = opal_prd_read,
320 .write = opal_prd_write,
321 .unlocked_ioctl = opal_prd_ioctl,
322 .release = opal_prd_release,
323 .owner = THIS_MODULE,
326 static struct miscdevice opal_prd_dev = {
327 .minor = MISC_DYNAMIC_MINOR,
329 .fops = &opal_prd_fops,
333 static int opal_prd_msg_notifier(struct notifier_block *nb,
334 unsigned long msg_type, void *_msg)
336 struct opal_prd_msg_queue_item *item;
337 struct opal_prd_msg_header *hdr;
338 struct opal_msg *msg = _msg;
339 int msg_size, item_size;
342 if (msg_type != OPAL_MSG_PRD && msg_type != OPAL_MSG_PRD2)
345 /* Calculate total size of the message and item we need to store. The
346 * 'size' field in the header includes the header itself. */
347 hdr = (void *)msg->params;
348 msg_size = be16_to_cpu(hdr->size);
349 item_size = msg_size + sizeof(*item) - sizeof(item->msg);
351 item = kzalloc(item_size, GFP_ATOMIC);
355 memcpy(&item->msg, msg->params, msg_size);
357 spin_lock_irqsave(&opal_prd_msg_queue_lock, flags);
358 list_add_tail(&item->list, &opal_prd_msg_queue);
359 spin_unlock_irqrestore(&opal_prd_msg_queue_lock, flags);
361 wake_up_interruptible(&opal_prd_msg_wait);
366 static struct notifier_block opal_prd_event_nb = {
367 .notifier_call = opal_prd_msg_notifier,
372 static struct notifier_block opal_prd_event_nb2 = {
373 .notifier_call = opal_prd_msg_notifier,
378 static int opal_prd_probe(struct platform_device *pdev)
382 if (!pdev || !pdev->dev.of_node)
385 /* We should only have one prd driver instance per machine; ensure
386 * that we only get a valid probe on a single OF node.
391 prd_node = pdev->dev.of_node;
393 rc = opal_message_notifier_register(OPAL_MSG_PRD, &opal_prd_event_nb);
395 pr_err("Couldn't register event notifier\n");
399 rc = opal_message_notifier_register(OPAL_MSG_PRD2, &opal_prd_event_nb2);
401 pr_err("Couldn't register PRD2 event notifier\n");
402 opal_message_notifier_unregister(OPAL_MSG_PRD, &opal_prd_event_nb);
406 rc = misc_register(&opal_prd_dev);
408 pr_err("failed to register miscdev\n");
409 opal_message_notifier_unregister(OPAL_MSG_PRD,
411 opal_message_notifier_unregister(OPAL_MSG_PRD2,
412 &opal_prd_event_nb2);
419 static int opal_prd_remove(struct platform_device *pdev)
421 misc_deregister(&opal_prd_dev);
422 opal_message_notifier_unregister(OPAL_MSG_PRD, &opal_prd_event_nb);
423 opal_message_notifier_unregister(OPAL_MSG_PRD2, &opal_prd_event_nb2);
427 static const struct of_device_id opal_prd_match[] = {
428 { .compatible = "ibm,opal-prd" },
432 static struct platform_driver opal_prd_driver = {
435 .of_match_table = opal_prd_match,
437 .probe = opal_prd_probe,
438 .remove = opal_prd_remove,
441 module_platform_driver(opal_prd_driver);
443 MODULE_DEVICE_TABLE(of, opal_prd_match);
444 MODULE_DESCRIPTION("PowerNV OPAL runtime diagnostic driver");
445 MODULE_LICENSE("GPL");