2 * PowerNV OPAL Dump Interface
4 * Copyright 2013,2014 IBM Corp.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
12 #include <linux/kobject.h>
14 #include <linux/slab.h>
15 #include <linux/vmalloc.h>
16 #include <linux/pagemap.h>
17 #include <linux/delay.h>
21 #define DUMP_TYPE_FSP 0x01
25 struct bin_attribute dump_attr;
26 uint32_t id; /* becomes object name */
31 #define to_dump_obj(x) container_of(x, struct dump_obj, kobj)
33 struct dump_attribute {
34 struct attribute attr;
35 ssize_t (*show)(struct dump_obj *dump, struct dump_attribute *attr,
37 ssize_t (*store)(struct dump_obj *dump, struct dump_attribute *attr,
38 const char *buf, size_t count);
40 #define to_dump_attr(x) container_of(x, struct dump_attribute, attr)
42 static ssize_t dump_id_show(struct dump_obj *dump_obj,
43 struct dump_attribute *attr,
46 return sprintf(buf, "0x%x\n", dump_obj->id);
49 static const char* dump_type_to_string(uint32_t type)
52 case 0x01: return "SP Dump";
53 case 0x02: return "System/Platform Dump";
54 case 0x03: return "SMA Dump";
55 default: return "unknown";
59 static ssize_t dump_type_show(struct dump_obj *dump_obj,
60 struct dump_attribute *attr,
64 return sprintf(buf, "0x%x %s\n", dump_obj->type,
65 dump_type_to_string(dump_obj->type));
68 static ssize_t dump_ack_show(struct dump_obj *dump_obj,
69 struct dump_attribute *attr,
72 return sprintf(buf, "ack - acknowledge dump\n");
76 * Send acknowledgement to OPAL
78 static int64_t dump_send_ack(uint32_t dump_id)
82 rc = opal_dump_ack(dump_id);
84 pr_warn("%s: Failed to send ack to Dump ID 0x%x (%d)\n",
85 __func__, dump_id, rc);
89 static ssize_t dump_ack_store(struct dump_obj *dump_obj,
90 struct dump_attribute *attr,
94 dump_send_ack(dump_obj->id);
95 sysfs_remove_file_self(&dump_obj->kobj, &attr->attr);
96 kobject_put(&dump_obj->kobj);
100 /* Attributes of a dump
101 * The binary attribute of the dump itself is dynamic
102 * due to the dynamic size of the dump
104 static struct dump_attribute id_attribute =
105 __ATTR(id, S_IRUGO, dump_id_show, NULL);
106 static struct dump_attribute type_attribute =
107 __ATTR(type, S_IRUGO, dump_type_show, NULL);
108 static struct dump_attribute ack_attribute =
109 __ATTR(acknowledge, 0660, dump_ack_show, dump_ack_store);
111 static ssize_t init_dump_show(struct dump_obj *dump_obj,
112 struct dump_attribute *attr,
115 return sprintf(buf, "1 - initiate Service Processor(FSP) dump\n");
118 static int64_t dump_fips_init(uint8_t type)
122 rc = opal_dump_init(type);
124 pr_warn("%s: Failed to initiate FSP dump (%d)\n",
129 static ssize_t init_dump_store(struct dump_obj *dump_obj,
130 struct dump_attribute *attr,
136 rc = dump_fips_init(DUMP_TYPE_FSP);
137 if (rc == OPAL_SUCCESS)
138 pr_info("%s: Initiated FSP dump\n", __func__);
143 static struct dump_attribute initiate_attribute =
144 __ATTR(initiate_dump, 0600, init_dump_show, init_dump_store);
146 static struct attribute *initiate_attrs[] = {
147 &initiate_attribute.attr,
151 static struct attribute_group initiate_attr_group = {
152 .attrs = initiate_attrs,
155 static struct kset *dump_kset;
157 static ssize_t dump_attr_show(struct kobject *kobj,
158 struct attribute *attr,
161 struct dump_attribute *attribute;
162 struct dump_obj *dump;
164 attribute = to_dump_attr(attr);
165 dump = to_dump_obj(kobj);
167 if (!attribute->show)
170 return attribute->show(dump, attribute, buf);
173 static ssize_t dump_attr_store(struct kobject *kobj,
174 struct attribute *attr,
175 const char *buf, size_t len)
177 struct dump_attribute *attribute;
178 struct dump_obj *dump;
180 attribute = to_dump_attr(attr);
181 dump = to_dump_obj(kobj);
183 if (!attribute->store)
186 return attribute->store(dump, attribute, buf, len);
189 static const struct sysfs_ops dump_sysfs_ops = {
190 .show = dump_attr_show,
191 .store = dump_attr_store,
194 static void dump_release(struct kobject *kobj)
196 struct dump_obj *dump;
198 dump = to_dump_obj(kobj);
203 static struct attribute *dump_default_attrs[] = {
205 &type_attribute.attr,
210 static struct kobj_type dump_ktype = {
211 .sysfs_ops = &dump_sysfs_ops,
212 .release = &dump_release,
213 .default_attrs = dump_default_attrs,
216 static int64_t dump_read_info(uint32_t *dump_id, uint32_t *dump_size, uint32_t *dump_type)
218 __be32 id, size, type;
221 type = cpu_to_be32(0xffffffff);
223 rc = opal_dump_info2(&id, &size, &type);
224 if (rc == OPAL_PARAMETER)
225 rc = opal_dump_info(&id, &size);
227 *dump_id = be32_to_cpu(id);
228 *dump_size = be32_to_cpu(size);
229 *dump_type = be32_to_cpu(type);
232 pr_warn("%s: Failed to get dump info (%d)\n",
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 int process_dump(void)
369 uint32_t dump_id, dump_size, dump_type;
370 struct dump_obj *dump;
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 if (kset_find_obj(dump_kset, name))
386 dump = create_dump_obj(dump_id, dump_size, dump_type);
393 static void dump_work_fn(struct work_struct *work)
398 static DECLARE_WORK(dump_work, dump_work_fn);
400 static void schedule_process_dump(void)
402 schedule_work(&dump_work);
406 * New dump available notification
408 * Once we get notification, we add sysfs entries for it.
409 * We only fetch the dump on demand, and create sysfs asynchronously.
411 static int dump_event(struct notifier_block *nb,
412 unsigned long events, void *change)
414 if (events & OPAL_EVENT_DUMP_AVAIL)
415 schedule_process_dump();
420 static struct notifier_block dump_nb = {
421 .notifier_call = dump_event,
426 void __init opal_platform_dump_init(void)
430 /* ELOG not supported by firmware */
431 if (!opal_check_token(OPAL_DUMP_READ))
434 dump_kset = kset_create_and_add("dump", NULL, opal_kobj);
436 pr_warn("%s: Failed to create dump kset\n", __func__);
440 rc = sysfs_create_group(&dump_kset->kobj, &initiate_attr_group);
442 pr_warn("%s: Failed to create initiate dump attr group\n",
444 kobject_put(&dump_kset->kobj);
448 rc = opal_notifier_register(&dump_nb);
450 pr_warn("%s: Can't register OPAL event notifier (%d)\n",
455 opal_dump_resend_notification();