mirror of
https://github.com/acidanthera/audk.git
synced 2025-07-23 13:44:33 +02:00
UefiCpuPkg PiSmmCpuDxeSmm: Refine some comments about SmmMemoryAttribute
1. Fix some "support" to "supported". 2. Fix some "set" to "clear" in ClearMemoryAttributes interface. 3. Remove redundant comments for GetMemoryAttributes interface. Cc: Jian J Wang <jian.j.wang@intel.com> Cc: Jiewen Yao <jiewen.yao@intel.com> Cc: Eric Dong <eric.dong@intel.com> Cc: Laszlo Ersek <lersek@redhat.com> Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Star Zeng <star.zeng@intel.com> Reviewed-by: Jian J Wang <jian.j.wang@intel.com> Reviewed-by: Laszlo Ersek <lersek@redhat.com>
This commit is contained in:
parent
5942b32e79
commit
aae02dccf5
@ -1079,7 +1079,7 @@ TransferApToSafeState (
|
|||||||
@retval EFI_UNSUPPORTED The processor does not support one or more
|
@retval EFI_UNSUPPORTED The processor does not support one or more
|
||||||
bytes of the memory resource range specified
|
bytes of the memory resource range specified
|
||||||
by BaseAddress and Length.
|
by BaseAddress and Length.
|
||||||
The bit mask of attributes is not support for
|
The bit mask of attributes is not supported for
|
||||||
the memory resource range specified by
|
the memory resource range specified by
|
||||||
BaseAddress and Length.
|
BaseAddress and Length.
|
||||||
|
|
||||||
@ -1101,17 +1101,17 @@ EdkiiSmmSetMemoryAttributes (
|
|||||||
@param BaseAddress The physical address that is the start address of
|
@param BaseAddress The physical address that is the start address of
|
||||||
a memory region.
|
a memory region.
|
||||||
@param Length The size in bytes of the memory region.
|
@param Length The size in bytes of the memory region.
|
||||||
@param Attributes The bit mask of attributes to set for the memory
|
@param Attributes The bit mask of attributes to clear for the memory
|
||||||
region.
|
region.
|
||||||
|
|
||||||
@retval EFI_SUCCESS The attributes were set for the memory region.
|
@retval EFI_SUCCESS The attributes were cleared for the memory region.
|
||||||
@retval EFI_INVALID_PARAMETER Length is zero.
|
@retval EFI_INVALID_PARAMETER Length is zero.
|
||||||
Attributes specified an illegal combination of
|
Attributes specified an illegal combination of
|
||||||
attributes that cannot be set together.
|
attributes that cannot be cleared together.
|
||||||
@retval EFI_UNSUPPORTED The processor does not support one or more
|
@retval EFI_UNSUPPORTED The processor does not support one or more
|
||||||
bytes of the memory resource range specified
|
bytes of the memory resource range specified
|
||||||
by BaseAddress and Length.
|
by BaseAddress and Length.
|
||||||
The bit mask of attributes is not support for
|
The bit mask of attributes is not supported for
|
||||||
the memory resource range specified by
|
the memory resource range specified by
|
||||||
BaseAddress and Length.
|
BaseAddress and Length.
|
||||||
|
|
||||||
@ -1126,7 +1126,7 @@ EdkiiSmmClearMemoryAttributes (
|
|||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
This function retrieve the attributes of the memory region specified by
|
This function retrieves the attributes of the memory region specified by
|
||||||
BaseAddress and Length. If different attributes are got from different part
|
BaseAddress and Length. If different attributes are got from different part
|
||||||
of the memory region, EFI_NO_MAPPING will be returned.
|
of the memory region, EFI_NO_MAPPING will be returned.
|
||||||
|
|
||||||
@ -1144,9 +1144,6 @@ EdkiiSmmClearMemoryAttributes (
|
|||||||
@retval EFI_UNSUPPORTED The processor does not support one or more
|
@retval EFI_UNSUPPORTED The processor does not support one or more
|
||||||
bytes of the memory resource range specified
|
bytes of the memory resource range specified
|
||||||
by BaseAddress and Length.
|
by BaseAddress and Length.
|
||||||
The bit mask of attributes is not support for
|
|
||||||
the memory resource range specified by
|
|
||||||
BaseAddress and Length.
|
|
||||||
|
|
||||||
**/
|
**/
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
|
@ -552,12 +552,12 @@ SmmSetMemoryAttributesEx (
|
|||||||
BaseAddress and Length cannot be modified.
|
BaseAddress and Length cannot be modified.
|
||||||
@retval EFI_INVALID_PARAMETER Length is zero.
|
@retval EFI_INVALID_PARAMETER Length is zero.
|
||||||
Attributes specified an illegal combination of attributes that
|
Attributes specified an illegal combination of attributes that
|
||||||
cannot be set together.
|
cannot be cleared together.
|
||||||
@retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
|
@retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
|
||||||
the memory resource range.
|
the memory resource range.
|
||||||
@retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
|
@retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
|
||||||
resource range specified by BaseAddress and Length.
|
resource range specified by BaseAddress and Length.
|
||||||
The bit mask of attributes is not support for the memory resource
|
The bit mask of attributes is not supported for the memory resource
|
||||||
range specified by BaseAddress and Length.
|
range specified by BaseAddress and Length.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
@ -604,7 +604,7 @@ SmmClearMemoryAttributesEx (
|
|||||||
the memory resource range.
|
the memory resource range.
|
||||||
@retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
|
@retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
|
||||||
resource range specified by BaseAddress and Length.
|
resource range specified by BaseAddress and Length.
|
||||||
The bit mask of attributes is not support for the memory resource
|
The bit mask of attributes is not supported for the memory resource
|
||||||
range specified by BaseAddress and Length.
|
range specified by BaseAddress and Length.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
@ -632,12 +632,12 @@ SmmSetMemoryAttributes (
|
|||||||
BaseAddress and Length cannot be modified.
|
BaseAddress and Length cannot be modified.
|
||||||
@retval EFI_INVALID_PARAMETER Length is zero.
|
@retval EFI_INVALID_PARAMETER Length is zero.
|
||||||
Attributes specified an illegal combination of attributes that
|
Attributes specified an illegal combination of attributes that
|
||||||
cannot be set together.
|
cannot be cleared together.
|
||||||
@retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
|
@retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
|
||||||
the memory resource range.
|
the memory resource range.
|
||||||
@retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
|
@retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
|
||||||
resource range specified by BaseAddress and Length.
|
resource range specified by BaseAddress and Length.
|
||||||
The bit mask of attributes is not support for the memory resource
|
The bit mask of attributes is not supported for the memory resource
|
||||||
range specified by BaseAddress and Length.
|
range specified by BaseAddress and Length.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
@ -1185,7 +1185,7 @@ IsSmmCommBufferForbiddenAddress (
|
|||||||
@retval EFI_UNSUPPORTED The processor does not support one or more
|
@retval EFI_UNSUPPORTED The processor does not support one or more
|
||||||
bytes of the memory resource range specified
|
bytes of the memory resource range specified
|
||||||
by BaseAddress and Length.
|
by BaseAddress and Length.
|
||||||
The bit mask of attributes is not support for
|
The bit mask of attributes is not supported for
|
||||||
the memory resource range specified by
|
the memory resource range specified by
|
||||||
BaseAddress and Length.
|
BaseAddress and Length.
|
||||||
|
|
||||||
@ -1210,17 +1210,17 @@ EdkiiSmmSetMemoryAttributes (
|
|||||||
@param BaseAddress The physical address that is the start address of
|
@param BaseAddress The physical address that is the start address of
|
||||||
a memory region.
|
a memory region.
|
||||||
@param Length The size in bytes of the memory region.
|
@param Length The size in bytes of the memory region.
|
||||||
@param Attributes The bit mask of attributes to set for the memory
|
@param Attributes The bit mask of attributes to clear for the memory
|
||||||
region.
|
region.
|
||||||
|
|
||||||
@retval EFI_SUCCESS The attributes were set for the memory region.
|
@retval EFI_SUCCESS The attributes were cleared for the memory region.
|
||||||
@retval EFI_INVALID_PARAMETER Length is zero.
|
@retval EFI_INVALID_PARAMETER Length is zero.
|
||||||
Attributes specified an illegal combination of
|
Attributes specified an illegal combination of
|
||||||
attributes that cannot be set together.
|
attributes that cannot be cleared together.
|
||||||
@retval EFI_UNSUPPORTED The processor does not support one or more
|
@retval EFI_UNSUPPORTED The processor does not support one or more
|
||||||
bytes of the memory resource range specified
|
bytes of the memory resource range specified
|
||||||
by BaseAddress and Length.
|
by BaseAddress and Length.
|
||||||
The bit mask of attributes is not support for
|
The bit mask of attributes is not supported for
|
||||||
the memory resource range specified by
|
the memory resource range specified by
|
||||||
BaseAddress and Length.
|
BaseAddress and Length.
|
||||||
|
|
||||||
@ -1238,7 +1238,7 @@ EdkiiSmmClearMemoryAttributes (
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
This function retrieve the attributes of the memory region specified by
|
This function retrieves the attributes of the memory region specified by
|
||||||
BaseAddress and Length. If different attributes are got from different part
|
BaseAddress and Length. If different attributes are got from different part
|
||||||
of the memory region, EFI_NO_MAPPING will be returned.
|
of the memory region, EFI_NO_MAPPING will be returned.
|
||||||
|
|
||||||
@ -1256,9 +1256,6 @@ EdkiiSmmClearMemoryAttributes (
|
|||||||
@retval EFI_UNSUPPORTED The processor does not support one or more
|
@retval EFI_UNSUPPORTED The processor does not support one or more
|
||||||
bytes of the memory resource range specified
|
bytes of the memory resource range specified
|
||||||
by BaseAddress and Length.
|
by BaseAddress and Length.
|
||||||
The bit mask of attributes is not support for
|
|
||||||
the memory resource range specified by
|
|
||||||
BaseAddress and Length.
|
|
||||||
|
|
||||||
**/
|
**/
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
|
Loading…
x
Reference in New Issue
Block a user