Skip to content

Commit

Permalink
Merge pull request #69 from avpatel/mm_svcgrp_imp_v1
Browse files Browse the repository at this point in the history 
MM Service Group Improvments
  • Loading branch information
@lftan
lftan authored Oct 15, 2024
2 parents 035d211 + 33e542d commit 6f100b9
Showing 1 changed file with 58 additions and 105 deletions.
163 changes: 58 additions & 105 deletions src/srvgrp-management.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,17 @@ ifndef::rootpath[]
endif::rootpath[]

=== Service Group - MANAGEMENT_MODE (SERVICEGROUP_ID: 0x000A)
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, refer to the Platform Initialization (PI) specifications
cite:[PI], Volume 4: Management Mode Core Interface. Management Mode 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
world-switch synchronous call from the non-secure to the secure world while the
`MM_COMPLETE` facilitates synchronous call from the secure to the non-secure world.
This MANAGEMENT_MODE service group provides RPMI client a mechanism to invoke the
Management Mode (MM) in a secure execution environment. For general background on
Management Mode, refer to the Platform Initialization (PI) specifications cite:[PI],
Volume 4: Management Mode Core Interface.

The Management Mode (MM) provides an environment for implementing OS agnostic
MM services such as secure variable storage, and firmware updates in the platform
firmware. The MANAGEMENT_MODE service group defines RPMI services for invoking an
MM service synchronously where the `MM_COMMUNICATE` RPMI service is used as a
synchronous call from the non-secure world to the secure world and the data exchanged
with the MM service is passed via special Management Mode (MM) shared memory.

The following table lists the services in the MANAGEMENT_MODE service group:

Expand All @@ -35,16 +37,12 @@ The following table lists the services in the MANAGEMENT_MODE service group:
| NORMAL_REQUEST

| 0x02
| MM_VERSION
| MM_GET_ATTRIBUTES
| NORMAL_REQUEST

| 0x03
| MM_COMMUNICATE
| NORMAL_REQUEST

| 0x04
| MM_COMPLETE
| NORMAL_REQUEST
|===

