Linux 4.1.18
[linux/fpc-iii.git] / Documentation / ABI / stable / sysfs-firmware-opal-dump
blob32fe7f5c488069c64b8c37951b6dfcfa90f4eb57
1 What:           /sys/firmware/opal/dump
2 Date:           Feb 2014
3 Contact:        Stewart Smith <stewart@linux.vnet.ibm.com>
4 Description:
5                 This directory exposes interfaces for interacting with
6                 the FSP and platform dumps through OPAL firmware interface.
8                 This is only for the powerpc/powernv platform.
10                 initiate_dump:  When '1' is written to it,
11                                 we will initiate a dump.
12                                 Read this file for supported commands.
14                 0xXX-0xYYYY:    A directory for dump of type 0xXX and
15                                 id 0xYYYY (in hex). The name of this
16                                 directory should not be relied upon to
17                                 be in this format, only that it's unique
18                                 among all dumps. For determining the type
19                                 and ID of the dump, use the id and type files.
20                                 Do not rely on any particular size of dump
21                                 type or dump id.
23                 Each dump has the following files:
24                 id:             An ASCII representation of the dump ID
25                                 in hex (e.g. '0x01')
26                 type:           An ASCII representation of the type of
27                                 dump in the format "0x%x %s" with the ID
28                                 in hex and a description of the dump type
29                                 (or 'unknown').
30                                 Type '0xffffffff unknown' is used when
31                                 we could not get the type from firmware.
32                                 e.g. '0x02 System/Platform Dump'
33                 dump:           A binary file containing the dump.
34                                 The size of the dump is the size of this file.
35                 acknowledge:    When 'ack' is written to this, we will
36                                 acknowledge that we've retrieved the
37                                 dump to the service processor. It will
38                                 then remove it, making the dump
39                                 inaccessible.
40                                 Reading this file will get a list of
41                                 supported actions.