18c2ecf20Sopenharmony_ciWhat:		/sys/firmware/opal/dump
28c2ecf20Sopenharmony_ciDate:		Feb 2014
38c2ecf20Sopenharmony_ciContact:	Stewart Smith <stewart@linux.vnet.ibm.com>
48c2ecf20Sopenharmony_ciDescription:
58c2ecf20Sopenharmony_ci		This directory exposes interfaces for interacting with
68c2ecf20Sopenharmony_ci		the FSP and platform dumps through OPAL firmware interface.
78c2ecf20Sopenharmony_ci
88c2ecf20Sopenharmony_ci		This is only for the powerpc/powernv platform.
98c2ecf20Sopenharmony_ci
108c2ecf20Sopenharmony_ci		=============== ===============================================
118c2ecf20Sopenharmony_ci		initiate_dump:	When '1' is written to it,
128c2ecf20Sopenharmony_ci				we will initiate a dump.
138c2ecf20Sopenharmony_ci				Read this file for supported commands.
148c2ecf20Sopenharmony_ci
158c2ecf20Sopenharmony_ci		0xXX-0xYYYY:	A directory for dump of type 0xXX and
168c2ecf20Sopenharmony_ci				id 0xYYYY (in hex). The name of this
178c2ecf20Sopenharmony_ci				directory should not be relied upon to
188c2ecf20Sopenharmony_ci				be in this format, only that it's unique
198c2ecf20Sopenharmony_ci				among all dumps. For determining the type
208c2ecf20Sopenharmony_ci				and ID of the dump, use the id and type files.
218c2ecf20Sopenharmony_ci				Do not rely on any particular size of dump
228c2ecf20Sopenharmony_ci				type or dump id.
238c2ecf20Sopenharmony_ci		=============== ===============================================
248c2ecf20Sopenharmony_ci
258c2ecf20Sopenharmony_ci		Each dump has the following files:
268c2ecf20Sopenharmony_ci
278c2ecf20Sopenharmony_ci		=============== ===============================================
288c2ecf20Sopenharmony_ci		id:		An ASCII representation of the dump ID
298c2ecf20Sopenharmony_ci				in hex (e.g. '0x01')
308c2ecf20Sopenharmony_ci		type:		An ASCII representation of the type of
318c2ecf20Sopenharmony_ci				dump in the format "0x%x %s" with the ID
328c2ecf20Sopenharmony_ci				in hex and a description of the dump type
338c2ecf20Sopenharmony_ci				(or 'unknown').
348c2ecf20Sopenharmony_ci				Type '0xffffffff unknown' is used when
358c2ecf20Sopenharmony_ci				we could not get the type from firmware.
368c2ecf20Sopenharmony_ci				e.g. '0x02 System/Platform Dump'
378c2ecf20Sopenharmony_ci		dump:		A binary file containing the dump.
388c2ecf20Sopenharmony_ci				The size of the dump is the size of this file.
398c2ecf20Sopenharmony_ci		acknowledge:	When 'ack' is written to this, we will
408c2ecf20Sopenharmony_ci				acknowledge that we've retrieved the
418c2ecf20Sopenharmony_ci				dump to the service processor. It will
428c2ecf20Sopenharmony_ci				then remove it, making the dump
438c2ecf20Sopenharmony_ci				inaccessible.
448c2ecf20Sopenharmony_ci				Reading this file will get a list of
458c2ecf20Sopenharmony_ci				supported actions.
468c2ecf20Sopenharmony_ci		=============== ===============================================
47