From patchwork Fri May 31 06:13:24 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stewart Smith X-Patchwork-Id: 1108135 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) (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 45FZRL0DH7z9s00 for ; Fri, 31 May 2019 16:34:06 +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 45FZRK6ShLzDqnv for ; Fri, 31 May 2019 16:34:05 +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 45FZ0P1mKtzDqZR for ; Fri, 31 May 2019 16:14:13 +1000 (AEST) Received: from pps.filterd (m0098419.ppops.net [127.0.0.1]) by mx0b-001b2d01.pphosted.com (8.16.0.27/8.16.0.27) with SMTP id x4V655Vl135191 for ; Fri, 31 May 2019 02:14:09 -0400 Received: from e31.co.us.ibm.com (e31.co.us.ibm.com [32.97.110.149]) by mx0b-001b2d01.pphosted.com with ESMTP id 2stv224n63-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Fri, 31 May 2019 02:14:09 -0400 Received: from localhost by e31.co.us.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Fri, 31 May 2019 07:14:08 +0100 Received: from b03cxnp07029.gho.boulder.ibm.com (9.17.130.16) by e31.co.us.ibm.com (192.168.1.131) 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 b03ledav002.gho.boulder.ibm.com (b03ledav002.gho.boulder.ibm.com [9.17.130.233]) by b03cxnp07029.gho.boulder.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id x4V6E5L911927866 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Fri, 31 May 2019 06:14:05 GMT Received: from b03ledav002.gho.boulder.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id AF51213604F for ; Fri, 31 May 2019 06:14:05 +0000 (GMT) Received: from b03ledav002.gho.boulder.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 787A8136055 for ; Fri, 31 May 2019 06:14:05 +0000 (GMT) Received: from birb.localdomain (unknown [9.185.142.91]) by b03ledav002.gho.boulder.ibm.com (Postfix) with ESMTP for ; Fri, 31 May 2019 06:14:05 +0000 (GMT) Received: by birb.localdomain (Postfix, from userid 1000) id EA39F50CBD4; Fri, 31 May 2019 16:13:57 +1000 (AEST) From: Stewart Smith To: skiboot@lists.ozlabs.org Date: Fri, 31 May 2019 16:13:24 +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-8235-0000-0000-00000EA0F3AD 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-8236-0000-0000-000045C9C0F3 Message-Id: <20190531061351.22973-84-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=640 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1905310040 Subject: [Skiboot] [PATCH 083/110] doc: prettify OPAL_PCI_MAP_PE_DMA_WINDOW[_REAL] 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-pci-map-pe-dma-window-44.rst | 11 ++++++++--- .../opal-pci-map-pe-dma-window-real-45.rst | 14 ++++++++++++-- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/doc/opal-api/opal-pci-map-pe-dma-window-44.rst b/doc/opal-api/opal-pci-map-pe-dma-window-44.rst index bec8f087c18e..9450629f0d1d 100644 --- a/doc/opal-api/opal-pci-map-pe-dma-window-44.rst +++ b/doc/opal-api/opal-pci-map-pe-dma-window-44.rst @@ -1,6 +1,9 @@ +.. _OPAL_PCI_MAP_PE_DMA_WINDOW: + OPAL_PCI_MAP_PE_DMA_WINDOW ========================== -:: + +.. code-block:: c #define OPAL_PCI_MAP_PE_DMA_WINDOW 44 @@ -10,7 +13,7 @@ OPAL_PCI_MAP_PE_DMA_WINDOW uint16_t tce_levels, uint64_t tce_table_addr, uint64_t tce_table_size, - uint64_t tce_page_size) + uint64_t tce_page_size); **WARNING:** following documentation is from old sources, and is possibly not representative of OPALv3 as implemented by skiboot. This should be @@ -94,7 +97,9 @@ a win_size_32 = 256MB, only 16 DMA windows (and therefore no more than 16 distinct PEs) can map the 4GB of 32-bit PCI memory for DMA. OPAL does not police this limitation. -Return value: :: +Return value: + +.. code-block:: c if (!phb) return OPAL_PARAMETER; diff --git a/doc/opal-api/opal-pci-map-pe-dma-window-real-45.rst b/doc/opal-api/opal-pci-map-pe-dma-window-real-45.rst index bc364dc4739e..87395d1ee593 100644 --- a/doc/opal-api/opal-pci-map-pe-dma-window-real-45.rst +++ b/doc/opal-api/opal-pci-map-pe-dma-window-real-45.rst @@ -1,9 +1,19 @@ +.. _OPAL_PCI_MAP_PE_DMA_WINDOW_REAL: + OPAL_PCI_MAP_PE_DMA_WINDOW_REAL =============================== -:: + +.. code-block:: c #define OPAL_PCI_MAP_PE_DMA_WINDOW_REAL 45 + int64_t opal_pci_map_pe_dma_window_real(uint64_t phb_id, + uint64_t pe_number, + uint16_t window_id, + uint64_t pci_start_addr, + uint64_t pci_mem_size); + + **WARNING:** following documentation is from old sources, and is possibly not representative of OPALv3 as implemented by skiboot. This should be used as a starting point for full documentation. @@ -40,6 +50,6 @@ within the window set associated with the specified PE number. ``window_size`` is the size, in bytes, of the address range defined by this - window. This value must be a multiple of 16MB; OPAL returns OPAL_PARAMETER + window. This value must be a multiple of 16MB; OPAL returns :ref:`OPAL_PARAMETER` for any value that is not a multiple of 16MB. A value of '0' indicates to disable this DMA window.