From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id CB5E9A04B0; Sat, 24 Oct 2020 22:49:22 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 43984B85; Sat, 24 Oct 2020 22:49:21 +0200 (CEST) Received: from new2-smtp.messagingengine.com (new2-smtp.messagingengine.com [66.111.4.224]) by dpdk.org (Postfix) with ESMTP id A54E4B55 for ; Sat, 24 Oct 2020 22:49:20 +0200 (CEST) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailnew.nyi.internal (Postfix) with ESMTP id 3AC9458029B; Sat, 24 Oct 2020 16:49:19 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Sat, 24 Oct 2020 16:49:19 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding:content-type; s=fm2; bh= cOB+OBSLnCcTskMqwp5vByIbzeMcKzTACXmq/6N2Yl0=; b=J3Lyl9VGnf0BO2P8 7P409P7DaEDic+yfiozC8WeOcRAfr7IzNfH6EkWztHXBm3gQQKT2AhBZihGkObPi yfkLgaMnXNLcVWTgK8A8Z2XC3agWQKF7V3azuHzJ8RQ2qgZ/3c7oRJ2zNL8lu0r5 4l0xv8YEH+An5KuorNg9WQ9sg6vD/e0VgL6BIxlcVhAjbesX2Wc4fTNWbqkP4dFE DGLzFV85XOE/YMj3+zqtNcusq8+fSnSgBc6eZ3VNvzbb4Gc3WYaQB/1jOz6BYlLC z1LVntzoHW+IaKrPMUoPYhMdk51RifPot03EK5Lbvp7rbMNoj0zOEQfvCh8SQHkc dWvRLQ== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm1; bh=cOB+OBSLnCcTskMqwp5vByIbzeMcKzTACXmq/6N2Y l0=; b=Gk1LYrdka9T9NRuhI8GFiEvkYhlH2irZ2++FrqCTH4nmUWaO/tLyF9NFi 1hq8RfGEVMHuhyfEkVO5b9kGdPd580czLtXRKwZaKUpiHRM9jT8iOk7VZMfLgH6m 3OJ4KzYi/yD9kqSIELMEhTkJGNKqvPiWoMl3Jwvggt/a9pFTExkvcJRzb+plOjdL kINJwjBABNFMrzm9iAbJloLedwBxfAwvgaUeQ4kWqprrLrUeK0vQVGokoD1dKPoU tirNnG3/h0ncc2/xFXxSYcIiCEyXm2cnjhqMMHBogJpHAypKuKz8pdLRB1XLPpMO M9X1y3QAp6/TfbA+A2KEveJCxALEA== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedujedrkedvgdduheegucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucenucfjughrpefhvffufffkjghfggfgtgesthfure dttddtvdenucfhrhhomhepvfhhohhmrghsucfoohhnjhgrlhhonhcuoehthhhomhgrshes mhhonhhjrghlohhnrdhnvghtqeenucggtffrrghtthgvrhhnpedugefgvdefudfftdefge elgffhueekgfffhfeujedtteeutdejueeiiedvffegheenucfkphepjeejrddufeegrddv tdefrddukeegnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrh homhepthhhohhmrghssehmohhnjhgrlhhonhdrnhgvth X-ME-Proxy: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 83D11306467D; Sat, 24 Oct 2020 16:49:13 -0400 (EDT) From: Thomas Monjalon To: Liang Ma Cc: dev@dpdk.org, anatoly.burakov@intel.com, viktorin@rehivetech.com, qi.z.zhang@intel.com, ruifeng.wang@arm.com, beilei.xing@intel.com, jia.guo@intel.com, qiming.yang@intel.com, haiyue.wang@intel.com, bruce.richardson@intel.com, konstantin.ananyev@intel.com, david.hunt@intel.com, jerinjacobk@gmail.com, nhorman@tuxdriver.com, timothy.mcdaniel@intel.com, gage.eads@intel.com, drc@linux.vnet.ibm.com Date: Sat, 24 Oct 2020 22:49:12 +0200 Message-ID: <2125071.1A0xf8Un5s@thomas> In-Reply-To: <1603494392-7181-11-git-send-email-liang.j.ma@intel.com> References: <1603494392-7181-11-git-send-email-liang.j.ma@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [dpdk-dev] [PATCH v9 10/10] doc: update programmer's guide for power library X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 24/10/2020 01:06, Liang Ma: > Update programmer's guide to document PMD power management usage. > > Signed-off-by: Liang Ma > Signed-off-by: Anatoly Burakov > Acked-by: David Hunt > --- > doc/guides/prog_guide/power_man.rst | 42 +++++++++++++++++++++++++++++ > 1 file changed, 42 insertions(+) Why don't you update this doc in the patch 5 adding the code in the power library? > --- a/doc/guides/prog_guide/power_man.rst > +++ b/doc/guides/prog_guide/power_man.rst > @@ -192,6 +192,45 @@ User Cases > ---------- > The mechanism can applied to any device which is based on polling. e.g. NIC, FPGA. > > +PMD Power Management API > +------------------------ > + Blank line missing below: > +Abstract > +~~~~~~~~ > +Existing power management mechanisms require developers to change application > +design or change code to make use of it. The PMD power management API provides a > +convenient alternative by utilizing Ethernet PMD RX callbacks, and triggering > +power saving whenever empty poll count reaches a certain number. > + Here you start a list of schemes, without introducing it. > + * UMWAIT/UMONITOR > + > + This power saving scheme will put the CPU into optimized power state and use > + the UMWAIT/UMONITOR instructions to monitor the Ethernet PMD RX descriptor > + address, and wake the CPU up whenever there's new traffic. > + > + * Pause > + > + This power saving scheme will use the `rte_pause` function to avoid busy > + polling. > + > + * Frequency scaling > + > + This power saving scheme will use existing power library functionality to > + scale the core frequency up/down depending on traffic volume. > + > + > +.. note:: > + > + Currently, this power management API is limited to mandatory mapping of 1 > + queue to 1 core (multiple queues are supported, but they must be polled from > + different cores). > + > +API Overview for PMD Power Management > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Underlining is long enough... ... but a blank line is missing after the title. > +* **Queue Enable**: Enable specific power scheme for certain queue/port/core > + > +* **Queue Disable**: Disable power scheme for certain queue/port/core