From patchwork Fri May 31 06:12:47 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stewart Smith X-Patchwork-Id: 1108096 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [203.11.71.2]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 45FZGG5XCBz9sDX for ; Fri, 31 May 2019 16:26:14 +1000 (AEST) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=linux.ibm.com Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 45FZGG4fq0zDqdc for ; Fri, 31 May 2019 16:26:14 +1000 (AEST) X-Original-To: skiboot@lists.ozlabs.org Delivered-To: skiboot@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=linux.ibm.com (client-ip=148.163.156.1; helo=mx0a-001b2d01.pphosted.com; envelope-from=stewart@linux.ibm.com; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=linux.ibm.com Received: from mx0a-001b2d01.pphosted.com (mx0a-001b2d01.pphosted.com [148.163.156.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 45FZ0L6qWbzDqYt for ; Fri, 31 May 2019 16:14:10 +1000 (AEST) Received: from pps.filterd (m0098394.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.27/8.16.0.27) with SMTP id x4V64KrV078616 for ; Fri, 31 May 2019 02:14:07 -0400 Received: from e12.ny.us.ibm.com (e12.ny.us.ibm.com [129.33.205.202]) by mx0a-001b2d01.pphosted.com with ESMTP id 2stv42d073-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Fri, 31 May 2019 02:14:07 -0400 Received: from localhost by e12.ny.us.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Fri, 31 May 2019 07:14:06 +0100 Received: from b01cxnp22033.gho.pok.ibm.com (9.57.198.23) by e12.ny.us.ibm.com (146.89.104.199) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Fri, 31 May 2019 07:14:04 +0100 Received: from b01ledav002.gho.pok.ibm.com (b01ledav002.gho.pok.ibm.com [9.57.199.107]) by b01cxnp22033.gho.pok.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id x4V6E3lt36831440 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Fri, 31 May 2019 06:14:04 GMT Received: from b01ledav002.gho.pok.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id D809A12405A for ; Fri, 31 May 2019 06:14:03 +0000 (GMT) Received: from b01ledav002.gho.pok.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 94B35124054 for ; Fri, 31 May 2019 06:14:03 +0000 (GMT) Received: from birb.localdomain (unknown [9.185.142.91]) by b01ledav002.gho.pok.ibm.com (Postfix) with ESMTP for ; Fri, 31 May 2019 06:14:03 +0000 (GMT) Received: by birb.localdomain (Postfix, from userid 1000) id 3A0FC503F8A; Fri, 31 May 2019 16:13:57 +1000 (AEST) From: Stewart Smith To: skiboot@lists.ozlabs.org Date: Fri, 31 May 2019 16:12:47 +1000 X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190531061351.22973-1-stewart@linux.ibm.com> References: <20190531061351.22973-1-stewart@linux.ibm.com> MIME-Version: 1.0 X-TM-AS-GCONF: 00 x-cbid: 19053106-0060-0000-0000-0000034A56E0 X-IBM-SpamModules-Scores: X-IBM-SpamModules-Versions: BY=3.00011189; HX=3.00000242; KW=3.00000007; PH=3.00000004; SC=3.00000286; SDB=6.01211088; UDB=6.00636341; IPR=6.00992124; MB=3.00027126; MTD=3.00000008; XFM=3.00000015; UTC=2019-05-31 06:14:06 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 19053106-0061-0000-0000-0000498FD373 Message-Id: <20190531061351.22973-47-stewart@linux.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2019-05-31_03:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=1 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=912 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1905310040 Subject: [Skiboot] [PATCH 046/110] doc: Clean up OPAL power shift ratio docs X-BeenThere: skiboot@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Mailing list for skiboot development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: skiboot-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "Skiboot" Signed-off-by: Stewart Smith --- doc/opal-api/opal-power-shift-ratio.rst | 60 +++++++++++++------------ 1 file changed, 32 insertions(+), 28 deletions(-) diff --git a/doc/opal-api/opal-power-shift-ratio.rst b/doc/opal-api/opal-power-shift-ratio.rst index b9c7854532dd..4437b55bb730 100644 --- a/doc/opal-api/opal-power-shift-ratio.rst +++ b/doc/opal-api/opal-power-shift-ratio.rst @@ -1,7 +1,19 @@ .. _opal-psr: +====================== +OPAL Power Shift Ratio +====================== + +Sometimes power management firmware needs to throttle power availability +to system components in order to keep within power cap or thermal limits. +It's possible to set a preference as to what trade-offs power management +firmware will make. For example, certain workloads may heavily prefer +throttling CPU over GPUs or vice-versa. + +.. _OPAL_GET_POWER_SHIFT_RATIO: + OPAL_GET_POWER_SHIFT_RATIO -============================== +========================== OPAL call to read the power-shifting-ratio using a handle to identify the type (e.g CPU vs. GPU, CPU vs. MEM) which is exported via device-tree. @@ -21,24 +33,23 @@ u32 \*ratio Returns ------- -OPAL_SUCCESS - Success -OPAL_PARAMETER +:ref:`OPAL_SUCCESS` + Success +:ref:`OPAL_PARAMETER` Invalid ratio pointer - -OPAL_UNSUPPORTED +:ref:`OPAL_UNSUPPORTED` No support for reading psr - -OPAL_HARDWARE +:ref:`OPAL_HARDWARE` Unable to procced due to the current hardware state - -OPAL_ASYNC_COMPLETION +:ref:`OPAL_ASYNC_COMPLETION` Request was sent and an async completion message will be sent with token and status of the request. +.. _OPAL_SET_POWER_SHIFT_RATIO: + OPAL_SET_POWER_SHIFT_RATIO -============================== +========================== OPAL call to set power-shifting-ratio using a handle to identify the type of PSR which is exported in device-tree. This call can be asynchronus where the token parameter is used to wait for the @@ -56,30 +67,23 @@ u32 ratio Returns ------- -OPAL_SUCCESS - Success -OPAL_PARAMETER +:ref:`OPAL_SUCCESS` + Success +:ref:`OPAL_PARAMETER` Invalid ratio requested - -OPAL_UNSUPPORTED +:ref:`OPAL_UNSUPPORTED` No support for changing the ratio - -OPAL_PERMISSION +:ref:`OPAL_PERMISSION` Hardware cannot take the request - -OPAL_ASYNC_COMPLETION +:ref:`OPAL_ASYNC_COMPLETION` Request was sent and an async completion message will be sent with token and status of the request. - -OPAL_HARDWARE +:ref:`OPAL_HARDWARE` Unable to procced due to the current hardware state - -OPAL_BUSY +:ref:`OPAL_BUSY` Previous request in progress - -OPAL_INTERNAL_ERROR +:ref:`OPAL_INTERNAL_ERROR` Error in request response - -OPAL_TIMEOUT +:ref:`OPAL_TIMEOUT` Timeout in request completion