From patchwork Wed Oct 26 13:41:18 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Nageswara R Sastry X-Patchwork-Id: 687103 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [103.22.144.68]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3t3rp26rHnz9t0q for ; Thu, 27 Oct 2016 00:43:38 +1100 (AEDT) Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 3t3rp25nYVzDvHJ for ; Thu, 27 Oct 2016 00:43:38 +1100 (AEDT) X-Original-To: skiboot@lists.ozlabs.org Delivered-To: skiboot@lists.ozlabs.org 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 3t3rnz74BtzDt8v for ; Thu, 27 Oct 2016 00:43:35 +1100 (AEDT) Received: from pps.filterd (m0098421.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.17/8.16.0.17) with SMTP id u9QDfj3P095658 for ; Wed, 26 Oct 2016 09:43:33 -0400 Received: from e33.co.us.ibm.com (e33.co.us.ibm.com [32.97.110.151]) by mx0a-001b2d01.pphosted.com with ESMTP id 26aw33hynq-1 (version=TLSv1.2 cipher=AES256-SHA bits=256 verify=NOT) for ; Wed, 26 Oct 2016 09:43:33 -0400 Received: from localhost by e33.co.us.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Wed, 26 Oct 2016 07:43:32 -0600 Received: from d03dlp03.boulder.ibm.com (9.17.202.179) by e33.co.us.ibm.com (192.168.1.133) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; Wed, 26 Oct 2016 07:43:31 -0600 Received: from b03cxnp08027.gho.boulder.ibm.com (b03cxnp08027.gho.boulder.ibm.com [9.17.130.19]) by d03dlp03.boulder.ibm.com (Postfix) with ESMTP id 633B919D803F for ; Wed, 26 Oct 2016 07:42:55 -0600 (MDT) Received: from b03ledav003.gho.boulder.ibm.com (b03ledav003.gho.boulder.ibm.com [9.17.130.234]) by b03cxnp08027.gho.boulder.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id u9QDhUMq13107708; Wed, 26 Oct 2016 06:43:30 -0700 Received: from b03ledav003.gho.boulder.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 5E32C6A043; Wed, 26 Oct 2016 07:43:30 -0600 (MDT) Received: from localhost.localdomain (unknown [9.79.185.89]) by b03ledav003.gho.boulder.ibm.com (Postfix) with ESMTP id 6C66F6A03D; Wed, 26 Oct 2016 07:43:29 -0600 (MDT) From: Nageswara R Sastry To: skiboot@lists.ozlabs.org Date: Wed, 26 Oct 2016 19:11:18 +0530 X-Mailer: git-send-email 2.8.4 (Apple Git-73) MIME-Version: 1.0 X-TM-AS-GCONF: 00 X-Content-Scanned: Fidelis XPS MAILER x-cbid: 16102613-0008-0000-0000-000005E7D969 X-IBM-SpamModules-Scores: X-IBM-SpamModules-Versions: BY=3.00005982; HX=3.00000240; KW=3.00000007; PH=3.00000004; SC=3.00000188; SDB=6.00773016; UDB=6.00371117; IPR=6.00549847; BA=6.00004834; NDR=6.00000001; ZLA=6.00000005; ZF=6.00000009; ZB=6.00000000; ZP=6.00000000; ZH=6.00000000; ZU=6.00000002; MB=3.00013107; XFM=3.00000011; UTC=2016-10-26 13:43:32 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 16102613-0009-0000-0000-00003C75E280 Message-Id: <20161026134118.60820-1-rnsastry@linux.vnet.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10432:, , definitions=2016-10-26_06:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_spam_definite policy=outbound score=100 spamscore=100 suspectscore=1 malwarescore=0 phishscore=0 adultscore=0 bulkscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1609300000 definitions=main-1610260235 Subject: [Skiboot] [PATCH] Documentation for OPAL_LPC_READ, OPAL_LPC_WRITE X-BeenThere: skiboot@lists.ozlabs.org X-Mailman-Version: 2.1.23 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" Documentation for OPAL_LPC_READ 67 and OPAL_LPC_WRITE 68 Signed-off-by: Nageswara R Sastry --- doc/opal-api/opal-lpc-read-write-67-68.rst | 82 ++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 doc/opal-api/opal-lpc-read-write-67-68.rst diff --git a/doc/opal-api/opal-lpc-read-write-67-68.rst b/doc/opal-api/opal-lpc-read-write-67-68.rst new file mode 100644 index 0000000..7841474 --- /dev/null +++ b/doc/opal-api/opal-lpc-read-write-67-68.rst @@ -0,0 +1,82 @@ +OPAL_LPC_READ +============= +:: + + This function related to Low Pin Count (LPC) bus. This function reads the + data from IDSEL register for ``chip_id``, which has LPC information. + From ``addr`` for ``addr_type`` with read size ``sz`` bytes in to a + variable named ``data``. + +Parameters +---------- + +``chip_id`` + The ``chip_id`` parameter contains value of the chip number identified at + boot time. + +``addr_type`` + The ``addr_type`` is one of the LPC supported address types. + Supported address types are - + LPC memory, + LPC IO and + LPC firmware. + +``addr`` + The ``addr`` from which the data has to be read. + +``data`` + The ``data`` will be used to store the read data. + +``sz`` + How many ``sz`` bytes to be read in to ``data``. + +Return Codes +------------ + +``OPAL_PARAMETER`` + Indicates either ``chip_id`` not found or ``chip_id`` doesn’t contain + LPC information. + +``OPAL_SUCCESS`` + Indicates Success! + +OPAL_LPC_WRITE +============== +:: + + This function related to Low Pin Count (LPC) bus. This function writes the + ``data`` in to ECCB register for ``chip_id``, which has LPC information. + From ``addr`` for ``addr_type`` with write size ``sz`` bytes. + +Parameters +---------- + +``chip_id`` + The ``chip_id`` parameter contains value of the chip number identified at + boot time. + +``addr_type`` + The ``addr_type`` is one of the address types LPC supported. + Supported address types are - + LPC memory, + LPC IO and + LPC firmware. + +``addr`` + The ``addr`` to where the ``data`` need to be written. + +``data`` + The ``data`` for writing. + +``sz`` + How many ``sz`` bytes to write. + +Return Codes +------------ + +``OPAL_PARAMETER`` + Indicates either ``chip_id`` not found or ``chip_id`` doesn’t contain LPC + information. + +``OPAL_SUCCESS`` + Indicates Success!