From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by spool.mail.gandi.net (Postfix) with ESMTPS id 67546D80320 for ; Fri, 4 Aug 2023 18:08:12 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=WTE0LkItZifjNBm6C0x38gJzSs9moXMs4FNAGy2G1H0=; c=relaxed/simple; d=groups.io; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References:MIME-Version:Precedence:List-Subscribe:List-Help:Sender:List-Id:Mailing-List:Delivered-To:Reply-To:List-Unsubscribe-Post:List-Unsubscribe:Content-Transfer-Encoding; s=20140610; t=1691172491; v=1; b=oSy6zmhbtAgCQqu9hxZ2Xz6QJrrbyiLXIDA21i4HuEGWIa16r9kCGkEPHfoXxWhpvrgzzaXJ m+svw4vUEe7o232y9NqBpBrby4C5yyzIhKaHbAd5ck9KGjJ3F5IRKxM1vcOj0Hoh7oCplfWkL6w QOa+atgNccxK1nbJl5Dwy+tI= X-Received: by 127.0.0.2 with SMTP id aQQDYY7687511xMbwqlYj00v; Fri, 04 Aug 2023 11:08:11 -0700 X-Received: from mgamail.intel.com (mgamail.intel.com [134.134.136.65]) by mx.groups.io with SMTP id smtpd.web10.19616.1691080995906494801 for ; Thu, 03 Aug 2023 09:43:20 -0700 X-IronPort-AV: E=McAfee;i="6600,9927,10791"; a="373576866" X-IronPort-AV: E=Sophos;i="6.01,252,1684825200"; d="scan'208";a="373576866" X-Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Aug 2023 09:43:16 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10791"; a="976161644" X-IronPort-AV: E=Sophos;i="6.01,252,1684825200"; d="scan'208";a="976161644" X-Received: from vishalr1-mobl2.gar.corp.intel.com ([10.67.144.155]) by fmsmga006-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Aug 2023 09:43:14 -0700 From: "Vishal R" To: devel@edk2.groups.io Cc: Vishal R , Rebecca Cran , Michael D Kinney , Jayaprakash N Subject: [edk2-devel] [edk2-libc Patch 1/1] edk2-libc/AppPkg: Fix documentation issue with edk2module.c Date: Thu, 3 Aug 2023 22:12:23 +0530 Message-Id: <20230803164223.1584-2-vishal.r@intel.com> In-Reply-To: <20230803164223.1584-1-vishal.r@intel.com> References: <20230803164223.1584-1-vishal.r@intel.com> MIME-Version: 1.0 Precedence: Bulk List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,vishal.r@intel.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: DP72EkjhNC1q3SBY66lHq8oCx7686176AA= Content-Transfer-Encoding: 8bit X-GND-Status: LEGIT Authentication-Results: spool.mail.gandi.net; dkim=pass header.d=groups.io header.s=20140610 header.b=oSy6zmhb; spf=pass (spool.mail.gandi.net: domain of bounce@groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce@groups.io; dmarc=fail reason="SPF not aligned (relaxed), DKIM not aligned (relaxed)" header.from=intel.com (policy=none) 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 Cc: Michael D Kinney Cc: Jayaprakash N Signed-off-by: Vishal R --- .../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/7686176 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io] -=-=-=-=-=-=-=-=-=-=-=-