REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4517
This commit fixes the API documentation issue reported via the BZ4517
Updated documentation strings for rdmsr() and wrmsr()
Cc: Rebecca Cran <rebe...@bsdio.com>
Cc: Michael D Kinney <michael.d.kin...@intel.com>
Cc: Jayaprakash N <n.jayaprak...@intel.com>
Signed-off-by: Vishal R <visha...@intel.com>
---
.../PyMod-3.6.8/Modules/edk2module.c | 28 +++++++++++++++----
1 file changed, 23 insertions(+), 5 deletions(-)
diff --git
a/AppPkg/Applications/Python/Python-3.6.8/PyMod-3.6.8/Modules/edk2module.c
b/AppPkg/Applications/Python/Python-3.6.8/PyMod-3.6.8/Modules/edk2module.c
index 9641f86..05b1a5a 100644
--- a/AppPkg/Applications/Python/Python-3.6.8/PyMod-3.6.8/Modules/edk2module.c
+++ b/AppPkg/Applications/Python/Python-3.6.8/PyMod-3.6.8/Modules/edk2module.c
@@ -3839,8 +3839,16 @@ void WritePCICfg(
}
PyDoc_STRVAR(efi_rdmsr__doc__,
-"rdmsr(ecx) -> (eax,edx)\n\
-Read the given MSR.");
+"rdmsr(msr) -> (lower_32bits, higher_32bits)\n\
+\n\
+Read the given msr and return the data as tuple.\n\
+\n\
+Parameters:\n\
+ msr - The msr in hex or int format\n\
+\n\
+Return Value:\n\
+ a tuple with lower and higher 32 bit values read from the msr\n\
+");
static PyObject *
edk2_rdmsr(PyObject *self, PyObject *args)
@@ -3857,9 +3865,19 @@ edk2_rdmsr(PyObject *self, PyObject *args)
return Py_BuildValue("(II)", (unsigned long)veax, (unsigned long)vedx);
}
-PyDoc_STRVAR(efi_wrmsr__doc__,
-"wrmsr(ecx, eax, edx) -> None\n\
-Write edx:eax to the given MSR.");
+PyDoc_STRVAR(efi_wrmsr__doc__,
+"wrmsr(msr, lower_32bits, higher_32bits) -> None\n\
+\n\
+Writes higher_32bits:lower_32bits to the given msr.\n\
+\n\
+Parameters:\n\
+ msr - The msr in hex or int format\n\
+ lower_32bits - The lower 32 bit data for the msr\n\
+ higher_32bits - The higher 32 bit data for the msr\n\
+\n\
+Return Value:\n\
+ None\n\
+");
static PyObject *
edk2_wrmsr(PyObject *self, PyObject *args)
--
2.39.1.windows.1
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#107578): https://edk2.groups.io/g/devel/message/107578
Mute This Topic: https://groups.io/mt/100551578/21656
Group Owner: devel+ow...@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-
