linux/Documentation/ABI/stable
Stewart Smith c7e64b9ce0 powerpc/powernv Platform dump interface
This enables support for userspace to fetch and initiate FSP and
Platform dumps from the service processor (via firmware) through sysfs.

Based on original patch from Vasant Hegde <hegdevasant@linux.vnet.ibm.com>

Flow:
  - We register for OPAL notification events.
  - OPAL sends new dump available notification.
  - We make information on dump available via sysfs
  - Userspace requests dump contents
  - We retrieve the dump via OPAL interface
  - User copies the dump data
  - userspace sends ack for dump
  - We send ACK to OPAL.

sysfs files:
  - We add the /sys/firmware/opal/dump directory
  - echoing 1 (well, anything, but in future we may support
    different dump types) to /sys/firmware/opal/dump/initiate_dump
    will initiate a dump.
  - Each dump that we've been notified of gets a directory
    in /sys/firmware/opal/dump/ with a name of the dump type and ID (in hex,
    as this is what's used elsewhere to identify the dump).
  - Each dump has files: id, type, dump and acknowledge
    dump is binary and is the dump itself.
    echoing 'ack' to acknowledge (currently any string will do) will
    acknowledge the dump and it will soon after disappear from sysfs.

OPAL APIs:
  - opal_dump_init()
  - opal_dump_info()
  - opal_dump_read()
  - opal_dump_ack()
  - opal_dump_resend_notification()

Currently we are only ever notified for one dump at a time (until
the user explicitly acks the current dump, then we get a notification
of the next dump), but this kernel code should "just work" when OPAL
starts notifying us of all the dumps present.

Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Signed-off-by: Benjamin Herrenschmidt <benh@kernel.crashing.org>
2014-03-07 16:19:10 +11:00
..
firewire-cdev firewire: cdev: ABI documentation enhancements 2011-07-16 07:24:32 +02:00
o2cb ocfs2: Move /sys/o2cb to /sys/fs/o2cb 2008-04-18 08:56:10 -07:00
syscalls
sysfs-acpi-pmprofile ACPI: Export FADT pm_profile integer value to userspace 2011-11-06 20:48:42 -05:00
sysfs-bus-firewire firewire: core: document is_local sysfs attribute 2012-06-30 10:49:06 +02:00
sysfs-bus-usb ACPI / PM / Documentation: Replace outdated project links and addresses 2013-10-11 13:22:43 +02:00
sysfs-bus-xen-backend xen: document backend sysfs files 2011-11-11 15:37:29 -05:00
sysfs-class-backlight backlight: add backlight type 2011-03-22 17:43:59 -07:00
sysfs-class-rfkill rename new rfkill sysfs knobs 2010-03-19 15:48:25 -04:00
sysfs-class-tpm tpm: add documentation for sysfs interfaces 2013-02-05 09:38:21 -06:00
sysfs-class-ubi
sysfs-devices-node Documentation: ABI: /sys/devices/system/node/ 2012-12-18 15:02:15 -08:00
sysfs-devices-system-xen_memory xen: document balloon driver sysfs files 2011-11-09 16:00:46 -05:00
sysfs-driver-ib_srp IB/srp: Make queue size configurable 2013-11-08 14:43:17 -08:00
sysfs-driver-qla2xxx [SCSI] qla2xxx: Add firmware-dump kobject uevent notification. 2009-12-04 12:00:10 -06:00
sysfs-driver-usb-usbtmc USB: update usbtmc api documentation 2012-04-12 08:26:22 -07:00
sysfs-driver-w1_ds28e04 w1: Add 1-wire slave device driver for DS28E04-100 2012-06-13 16:47:10 -07:00
sysfs-firmware-efi-vars efivars: Add Documentation 2011-03-14 08:40:51 -07:00
sysfs-firmware-opal-dump powerpc/powernv Platform dump interface 2014-03-07 16:19:10 +11:00
sysfs-firmware-opal-elog powerpc/powernv: Read OPAL error log and export it through sysfs 2014-03-07 16:19:00 +11:00
sysfs-module ABI: Clarify when /sys/module/MODULENAME is created 2013-07-02 15:38:20 +09:30
sysfs-transport-srp scsi_transport_srp: Add periodic reconnect support 2013-11-08 14:43:16 -08:00
thermal-notification thermal: Add event notification to thermal framework 2011-01-12 00:08:35 -05:00
vdso Documentation: Add newline at end-of-file to files lacking one 2012-07-20 23:10:28 +02:00