1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * PowerNV OPAL Dump Interface
5 * Copyright 2013,2014 IBM Corp.
8 #include <linux/kobject.h>
10 #include <linux/slab.h>
11 #include <linux/vmalloc.h>
12 #include <linux/pagemap.h>
13 #include <linux/delay.h>
14 #include <linux/interrupt.h>
18 #define DUMP_TYPE_FSP 0x01
22 struct bin_attribute dump_attr;
23 uint32_t id; /* becomes object name */
28 #define to_dump_obj(x) container_of(x, struct dump_obj, kobj)
30 struct dump_attribute {
31 struct attribute attr;
32 ssize_t (*show)(struct dump_obj *dump, struct dump_attribute *attr,
34 ssize_t (*store)(struct dump_obj *dump, struct dump_attribute *attr,
35 const char *buf, size_t count);
37 #define to_dump_attr(x) container_of(x, struct dump_attribute, attr)
39 static ssize_t dump_id_show(struct dump_obj *dump_obj,
40 struct dump_attribute *attr,
43 return sprintf(buf, "0x%x\n", dump_obj->id);
46 static const char* dump_type_to_string(uint32_t type)
49 case 0x01: return "SP Dump";
50 case 0x02: return "System/Platform Dump";
51 case 0x03: return "SMA Dump";
52 default: return "unknown";
56 static ssize_t dump_type_show(struct dump_obj *dump_obj,
57 struct dump_attribute *attr,
61 return sprintf(buf, "0x%x %s\n", dump_obj->type,
62 dump_type_to_string(dump_obj->type));
65 static ssize_t dump_ack_show(struct dump_obj *dump_obj,
66 struct dump_attribute *attr,
69 return sprintf(buf, "ack - acknowledge dump\n");
73 * Send acknowledgement to OPAL
75 static int64_t dump_send_ack(uint32_t dump_id)
79 rc = opal_dump_ack(dump_id);
81 pr_warn("%s: Failed to send ack to Dump ID 0x%x (%d)\n",
82 __func__, dump_id, rc);
86 static ssize_t dump_ack_store(struct dump_obj *dump_obj,
87 struct dump_attribute *attr,
91 dump_send_ack(dump_obj->id);
92 sysfs_remove_file_self(&dump_obj->kobj, &attr->attr);
93 kobject_put(&dump_obj->kobj);
97 /* Attributes of a dump
98 * The binary attribute of the dump itself is dynamic
99 * due to the dynamic size of the dump
101 static struct dump_attribute id_attribute =
102 __ATTR(id, 0444, dump_id_show, NULL);
103 static struct dump_attribute type_attribute =
104 __ATTR(type, 0444, dump_type_show, NULL);
105 static struct dump_attribute ack_attribute =
106 __ATTR(acknowledge, 0660, dump_ack_show, dump_ack_store);
108 static ssize_t init_dump_show(struct dump_obj *dump_obj,
109 struct dump_attribute *attr,
112 return sprintf(buf, "1 - initiate Service Processor(FSP) dump\n");
115 static int64_t dump_fips_init(uint8_t type)
119 rc = opal_dump_init(type);
121 pr_warn("%s: Failed to initiate FSP dump (%d)\n",
126 static ssize_t init_dump_store(struct dump_obj *dump_obj,
127 struct dump_attribute *attr,
133 rc = dump_fips_init(DUMP_TYPE_FSP);
134 if (rc == OPAL_SUCCESS)
135 pr_info("%s: Initiated FSP dump\n", __func__);
140 static struct dump_attribute initiate_attribute =
141 __ATTR(initiate_dump, 0600, init_dump_show, init_dump_store);
143 static struct attribute *initiate_attrs[] = {
144 &initiate_attribute.attr,
148 static struct attribute_group initiate_attr_group = {
149 .attrs = initiate_attrs,
152 static struct kset *dump_kset;
154 static ssize_t dump_attr_show(struct kobject *kobj,
155 struct attribute *attr,
158 struct dump_attribute *attribute;
159 struct dump_obj *dump;
161 attribute = to_dump_attr(attr);
162 dump = to_dump_obj(kobj);
164 if (!attribute->show)
167 return attribute->show(dump, attribute, buf);
170 static ssize_t dump_attr_store(struct kobject *kobj,
171 struct attribute *attr,
172 const char *buf, size_t len)
174 struct dump_attribute *attribute;
175 struct dump_obj *dump;
177 attribute = to_dump_attr(attr);
178 dump = to_dump_obj(kobj);
180 if (!attribute->store)
183 return attribute->store(dump, attribute, buf, len);
186 static const struct sysfs_ops dump_sysfs_ops = {
187 .show = dump_attr_show,
188 .store = dump_attr_store,
191 static void dump_release(struct kobject *kobj)
193 struct dump_obj *dump;
195 dump = to_dump_obj(kobj);
200 static struct attribute *dump_default_attrs[] = {
202 &type_attribute.attr,
207 static struct kobj_type dump_ktype = {
208 .sysfs_ops = &dump_sysfs_ops,
209 .release = &dump_release,
210 .default_attrs = dump_default_attrs,
213 static int64_t dump_read_info(uint32_t *dump_id, uint32_t *dump_size, uint32_t *dump_type)
215 __be32 id, size, type;
218 type = cpu_to_be32(0xffffffff);
220 rc = opal_dump_info2(&id, &size, &type);
221 if (rc == OPAL_PARAMETER)
222 rc = opal_dump_info(&id, &size);
225 pr_warn("%s: Failed to get dump info (%d)\n",
230 *dump_id = be32_to_cpu(id);
231 *dump_size = be32_to_cpu(size);
232 *dump_type = be32_to_cpu(type);
237 static int64_t dump_read_data(struct dump_obj *dump)
239 struct opal_sg_list *list;
243 /* Allocate memory */
244 dump->buffer = vzalloc(PAGE_ALIGN(dump->size));
246 pr_err("%s : Failed to allocate memory\n", __func__);
251 /* Generate SG list */
252 list = opal_vmalloc_to_sg_list(dump->buffer, dump->size);
258 /* First entry address */
262 rc = OPAL_BUSY_EVENT;
263 while (rc == OPAL_BUSY || rc == OPAL_BUSY_EVENT) {
264 rc = opal_dump_read(dump->id, addr);
265 if (rc == OPAL_BUSY_EVENT) {
266 opal_poll_events(NULL);
271 if (rc != OPAL_SUCCESS && rc != OPAL_PARTIAL)
272 pr_warn("%s: Extract dump failed for ID 0x%x\n",
276 opal_free_sg_list(list);
282 static ssize_t dump_attr_read(struct file *filep, struct kobject *kobj,
283 struct bin_attribute *bin_attr,
284 char *buffer, loff_t pos, size_t count)
288 struct dump_obj *dump = to_dump_obj(kobj);
291 rc = dump_read_data(dump);
293 if (rc != OPAL_SUCCESS && rc != OPAL_PARTIAL) {
299 if (rc == OPAL_PARTIAL) {
300 /* On a partial read, we just return EIO
301 * and rely on userspace to ask us to try
304 pr_info("%s: Platform dump partially read. ID = 0x%x\n",
310 memcpy(buffer, dump->buffer + pos, count);
312 /* You may think we could free the dump buffer now and retrieve
313 * it again later if needed, but due to current firmware limitation,
314 * that's not the case. So, once read into userspace once,
315 * we keep the dump around until it's acknowledged by userspace.
321 static struct dump_obj *create_dump_obj(uint32_t id, size_t size,
324 struct dump_obj *dump;
327 dump = kzalloc(sizeof(*dump), GFP_KERNEL);
331 dump->kobj.kset = dump_kset;
333 kobject_init(&dump->kobj, &dump_ktype);
335 sysfs_bin_attr_init(&dump->dump_attr);
337 dump->dump_attr.attr.name = "dump";
338 dump->dump_attr.attr.mode = 0400;
339 dump->dump_attr.size = size;
340 dump->dump_attr.read = dump_attr_read;
346 rc = kobject_add(&dump->kobj, NULL, "0x%x-0x%x", type, id);
348 kobject_put(&dump->kobj);
352 rc = sysfs_create_bin_file(&dump->kobj, &dump->dump_attr);
354 kobject_put(&dump->kobj);
358 pr_info("%s: New platform dump. ID = 0x%x Size %u\n",
359 __func__, dump->id, dump->size);
361 kobject_uevent(&dump->kobj, KOBJ_ADD);
366 static irqreturn_t process_dump(int irq, void *data)
369 uint32_t dump_id, dump_size, dump_type;
371 struct kobject *kobj;
373 rc = dump_read_info(&dump_id, &dump_size, &dump_type);
374 if (rc != OPAL_SUCCESS)
377 sprintf(name, "0x%x-0x%x", dump_type, dump_id);
379 /* we may get notified twice, let's handle
380 * that gracefully and not create two conflicting
383 kobj = kset_find_obj(dump_kset, name);
385 /* Drop reference added by kset_find_obj() */
390 create_dump_obj(dump_id, dump_size, dump_type);
395 void __init opal_platform_dump_init(void)
400 /* ELOG not supported by firmware */
401 if (!opal_check_token(OPAL_DUMP_READ))
404 dump_kset = kset_create_and_add("dump", NULL, opal_kobj);
406 pr_warn("%s: Failed to create dump kset\n", __func__);
410 rc = sysfs_create_group(&dump_kset->kobj, &initiate_attr_group);
412 pr_warn("%s: Failed to create initiate dump attr group\n",
414 kobject_put(&dump_kset->kobj);
418 dump_irq = opal_event_request(ilog2(OPAL_EVENT_DUMP_AVAIL));
420 pr_err("%s: Can't register OPAL event irq (%d)\n",
425 rc = request_threaded_irq(dump_irq, NULL, process_dump,
426 IRQF_TRIGGER_HIGH | IRQF_ONESHOT,
429 pr_err("%s: Can't request OPAL event irq (%d)\n",
434 if (opal_check_token(OPAL_DUMP_RESEND))
435 opal_dump_resend_notification();