Message ID | 20190531061351.22973-75-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 45FZRX0FhTz9s00 for <incoming@patchwork.ozlabs.org>; Fri, 31 May 2019 16:34:16 +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 45FZRW64XczDqrV for <incoming@patchwork.ozlabs.org>; Fri, 31 May 2019 16:34:15 +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 45FZ0P43RYzDqYk for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 16:14:13 +1000 (AEST) Received: from pps.filterd (m0098399.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.27/8.16.0.27) with SMTP id x4V64AXH136956 for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 02:14:10 -0400 Received: from e17.ny.us.ibm.com (e17.ny.us.ibm.com [129.33.205.207]) by mx0a-001b2d01.pphosted.com with ESMTP id 2stvyfukmy-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 02:14:10 -0400 Received: from localhost by e17.ny.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:08 +0100 Received: from b01cxnp23032.gho.pok.ibm.com (9.57.198.27) by e17.ny.us.ibm.com (146.89.104.204) 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:06 +0100 Received: from b01ledav002.gho.pok.ibm.com (b01ledav002.gho.pok.ibm.com [9.57.199.107]) by b01cxnp23032.gho.pok.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id x4V6E5gF39321918 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:05 GMT Received: from b01ledav002.gho.pok.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 7D7D312405B for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:05 +0000 (GMT) Received: from b01ledav002.gho.pok.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 370F0124055 for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:05 +0000 (GMT) Received: from birb.localdomain (unknown [9.185.142.91]) by b01ledav002.gho.pok.ibm.com (Postfix) with ESMTP for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:05 +0000 (GMT) Received: by birb.localdomain (Postfix, from userid 1000) id BECA850CBC3; Fri, 31 May 2019 16:13:57 +1000 (AEST) From: Stewart Smith <stewart@linux.ibm.com> To: skiboot@lists.ozlabs.org Date: Fri, 31 May 2019 16:13:15 +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-0040-0000-0000-000004F6E3D3 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:07 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 19053106-0041-0000-0000-00000902FEA2 Message-Id: <20190531061351.22973-75-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=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1905310040 Subject: [Skiboot] [PATCH 074/110] doc: prettify OPAL_PCI_SET_PE 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
|
Context | Check | Description |
---|---|---|
snowpatch_ozlabs/apply_patch | success | Successfully applied on branch master (76f7316bc8fc8a18fdbfcbc0e1fe1bb992d2a7d7) |
snowpatch_ozlabs/snowpatch_job_snowpatch-skiboot | fail | Test snowpatch/job/snowpatch-skiboot on branch master |
snowpatch_ozlabs/snowpatch_job_snowpatch-skiboot-dco | success | Signed-off-by present |
diff --git a/doc/opal-api/opal-pci-set-pe-31.rst b/doc/opal-api/opal-pci-set-pe-31.rst index a101b90ca32e..41df454400f2 100644 --- a/doc/opal-api/opal-pci-set-pe-31.rst +++ b/doc/opal-api/opal-pci-set-pe-31.rst @@ -1,9 +1,17 @@ +.. _OPAL_PCI_SET_PE: + OPAL_PCI_SET_PE =============== -:: + +.. code-block:: c #define OPAL_PCI_SET_PE 31 + int64_t opal_pci_set_pe(uint64_t phb_id, uint64_t pe_number, + uint64_t bus_dev_func, uint8_t bus_compare, + uint8_t dev_compare, uint8_t func_compare, + uint8_t pe_action); + **NOTE:** The following two paragraphs come from some old documentation and have not been checked for accuracy. Same goes for bus_compare, dev_compare and func_compare documentation. Do *NOT* assume this documentation is correct @@ -21,12 +29,6 @@ argument, for OPAL to correlate the RID (bus/dev/func) domain of the PE. If a PE domain is changed, the host must call this to reset the PE bus/dev/func domain and then call all other OPAL calls that map PHB IODA resources to update those domains within PHB facilities. -:: - - static int64_t opal_pci_set_pe(uint64_t phb_id, uint64_t pe_number, - uint64_t bus_dev_func, uint8_t bus_compare, - uint8_t dev_compare, uint8_t func_compare, - uint8_t pe_action) ``phb_id`` is the value from the PHB node ibm,opal-phbid property. @@ -75,17 +77,17 @@ update those domains within PHB facilities. OPAL_MAP_PE = 1 }; -Return value: +Returns +------- -OPAL_PARAMETER +:ref:`OPAL_PARAMETER` If one of the following: - - invalid phb - - invalid pe_action - - invalid bus_dev_func - - invalid bus_compare -OPAL_UNSUPPORTED + - invalid phb + - invalid pe_action + - invalid bus_dev_func + - invalid bus_compare +:ref:`OPAL_UNSUPPORTED` PHB does not support set_pe operation - -OPAL_SUCCESS - if opreation was successful +:ref:`OPAL_SUCCESS` + if operation was successful
Signed-off-by: Stewart Smith <stewart@linux.ibm.com> --- doc/opal-api/opal-pci-set-pe-31.rst | 36 +++++++++++++++-------------- 1 file changed, 19 insertions(+), 17 deletions(-)