[#management-notifications]
Expand Down Expand Up @@ -107,20 +105,20 @@ in <<management-notifications>>.
|===


==== Service: MM_GET_ATTRIBUTES (SERVICE_ID: 0x02)
This RPMI service gets the attributes about Management Mode such as MM version,
MM shared memory location, etc.

==== Service: MM_VERSION (SERVICE_ID: 0x02)
This service returns the version of a Management Mode.

[#table_mm_version_request_data]
[#table_mm_get_attributes_request_data]
.Request Data
[cols="1", width=100%, align="center", options="header"]
|===
| NA
|===

[#table_mm_version_response_data]
[#table_mm_get_attributes_response_data]
.Response Data
[cols="1, 2, 1, 7a", width=100%, align="center", options="header"]
[cols="1, 4, 1, 7a", width=100%, align="center", options="header"]
|===
| Word
| Name
Expand All @@ -138,10 +136,6 @@ This service returns the version of a Management Mode.

! RPMI_SUCCESS
! Service completed successfully.

! RPMI_ERR_DENIED
! Denied due to no permission.

!===
- Other errors <<table_error_codes>>

Expand All @@ -161,50 +155,69 @@ This service returns the version of a Management Mode.
! [15:0]
! Minor version
!===
|===

| 2
| MM_SHMEM_ADDR_LOW
| uint32
| Lower 32-bit of the MM shared memory physical address.

| 3
| MM_SHMEM_ADDR_HIGH
| uint32
| Upper 32-bit of the MM shared memory physical address.

| 4
| MM_SHMEM_SIZE
| uint32
| The size of MM shared memory in bytes.

|===


==== Service: MM_COMMUNICATE (SERVICE_ID: 0x03)
This service invokes an MM service implemented in the secure execution
environment. The `MM_COMM_DATA` contains data needed to identify and
invoke the MM service. The readiness of this synchronous request from
the non-secure world is signaled by the `MM_COMPLETE` call from the secure
world.
The `MM_COMMUNICATE` service invokes an MM service implemented in the secure
execution environment. The input data needed to identify and invoke the MM
service is referred to as `MM_COMM_INPUT_DATA` whereas the output data returned
by the MM service is referred to as `MM_COMM_OUTPUT_DATA`. The RPMI client in
the non-secure execution enviroment provides the location of `MM_COMM_INPUT_DATA`
and `MM_COMM_OUTPUT_DATA` in the MM shared memory as parameters of `MM_COMMUNICATE`
service.

[#table_mm_communicate_request_data]
.Request Data
[cols="1, 5, 1, 7", width=100%, align="center", options="header"]
[cols="1, 7, 1, 6", width=100%, align="center", options="header"]
|===
| Word
| Name
| Type
| Description

| 0
| MM_COMM_DATA_ADDR_LOW
| MM_COMM_INPUT_DATA_OFFSET
| uint32
| Lower 32-bit of the MM data's physical address from non-secure to secure world.
| The offset in the MM shared memory where the input data is passed to the MM service.

| 1
| MM_COMM_DATA_ADDR_HIGH
| MM_COMM_INPUT_DATA_SIZE
| uint32
| Upper 32-bit of the MM data's physical address from non-secure to secure world.
| The size of the input data in the MM shared memory.

| 2
| MM_COMM_DATA_SIZE_LOW
| MM_COMM_OUTPUT_DATA_OFFSET
| uint32
| Lower 32-bit of the MM data's length from non-secure to secure world.
| The offset in the MM shared memory where the output data will be written by
the MM service.

| 3
| MM_COMM_DATA_SIZE_HIGH
| MM_COMM_OUTPUT_DATA_SIZE
| uint32
| Upper 32-bit of the MM data's length from non-secure to secure world.
| The maximum size of the output data which can be written by the MM service in
the MM shared memory.
|===

[#table_mm_communicate_response_data]
.Response Data
[cols="1, 2, 1, 7a", width=100%, align="center", options="header"]
[cols="1, 6, 1, 7a", width=100%, align="center", options="header"]
|===
| Word
| Name
Expand All @@ -216,84 +229,24 @@ world.
| int32
| Return error code

[cols="4,5", options="header"]
[cols="6,4", options="header"]
!===
! Error Code
! Description

! RPMI_SUCCESS
! Service completed successfully.

! RPMI_ERR_DENIED
! Denied due to no permission.

!===
- Other errors <<table_error_codes>>
|===



==== Service: MM_COMPLETE (SERVICE_ID: 0x04)
This service is used as the world-switch synchronous call, typically at the end
of a synchronous `MM_COMMUNICATE` call, to signal the readiness for handling
the synchronous request. The `MM_COMM_DATA` contains the returned data from the
invoked MM service.

[#table_mm_complete_request_data]
.Request Data
[cols="1, 2, 1, 7a", width=100%, align="center", options="header"]
|===
| Word
| Name
| Type
| Description

| 0
| STATUS
| int32
| Return error code

[cols="4,5", options="header"]
!===
! Error Code
! Description

! RPMI_SUCCESS
! Service completed successfully.
! RPMI_ERR_INVALID_ADDR
! Input data end (or Output data end) is outside MM shared memory.

! RPMI_ERR_DENIED
! Denied due to no permission.

!===
- Other errors <<table_error_codes>>
|===

[#table_mm_complete_response_data]
.Response Data
[cols="1, 5, 1, 7a", width=100%, align="center", options="header"]
|===
| Word
| Name
| Type
| Description

| 0
| MM_COMM_DATA_ADDR_LOW
| uint32
| Lower 32-bit of the MM data's physical address from non-secure to secure world.

| 1
| MM_COMM_DATA_ADDR_HIGH
| uint32
| Upper 32-bit of the MM data's physical address from non-secure to secure world.

| 2
| MM_COMM_DATA_SIZE_LOW
| uint32
| Lower 32-bit of the MM data's length from non-secure to secure world.

| 3
| MM_COMM_DATA_SIZE_HIGH
| MM_COMM_RETURN_DATA_SIZE
| uint32
| Upper 32-bit of the MM data's length from non-secure to secure world.
| Actual size of the output data written by the MM service in the MM shared memory.
|===

0 comments on commit 6f100b9

Please sign in to comment.