Message ID | 20190531061351.22973-18-stewart@linux.ibm.com |
---|---|
State | Accepted |
Headers | show
Return-Path: <skiboot-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org> 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 45FZ8J1Jn0z9s00 for <incoming@patchwork.ozlabs.org>; Fri, 31 May 2019 16:21:04 +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 45FZ8J0Q2pzDqbg for <incoming@patchwork.ozlabs.org>; Fri, 31 May 2019 16:21:04 +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=<UNKNOWN>) 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 45FZ0J5zMgzDqXs for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 16:14:08 +1000 (AEST) Received: from pps.filterd (m0098393.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.27/8.16.0.27) with SMTP id x4V64CB6076028 for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 02:14:05 -0400 Received: from e32.co.us.ibm.com (e32.co.us.ibm.com [32.97.110.150]) by mx0a-001b2d01.pphosted.com with ESMTP id 2stvha4a3k-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 02:14:05 -0400 Received: from localhost by e32.co.us.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for <skiboot@lists.ozlabs.org> from <stewart@linux.ibm.com>; Fri, 31 May 2019 07:14:04 +0100 Received: from b03cxnp08026.gho.boulder.ibm.com (9.17.130.18) by e32.co.us.ibm.com (192.168.1.132) 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:02 +0100 Received: from b03ledav006.gho.boulder.ibm.com (b03ledav006.gho.boulder.ibm.com [9.17.130.237]) by b03cxnp08026.gho.boulder.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id x4V6E2qi26870242 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:02 GMT Received: from b03ledav006.gho.boulder.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id E4BB9C6066 for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:01 +0000 (GMT) Received: from b03ledav006.gho.boulder.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id AB7E0C605A for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:01 +0000 (GMT) Received: from birb.localdomain (unknown [9.185.142.91]) by b03ledav006.gho.boulder.ibm.com (Postfix) with ESMTP for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:01 +0000 (GMT) Received: by birb.localdomain (Postfix, from userid 1000) id A38974D922E; Fri, 31 May 2019 16:13:56 +1000 (AEST) From: Stewart Smith <stewart@linux.ibm.com> To: skiboot@lists.ozlabs.org Date: Fri, 31 May 2019 16:12:18 +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-0004-0000-0000-0000151674F5 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:03 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 19053106-0005-0000-0000-00008BDE979B Message-Id: <20190531061351.22973-18-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=979 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1905310040 Subject: [Skiboot] [PATCH 017/110] doc: prettify and RSTify OPAL_NMMU_SET_PTCR X-BeenThere: skiboot@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Mailing list for skiboot development <skiboot.lists.ozlabs.org> List-Unsubscribe: <https://lists.ozlabs.org/options/skiboot>, <mailto:skiboot-request@lists.ozlabs.org?subject=unsubscribe> List-Archive: <http://lists.ozlabs.org/pipermail/skiboot/> List-Post: <mailto:skiboot@lists.ozlabs.org> List-Help: <mailto:skiboot-request@lists.ozlabs.org?subject=help> List-Subscribe: <https://lists.ozlabs.org/listinfo/skiboot>, <mailto:skiboot-request@lists.ozlabs.org?subject=subscribe> Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: skiboot-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "Skiboot" <skiboot-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org> |
Series |
Big documentation cleanup/expansion
|
expand
|
diff --git a/doc/opal-api/opal-nmmu-set-ptcr-127.txt b/doc/opal-api/opal-nmmu-set-ptcr-127.rst similarity index 53% rename from doc/opal-api/opal-nmmu-set-ptcr-127.txt rename to doc/opal-api/opal-nmmu-set-ptcr-127.rst index eac13f32c09c..0e5181cf4ff1 100644 --- a/doc/opal-api/opal-nmmu-set-ptcr-127.txt +++ b/doc/opal-api/opal-nmmu-set-ptcr-127.rst @@ -1,22 +1,29 @@ +.. _OPAL_NMMU_SET_PTCR: + OPAL_NMMU_SET_PTCR -------------------- +------------------ + +.. code-block:: c -#define OPAL_NMMU_SET_PTCR 127 + #define OPAL_NMMU_SET_PTCR 127 -int64 opal_nmmu_set_ptcr(uint64 chip_id, uint64_t ptcr) + int64 opal_nmmu_set_ptcr(uint64 chip_id, uint64_t ptcr); -Arguments: - uint64 chip_id +``uint64 chip_id`` either the chip id containing the nest mmu who's ptcr should be set or alternatively -1ULL to indicate all nest mmu ptcr's should be set to the same value. - uint64 ptcr +``uint64 ptcr`` ptcr value pointing to either the radix tables or hash tables. This OPAL call sets up the Nest MMU by pointing it at the radix page table base or the hash page table base (HTABORG). -Return Values: -OPAL_SUCCESS: the power down was updated successful -OPAL_PARAMETER: a parameter was incorrect +Return Values +^^^^^^^^^^^^^ + +:ref:`OPAL_SUCCESS` + the PTCR was updated successful +:ref:`OPAL_PARAMETER` + a parameter was incorrect
Signed-off-by: Stewart Smith <stewart@linux.ibm.com> --- ...tcr-127.txt => opal-nmmu-set-ptcr-127.rst} | 25 ++++++++++++------- 1 file changed, 16 insertions(+), 9 deletions(-) rename doc/opal-api/{opal-nmmu-set-ptcr-127.txt => opal-nmmu-set-ptcr-127.rst} (53%)