From patchwork Fri May 31 06:12:17 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stewart Smith X-Patchwork-Id: 1108056 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 45FZ2h4kkmz9sB8 for ; Fri, 31 May 2019 16:16:12 +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 45FZ2h3rJQzDqYP for ; Fri, 31 May 2019 16:16:12 +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.158.5; 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 (mx0b-001b2d01.pphosted.com [148.163.158.5]) (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 45FZ0H2y87zDqXs for ; Fri, 31 May 2019 16:14:06 +1000 (AEST) Received: from pps.filterd (m0098414.ppops.net [127.0.0.1]) by mx0b-001b2d01.pphosted.com (8.16.0.27/8.16.0.27) with SMTP id x4V642JC133887 for ; Fri, 31 May 2019 02:14:04 -0400 Received: from ppma01dal.us.ibm.com (83.d6.3fa9.ip4.static.sl-reverse.com [169.63.214.131]) by mx0b-001b2d01.pphosted.com with ESMTP id 2stwdwjr0e-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT) for ; Fri, 31 May 2019 02:14:04 -0400 Received: from pps.filterd (ppma01dal.us.ibm.com [127.0.0.1]) by ppma01dal.us.ibm.com (8.16.0.27/8.16.0.27) with SMTP id x4V2dnPC006009 for ; Fri, 31 May 2019 02:48:55 GMT Received: from b03cxnp08026.gho.boulder.ibm.com (b03cxnp08026.gho.boulder.ibm.com [9.17.130.18]) by ppma01dal.us.ibm.com with ESMTP id 2spwb9ayk9-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT) for ; Fri, 31 May 2019 02:48:55 +0000 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 x4V6E14w7537112 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; 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 DA6F8C6062 for ; 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 A3052C6055 for ; 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 ; Fri, 31 May 2019 06:14:01 +0000 (GMT) Received: by birb.localdomain (Postfix, from userid 1000) id 9E6514DFDC5; Fri, 31 May 2019 16:13:56 +1000 (AEST) From: Stewart Smith To: skiboot@lists.ozlabs.org Date: Fri, 31 May 2019 16:12:17 +1000 Message-Id: <20190531061351.22973-17-stewart@linux.ibm.com> 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-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=997 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1905310040 Subject: [Skiboot] [PATCH 016/110] doc: prettify OPAL_[GET|SET]_PBCQ_TUNNEL_BAR 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 --- ...al-pci-get-set-pbcq-tunnel-bar-164-165.rst | 42 ++++++++----------- 1 file changed, 18 insertions(+), 24 deletions(-) diff --git a/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst b/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst index 95ee32431ab3..87a2c7decdf1 100644 --- a/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst +++ b/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst @@ -1,20 +1,19 @@ +.. _OPAL_PCI_GET_PBCQ_TUNNEL_BAR: + OPAL_PCI_GET_PBCQ_TUNNEL_BAR ============================ -:: + +.. code-block:: c #define OPAL_PCI_GET_PBCQ_TUNNEL_BAR 164 - int64_t opal_pci_get_pbcq_tunnel_bar(uint64_t phb_id, uint64_t *addr) + int64_t opal_pci_get_pbcq_tunnel_bar(uint64_t phb_id, uint64_t *addr); The host calls this function to read the address out of the PBCQ Tunnel Bar register. Parameters ---------- -:: - - uint64_t phb_id - uint64_t *addr ``phb_id`` The value from the PHB node ibm,opal-phbid property for the device. @@ -26,36 +25,33 @@ Parameters Return Values ------------- -``OPAL_SUCCESS`` +:ref:`OPAL_SUCCESS` Operation was successful - -``OPAL_PARAMETER`` +:ref:`OPAL_PARAMETER` Invalid PHB or addr parameter - -``OPAL_UNSUPPORTED`` +:ref:`OPAL_UNSUPPORTED` Not supported by hardware +.. _OPAL_PCI_SET_PBCQ_TUNNEL_BAR: + OPAL_PCI_SET_PBCQ_TUNNEL_BAR ============================ -:: + +.. code-block:: c #define OPAL_PCI_SET_PBCQ_TUNNEL_BAR 165 - int64_t opal_pci_set_pbcq_tunnel_bar(uint64_t phb_id, uint64_t addr) + int64_t opal_pci_set_pbcq_tunnel_bar(uint64_t phb_id, uint64_t addr); The host calls this function to set the PBCQ Tunnel Bar register. Parameters ---------- -:: - - uint64_t phb_id - uint64_t addr -``phb_id`` +:ref:``phb_id` The value from the PHB node ibm,opal-phbid property for the device. -``addr`` +:ref:`addr` The value of the address chosen for the PBCQ Tunnel Bar register. If the address is 0, then the PBCQ Tunnel Bar register will be reset. It the address is non-zero, then the PBCQ Tunnel Bar register will be @@ -66,11 +62,9 @@ Parameters Return Values ------------- -``OPAL_SUCCESS`` +:ref:`OPAL_SUCCESS` Operation was successful - -``OPAL_PARAMETER`` +:ref:`OPAL_PARAMETER` Invalid PHB or addr parameter - -``OPAL_UNSUPPORTED`` +:ref:`OPAL_UNSUPPORTED` Not supported by hardware