Merge tag 'efi_updates_for_v5.11' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-microblaze.git] / Documentation / ABI / stable / sysfs-firmware-opal-dump
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.
7
8                 This is only for the powerpc/powernv platform.
9
10                 =============== ===============================================
11                 initiate_dump:  When '1' is written to it,
12                                 we will initiate a dump.
13                                 Read this file for supported commands.
14
15                 0xXX-0xYYYY:    A directory for dump of type 0xXX and
16                                 id 0xYYYY (in hex). The name of this
17                                 directory should not be relied upon to
18                                 be in this format, only that it's unique
19                                 among all dumps. For determining the type
20                                 and ID of the dump, use the id and type files.
21                                 Do not rely on any particular size of dump
22                                 type or dump id.
23                 =============== ===============================================
24
25                 Each dump has the following files:
26
27                 =============== ===============================================
28                 id:             An ASCII representation of the dump ID
29                                 in hex (e.g. '0x01')
30                 type:           An ASCII representation of the type of
31                                 dump in the format "0x%x %s" with the ID
32                                 in hex and a description of the dump type
33                                 (or 'unknown').
34                                 Type '0xffffffff unknown' is used when
35                                 we could not get the type from firmware.
36                                 e.g. '0x02 System/Platform Dump'
37                 dump:           A binary file containing the dump.
38                                 The size of the dump is the size of this file.
39                 acknowledge:    When 'ack' is written to this, we will
40                                 acknowledge that we've retrieved the
41                                 dump to the service processor. It will
42                                 then remove it, making the dump
43                                 inaccessible.
44                                 Reading this file will get a list of
45                                 supported actions.
46                 =============== ===============================================