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