Cleanup documentation for PC release.

intel · Dec 4, 2018 · ae96cdc · ae96cdc
1 parent a026f5e
commit ae96cdc
Show file tree

Hide file tree

Showing 10 changed files with 54 additions and 36 deletions.
diff --git a/Documentation/ipmctl/DIMM_Discovery/ipmctl-show-device.txt b/Documentation/ipmctl/DIMM_Discovery/ipmctl-show-device.txt
@@ -85,6 +85,8 @@ below; applying options changes the output to a more detailed format. Limited
 information (noted in the table below) is applicable if the DCPMM is not
 manageable by the software as indicated by the "ManageabilityState" property.
 
+NOTE: Some data is endian-swapped for human readability.
+
 DimmID::
   (Default)  The DCPMM identifier.
 
@@ -145,7 +147,7 @@ ManageabilityState::
     the software.
 
 PhysicalID::
-  The DCPMM physical identifier (i.e., SMBIOS Type 17 handle)
+  The DCPMM physical identifier (i.e., SMBIOS Type 17 handle).
 
 DimmHandle::
   The DCPMM handle formatted as 0xABCD.
@@ -167,13 +169,13 @@ SocketID::
   installed.
 
 MemControllerID::
-  The associated memory controller identifier
+  The associated memory controller identifier.
 
 ChannelID::
-  The associated channel
+  The associated channel.
 
 ChannelPos::
-  The DCPMM position in the channel
+  The DCPMM position in the channel.
 
 MemoryType::
   The memory type. One of:
@@ -182,19 +184,22 @@ MemoryType::
   - Logical Non-Volatile Device
 
 VendorID::
-  The vendor identifier of the DCPMM
+  The vendor identifier of the DCPMM.
+  This value is presented in big endian format.
 
 DeviceID::
-  The device identifier of the DCPMM
+  The device identifier of the DCPMM.
+  This value is presented in big endian format.
 
 RevisionID::
-  The revision identifier of the DCPMM
+  The revision identifier of the DCPMM.
 
 SubsystemVendorID::
   The vendor identifier of the non-volatile memory subsystem controller.
+  This value is presented in big endian format.
 
 SubsystemDeviceID::
-  The device identifier of the non-volatile memory subsystem controller
+  The device identifier of the non-volatile memory subsystem controller.
 
 SubsystemRevisionID::
   The revision identifier of the non-volatile memory subsystem controller
@@ -215,7 +220,8 @@ ManufacturingDate::
   is 0.
 
 SerialNumber::
-  The serial number assigned by the vendor
+  The serial number assigned by the vendor.
+  This value is presented in big endian format.
 
 PartNumber::
   The part number assigned by the vendor
@@ -294,7 +300,8 @@ endif::os_build[]
 software as indicated by the "ManageabilityState".*
 
 ManufacturerID::
-  The manufacturer identifier of the DCPMM
+  The manufacturer identifier of the DCPMM.
+  This value is presented in big endian format.
 
 ControllerRevisionID::
   The controller stepping and revision ID retrieved from the controller FW. This
@@ -307,10 +314,10 @@ IsNew::
   - 1: The DCPMM requires configuration.
 
 MemoryCapacity::
-  Usable DCPMM Memory Mode capacity
+  Usable DCPMM Memory Mode capacity.
 
 AppDirectCapacity::
-  Usable DCPMM App Direct capacity
+  Usable DCPMM App Direct capacity.
 
 UnconfiguredCapacity::
   DCPMM capacity that is inaccessible because it is not mapped into the system
@@ -324,7 +331,7 @@ InaccessibleCapacity::
   enabled by BIOS.
 
 ReservedCapacity::
-  DCPMM capacity reserved for proper alignment
+  DCPMM capacity reserved for proper alignment.
 
 PeakPowerBudget::
   If the DCPMM firmware power management policy is enabled, the power budget in
@@ -336,7 +343,7 @@ AvgPowerBudget::
   mW used for average power. Refer to FIS for allowable range and default value.
 
 MaxAveragePowerBudget::
-   Maximum average power budget supported by the DCPMM
+   Maximum average power budget supported by the DCPMM.
 
 PackageSparingCapable::
   Whether or not the DCPMM supports package sparing. One of:
@@ -349,7 +356,7 @@ PackageSparingEnabled::
  - 1: Enabled
 
 PackageSparesAvailable::
-  The number of spare devices available for package sparing
+  The number of spare devices available for package sparing.
 
 LatchedLastShutdownStatus::
   The status of the last shutdown of the DCPMM. One or more of:

diff --git a/Documentation/ipmctl/DIMM_Discovery/ipmctl-show-system-capabilities.txt b/Documentation/ipmctl/DIMM_Discovery/ipmctl-show-system-capabilities.txt
@@ -65,7 +65,7 @@ PlatformConfigSupported::
   (Default) Whether the platform level configuration of DCPMMs can be modified
   with the host software. One of:
   - 0: Changes must be made in the BIOS.
