Document the "Cr3BaseAddress" parameter, and correct several parameter
references.
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Brijesh Singh <brijesh.singh@amd.com>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Tested-by: Brijesh Singh <brijesh.singh@amd.com>
Reviewed-by: Brijesh Singh <brijesh.singh@amd.com>
\r
/**\r
This function either sets or clears memory encryption bit for the memory\r
\r
/**\r
This function either sets or clears memory encryption bit for the memory\r
- region specified by PhysicalAddress and length from the current page table\r
+ region specified by PhysicalAddress and Length from the current page table\r
- The function iterates through the physicalAddress one page at a time, and set\r
+ The function iterates through the PhysicalAddress one page at a time, and set\r
or clears the memory encryption mask in the page table. If it encounters\r
that a given physical address range is part of large page then it attempts to\r
change the attribute at one go (based on size), otherwise it splits the\r
large pages into smaller (e.g 2M page into 4K pages) and then try to set or\r
clear the encryption bit on the smallest page size.\r
\r
or clears the memory encryption mask in the page table. If it encounters\r
that a given physical address range is part of large page then it attempts to\r
change the attribute at one go (based on size), otherwise it splits the\r
large pages into smaller (e.g 2M page into 4K pages) and then try to set or\r
clear the encryption bit on the smallest page size.\r
\r
+ @param[in] Cr3BaseAddress Cr3 Base Address (if zero then use\r
+ current CR3)\r
@param[in] PhysicalAddress The physical address that is the start\r
address of a memory region.\r
@param[in] Length The length of memory region\r
@param[in] Mode Set or Clear mode\r
@param[in] PhysicalAddress The physical address that is the start\r
address of a memory region.\r
@param[in] Length The length of memory region\r
@param[in] Mode Set or Clear mode\r
- @param[in] Flush Flush the caches before applying the\r
+ @param[in] CacheFlush Flush the caches before applying the\r
encryption mask\r
\r
@retval RETURN_SUCCESS The attributes were cleared for the\r
encryption mask\r
\r
@retval RETURN_SUCCESS The attributes were cleared for the\r