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