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