From patchwork Mon Apr 3 07:41:47 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: maddy X-Patchwork-Id: 746295 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.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3vxPHC0t9Kz9s7q for ; Mon, 3 Apr 2017 17:43:35 +1000 (AEST) Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 3vxPHC075PzDqMV for ; Mon, 3 Apr 2017 17:43:35 +1000 (AEST) 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 3vxPG04BRVzDqH6 for ; Mon, 3 Apr 2017 17:42:32 +1000 (AEST) Received: from pps.filterd (m0098413.ppops.net [127.0.0.1]) by mx0b-001b2d01.pphosted.com (8.16.0.20/8.16.0.20) with SMTP id v337XvTU075005 for ; Mon, 3 Apr 2017 03:42:22 -0400 Received: from e28smtp01.in.ibm.com (e28smtp01.in.ibm.com [125.16.236.1]) by mx0b-001b2d01.pphosted.com with ESMTP id 29k3yc1c00-1 (version=TLSv1.2 cipher=AES256-SHA bits=256 verify=NOT) for ; Mon, 03 Apr 2017 03:42:21 -0400 Received: from localhost by e28smtp01.in.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Mon, 3 Apr 2017 13:12:18 +0530 Received: from d28relay02.in.ibm.com (9.184.220.59) by e28smtp01.in.ibm.com (192.168.1.131) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; Mon, 3 Apr 2017 13:12:17 +0530 Received: from d28av01.in.ibm.com (d28av01.in.ibm.com [9.184.220.63]) by d28relay02.in.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id v337gGeD8716476 for ; Mon, 3 Apr 2017 13:12:16 +0530 Received: from d28av01.in.ibm.com (localhost [127.0.0.1]) by d28av01.in.ibm.com (8.14.4/8.14.4/NCO v10.0 AVout) with ESMTP id v337gEvP009859 for ; Mon, 3 Apr 2017 13:12:16 +0530 Received: from SrihariSrinidhi.in.ibm.com ([9.79.210.235]) by d28av01.in.ibm.com (8.14.4/8.14.4/NCO v10.0 AVin) with ESMTP id v337fxm2009412; Mon, 3 Apr 2017 13:12:14 +0530 From: Madhavan Srinivasan To: stewart@linux.vnet.ibm.com Date: Mon, 3 Apr 2017 13:11:47 +0530 X-Mailer: git-send-email 2.7.4 In-Reply-To: <1491205307-20408-1-git-send-email-maddy@linux.vnet.ibm.com> References: <1491205307-20408-1-git-send-email-maddy@linux.vnet.ibm.com> X-TM-AS-MML: disable x-cbid: 17040307-7323-0000-0000-000000E66C5D X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 17040307-7324-0000-0000-0000028BA47A Message-Id: <1491205307-20408-11-git-send-email-maddy@linux.vnet.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10432:, , definitions=2017-04-03_05:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 spamscore=0 suspectscore=1 malwarescore=0 phishscore=0 adultscore=0 bulkscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1702020001 definitions=main-1704030070 Subject: [Skiboot] [PATCH v8 10/10] skiboot: Add documentation for the Core IMC opal call 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: , Cc: mikey@neuling.org, skiboot@lists.ozlabs.org MIME-Version: 1.0 Errors-To: skiboot-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "Skiboot" From: Hemant Kumar Adds documentation for the opal_core_imc_counters_control() interface. Signed-off-by: Hemant Kumar Signed-off-by: Madhavan Srinivasan --- doc/opal-api/opal-core-imc-counters.rst | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 doc/opal-api/opal-core-imc-counters.rst diff --git a/doc/opal-api/opal-core-imc-counters.rst b/doc/opal-api/opal-core-imc-counters.rst new file mode 100644 index 000000000000..f7390a20f603 --- /dev/null +++ b/doc/opal-api/opal-core-imc-counters.rst @@ -0,0 +1,33 @@ +The interface can be extended to include more modes and operations +available in core IMC. + +Parameters +---------- +``uint64_t operation`` + 3 operations are supported for now (include/opal-api.h) : + - OPAL_CORE_IMC_DISABLE -- disable or stop the counters + - OPAL_CORE_IMC_ENABLE -- enable/resume the counters + - OPAL_CORE_IMC_INIT -- Initialize and enable the counters. + +``uint64_t addr`` + For OPAL_CORE_IMC_INIT, this parameter must have a non-zero value. + This value must be a per-core physical address. + For other operations, this value is undefined and must be zero. + +``uint64_t value_1`` + - This parameter is undefined for now and must be zero. + +``uint64_t value_2`` + - This parameter is undefined for now and must be zero. + +Returns +------- +OPAL_PARAMETER + In any one/some/all of the following cases : + - Unsupported ``operation`` + - Wrong ``addr`` for the given ``operation`` + - Non-zero ``value_1`` or ``value_2`` +OPAL_HARDWARE + If xscom_write fails. +OPAL_SUCCESS + On successful execution of the ``operation``.