-  - 1: The command Section 2.2.5, "Create Memory Allocation Goal" is supported.
+  - 1: The command *_Create Memory Allocation Goal_* is supported.
     Alignment (Default) Capacity alignment requirement for all memory types as reported by the BIOS.
 
 AllowedVolatileMode::
@@ -94,7 +94,7 @@ AllowedAppDirectMode::
 
 ModesSupported::
   A list of DCPMM modes supported by the BIOS. Refer to the command
-  Section 2.1.3, "Show Device" to determine the modes supported by the individual
+  *_Show Device_* to determine the modes supported by the individual
   DCPMMs. One or more of:
   - 1LM: One-level volatile mode. All memory resources in the platform are
     independently accessible, and not captive of the other resources.
@@ -107,13 +107,13 @@ ModesSupported::
 SupportedAppDirectSettings::
   The BIOS supported list of App Direct interleave settings in the format:
   - x[Way] - [(IMCSize) iMC x (ChannelSize) Channel] followed by the input
-    format for the command Section 2.5.7, "Change Preferences":
+    format for the command *_Change Preferences_*:
     (ByOne|(IMCSize)_(ChannelSize)).
 
 RecommendedAppDirectSettings::
   The BIOS recommended list of App Direct interleave settings in the format:
   - x[Way] - [(IMCSize) iMC x (ChannelSize) Channel] followed by the input format for
-  the command Section 2.5.7, "Change Preferences":
+  the command *_Change Preferences_*:
   (ByOne|(IMCSize)_(ChannelSize)).
 
 MinNamespaceSize::

diff --git a/Documentation/ipmctl/Debug/ipmctl-delete-pcd.txt b/Documentation/ipmctl/Debug/ipmctl-delete-pcd.txt
@@ -41,6 +41,10 @@ the Configuration header are set to zero, making those tables invalid.
 NOTE: This action can be useful when moving DCPMMs from one system to another, as goal creation
 rules may restrict provisioning dimms with an existing configuration.
 
+NOTE: When Config is specified, only PCD partition 1 is modified. If the platform is rebooted
+prior to creating a new goal on any targeted DCPMMs, UEFI platform firmware will detect the
+missing tables and, if possible, restore previous config using the PCD partition 0 tables.
+
 WARNING: *This command may result in data loss. Data should be backed up
 to other storage before executing this command*.
 

diff --git a/Documentation/ipmctl/Debug/ipmctl-show-acpi.txt b/Documentation/ipmctl/Debug/ipmctl-show-acpi.txt
@@ -46,3 +46,5 @@ RETURN DATA
 -----------
 Returns the formatted data from the requested ACPI tables and their sub-tables. Refer
 to the ACPI specification for detailed information about the format of the ACPI tables.
+
+NOTE: All data is presented in ACPI little endian format.
diff --git a/Documentation/ipmctl/Memory_Subsystem_Provisioning/ipmctl-create-goal.txt b/Documentation/ipmctl/Memory_Subsystem_Provisioning/ipmctl-create-goal.txt
@@ -128,7 +128,7 @@ In order to successfully execute this command:
   Targets may be limited to individual DCPMMs or sockets, but all DCPMMs
   on affected sockets must be configured when the command finishes. If the
   selected targets make this impossible, the command will be rejected.
-  Refer to <<2.1.5 Show System Capabilities>> for a list of BIOS
+  Refer to *_Show System Capabilities_* for a list of BIOS
   supported modes.
 
 - Some requests are dependent on BIOS and/or platform configuration. For details, refer

diff --git a/Documentation/ipmctl/Memory_Subsystem_Provisioning/ipmctl-load-goal.txt b/Documentation/ipmctl/Memory_Subsystem_Provisioning/ipmctl-load-goal.txt
@@ -96,7 +96,7 @@ In order to successfully execute this command:
   Targets may be limited to individual DCPMMs or sockets, but all DCPMMs
   on affected sockets must be configured when the command finishes. If the
   selected targets make this impossible, the command will be rejected.
-  Refer to <<2.1.5 Show System Capabilities>> for a list of BIOS
+  Refer to *_Show System Capabilities_* for a list of BIOS
   supported modes.
 
 - Some requests are dependent on BIOS and/or platform configuration. For details, refer

diff --git a/Documentation/ipmctl/Memory_Subsystem_Provisioning/ipmctl-show-goal.txt b/Documentation/ipmctl/Memory_Subsystem_Provisioning/ipmctl-show-goal.txt
@@ -20,7 +20,7 @@ DESCRIPTION
 Shows the memory allocation goal on one or more DCPMMs. Once the goal is
 successfully applied by the BIOS, it is no longer displayed. Use the command
 Section 2.1.4, "Show Memory Resources" to view the system-wide memory resources
