Update dump manager document with dump types.
Update the dump manager document with the dump types
supported by dump manager
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
Change-Id: Ic7062a983bcc005e7709c8e873609dddd6a25e6d
diff --git a/designs/dump-manager.md b/designs/dump-manager.md
index 6091582..0a8f535 100644
--- a/designs/dump-manager.md
+++ b/designs/dump-manager.md
@@ -1,4 +1,4 @@
-# Dump Manager Design
+# Dump Manager Design
Author:
Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
@@ -36,8 +36,42 @@
The dump manager, which is orchestrating the collection and offload, needs to
provide methods to create, store the dump details, and offload it. Additionally,
some sources allow the dump to be extracted manually without a failure to
-understand the current state or analyze a suspected problem.
+understand the current state or analyze a suspected problems.
+### Type of dumps supported.
+These are some of the dumps supported by dump manager.
+
+#### BMC Dump
+A dump collected when there is a failure in the BMC with various debug
+information. This type of dump can be generated by user too to get the current
+state of the BMC. This dump gets collected on BMC and stored on BMC
+
+#### System Dump
+A system dump is a collection of debugging information from the host, this may
+include host memory and/or register data. This dump can be initiated by BMC and
+there can be system reboots while collecting the dump. Dump gets stored in the
+host memory and offloaded through the BMC or get collected directly to BMC based
+on the size of dump contents and the available space on the BMC to store the
+dump.
+
+#### Resource dump
+A special type of host dump is initiated and collected by the host based on the
+request from a user. No system state change may be necessary during the
+collection of this kind of a dump. A resource indicator may be used to indicate
+what data to be collected. The content of the dump can be decided by the host.
+This dump can be stored in host memory and offloaded through BMC or host can
+send this dump down to BMC once the collection is completed based on the size
+of the dump and the availability of space on the BMC.
+
+#### Hostboot dump
+A dump that can be collected during the boot failure of the host. This dump may
+or may not include the contents of the main memory and/or the processor registers.
+
+#### Hardware dump
+This dump can be collected during a critical failure on the hardware
+components like the processor while the host is booted and running. The host may
+stop during this dump and may collect various processor states and/or memory
+contents to help to debug the failure.
## Requirements