mm: Update the service group name for management mode

- use the consistent name MANAGEMENT_MODE - correct some capialization of the text - add link for PI spec Signed-off-by: Yong Li <[email protected]>
riscv-non-isa · Jul 23, 2024 · 68f0a52 · 68f0a52
1 parent f5c2565
commit 68f0a52
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 18 deletions.
diff --git a/src/rpmi.bib b/src/rpmi.bib
@@ -6,6 +6,10 @@ @electronic{ACPI
   title = {Advanced Configuration and Power Interface Specification},
   url = {https://uefi.org/specifications}
 }
+@electronic{PI,
+  title = {UEFI Platform Initialization Specification},
+  url = {https://uefi.org/specifications}
+}
 @electronic{DT,
   title = {DeviceTree},
   url = {https://www.devicetree.org/}

diff --git a/src/srvgrp-base.adoc b/src/srvgrp-base.adoc
@@ -33,7 +33,7 @@ Following table lists the service group
 | 0x00007		| CLOCK
 | 0x00008		| DEVICE_POWER
 | 0x00009		| PERFORMANCE
-| 0x0000A		| MM_SERVICE
+| 0x0000A		| MANAGEMENT_MODE
 | 0x0000B		| RAS_AGENT
 | 0x0000C - 0x7FFFF 	| _Reserved for Future Use_
 | 0x80000 - 0xFFFFF	| _Implementation Specific Service Groups_

diff --git a/src/srvgrp-management.adoc b/src/srvgrp-management.adoc
@@ -9,18 +9,19 @@ ifndef::rootpath[]
 :rootpath: ./../
 endif::rootpath[]
 
-===  Service Group - *MANAGEMENT* (servicegroup_id: 0x0000A)
-This MANAGEMENT service group is designed to be used for software invocation of
-Management Mode (MM) in a secure execution environment. For general background
-on Management Mode (MM), review the Platform Initialization (PI) specifications,
-Volume 4: Management Mode Core Interface. Management Mode (MM) provides an 
-environment for implementing OS agnostic services (MM services) like secure 
-variable storage, and firmware updates in system firmware. The services can be 
-invoked synchronously and asynchronously. This service group describes the 
-interfaces for invoking MM services synchronously. 
+===  Service Group - *MANAGEMENT_MODE* (servicegroup_id: 0x0000A)
+This MANAGEMENT_MODE service group is designed to be used for software invocation
+of Management Mode (MM) in a secure execution environment. For general background
+on Management Mode (MM), refer to the Platform Initialization (PI) specifications
+cite:[PI], Volume 4: Management Mode Core Interface. Management Mode (MM) provides
+an environment for implementing OS agnostic services (MM services) like secure
+variable storage, and firmware updates in system firmware. This service group
+describes the interfaces for invoking MM services synchronously, the MM_COMMUNICATE
+serves as the synchronous interface from non-secure world while the MM_COMPLETE
+serves as the synchronous interface from secure world.
 
 [#table_mm_services]
-.MANAGEMENT Services
+.MANAGEMENT_MODE Services
 [cols="1, 3, 2", width=100%, align="center", options="header"]
 |===
 | Service ID	| Service Name 				| Request Type
@@ -35,11 +36,11 @@ interfaces for invoking MM services synchronously.
 This service group does not support any event for notification.
 
 ==== Service: *MM_ENABLE_NOTIFICATION*
-This service allows AP to subscribe to MANAGEMENT service group notifications.
-Platform can optionally support notifications of events which might occur in 
-the platform. PuC can send these notification messages to AP if they are 
-implemented and AP has subscribed to these. Events supported are described
-in <<management-notifications>>.
+This service allows the AP to subscribe to MANAGEMENT_MODE service group
+notifications. Platform can optionally support notifications of events which
+might occur in the platform. PuC can send these notification messages to AP
+if they are implemented and AP has subscribed to these. Events supported are
+described in <<management-notifications>>.
 
 [#table_mm_ennotification_request_data]
 .Request Data
@@ -69,7 +70,7 @@ notification.
 
 
 ==== Service: *MM_VERSION*
-This service returns the version of a management mode service.
+This service returns the version of a Management Mode.
 
 [#table_mm_version_request_data]
 .Request Data
@@ -88,7 +89,7 @@ This service returns the version of a management mode service.
 ! RPMI_ERROR_DENIED ! Denied due to no permission.
 !===
 - Other errors <<table_error_codes>>
-| 1	| MM_VERSION	| uint32 	| Management mode service version.
+| 1	| MM_VERSION	| uint32 	| Management Mode version.
 [cols="2,5"]
 !===
 ! *Bits* 		!  *Description*