-or the command Section 2.4.1, "Show Persistent Memory" for detailed persistent
+or the command *_Show Persistent Memory_* for detailed persistent
 memory information.
 
 OPTIONS

diff --git a/Documentation/ipmctl/Support_and_Maintenance/ipmctl-change-preferences.txt b/Documentation/ipmctl/Support_and_Maintenance/ipmctl-change-preferences.txt
@@ -36,9 +36,9 @@ PROPERTIES
 CLI_DEFAULT_DIMM_ID::
   The default display of DCPMM identifiers. One of:
   - "UID": Use the DimmUID attribute as defined in the section
-  <<2.1.3 Show Device>>.
+  *_Show Device_*.
   - "HANDLE": Use the DimmHandle attribute as defined in section
-    <<2.1.3 Show Device>>. This is the default
+    *_Show Device_*. This is the default
 
 CLI_DEFAULT_SIZE::
   The default display of capacities in the CLI. One of:
@@ -57,8 +57,7 @@ CLI_DEFAULT_SIZE::
 APPDIRECT_SETTINGS::
   The interleave settings to use when creating App Direct capacity in the
   format: [underline]#(IMCSize_ChannelSize)#. Must be one of the BIOS supported
-  App Direct settings returned by the command Section 2.1.5,
-  "Show System Capabilities."
+  App Direct settings returned by the command *_Show System Capabilities_*.
 
 NOTE: ByOne is not a valid setting for this preference. The default is
 "RECOMMENDED" which uses the BIOS recommended App Direct settings.
@@ -68,8 +67,8 @@ the system. Therefore, if any App Direct capacity already exists, this
 preference cannot be changed.
 
 APPDIRECT_GRANULARITY::
-  The minimum App Direct granularity per DCPMM supported by the command Section
-  2.2.5, "Create Memory Allocation Goal.". One of:
+  The minimum App Direct granularity per DCPMM supported by the command
+  *_Create Memory Allocation Goal_*. One of:
   - "RECOMMENDED": Use the recommended App Direct granularity of 32 GiB.
   - "1": Allows 1 GiB App Direct granularity which may result in App Direct region
        sizes that are not recommended.

diff --git a/Documentation/ipmctl/Support_and_Maintenance/ipmctl-dump-support-data.txt b/Documentation/ipmctl/Support_and_Maintenance/ipmctl-dump-support-data.txt
@@ -37,17 +37,24 @@ endif::os_build[]
 TARGET
 ------
 -destination (file_prefix)::
-  This command creates a text file with a name starting with the given file_prefix option and dumps the platform support information into it.
-  In addition, this command also outputs the debug log information in separate files. Refer to <<2.6.3 Dump Debug Log>> for more details.
+  This command creates a text file with a name starting with the given
+  file_prefix option and dumps the platform support information into it.
+  In addition, this command also outputs the debug log information in
+  separate files. Refer to *_Dump Debug Log_* for more details.
 
 -dict (path)::
   Optional file path to the dictionary file. If supplied, the command will
   create both the binary debug log and a text file with decoded log data with
-  the file prefix specified by -destination. This option is used only to dump the debug log information.
+  the file prefix specified by -destination. This option is used only to dump
+  the debug log information.
 
 EXAMPLES
 --------
-Creates a text file named dumpfile_platform_support_info.txt and stores the platform supported data in that file. Also, dumps the debug log info in the related files that start with the file name dumpfile_*. Refer to <<2.6.3 Dump Debug Log>> for more info on the output files.
+Creates a text file named dumpfile_platform_support_info.txt and stores the
+platform supported data in that file. Also, dumps the debug log info in the
+related files that start with the file name dumpfile_*. Refer to
+*_Dump Debug Log_* for more info on the output files.
+
 [verse]
 ipmctl dump -destination dumpfile_ -dict nlog_dict.1.1.0.0000.txt -support
 

diff --git a/Documentation/ipmctl/Support_and_Maintenance/ipmctl-update-firmware.txt b/Documentation/ipmctl/Support_and_Maintenance/ipmctl-update-firmware.txt
@@ -110,9 +110,8 @@ DCPMM.
 SAMPLE OUTPUT
 -------------
 [verse]
-(file path): MM.mm.hh.bbbb | Unable to retrieve version from FW
-image.
-Load FW on DIMM (DimmID): (Valid|Invalid|Downgrade) [(with
+(file path): MM.mm.hh.bbbb
+Load FW on DIMM (DimmID): (Valid|Downgrade) [(with
 confirmation or the force option)]
 
 If the firmware is being downgraded and the force option is not provided, the user will
@@ -136,4 +135,4 @@ activate the FW.
 Load FW on DIMM (DimmID): Success, a power cycle is required to
 activate the FW.
 ...
-Load FW on DIMM (DimmID): Error (Code)-(Description)
+Load FW on DIMM (DimmID): Error (Code) - (Description)