From patchwork Mon Apr 3 07:41:46 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: maddy X-Patchwork-Id: 746296 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 3vxPHK374Sz9s7q for ; Mon, 3 Apr 2017 17:43:41 +1000 (AEST) Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 3vxPHK2N4JzDqNC for ; Mon, 3 Apr 2017 17:43:41 +1000 (AEST) X-Original-To: skiboot@lists.ozlabs.org Delivered-To: skiboot@lists.ozlabs.org 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 3vxPG153N5zDqH6 for ; Mon, 3 Apr 2017 17:42:33 +1000 (AEST) Received: from pps.filterd (m0098394.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.20/8.16.0.20) with SMTP id v337Y03l074611 for ; Mon, 3 Apr 2017 03:42:21 -0400 Received: from e28smtp04.in.ibm.com (e28smtp04.in.ibm.com [125.16.236.4]) by mx0a-001b2d01.pphosted.com with ESMTP id 29k4r1qgmc-1 (version=TLSv1.2 cipher=AES256-SHA bits=256 verify=NOT) for ; Mon, 03 Apr 2017 03:42:21 -0400 Received: from localhost by e28smtp04.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 d28relay06.in.ibm.com (9.184.220.150) by e28smtp04.in.ibm.com (192.168.1.134) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; Mon, 3 Apr 2017 13:12:16 +0530 Received: from d28av01.in.ibm.com (d28av01.in.ibm.com [9.184.220.63]) by d28relay06.in.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id v337gFbB20447234 for ; Mon, 3 Apr 2017 13:12:15 +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 v337gDtR009822 for ; Mon, 3 Apr 2017 13:12:15 +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 v337fxm1009412; Mon, 3 Apr 2017 13:12:13 +0530 From: Madhavan Srinivasan To: stewart@linux.vnet.ibm.com Date: Mon, 3 Apr 2017 13:11:46 +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-0012-0000-0000-000003DA6917 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 17040307-0013-0000-0000-00001B609263 Message-Id: <1491205307-20408-10-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 09/10] skiboot: Add documentation for nest 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 This patch adds documentation for the the opal call opal_nest_imc_counters_control(). Signed-off-by: Hemant Kumar Signed-off-by: Madhavan Srinivasan --- doc/opal-api/opal-nest-imc-counters.rst | 49 +++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 doc/opal-api/opal-nest-imc-counters.rst diff --git a/doc/opal-api/opal-nest-imc-counters.rst b/doc/opal-api/opal-nest-imc-counters.rst new file mode 100644 index 000000000000..f8f5ad3ad5d1 --- /dev/null +++ b/doc/opal-api/opal-nest-imc-counters.rst @@ -0,0 +1,49 @@ +OPAL_NEST_IMC_COUNTERS_CONTROL +============================== + +OPAL call interface for per-chip nest instrumentation support. +Currently, the interface supports starting and stopping the In Memory +Collection Microcode running in the OCC complex for Nest +Instrumentation from Host OS. + +The interface can be extended to include more modes and operations to use +the multiple debug modes for nest IMC instrumentation. + +Parameters +---------- +``uint64_t mode`` + Currently, only production mode is supported. + The "OPAL_NEST_IMC_PRODUCTION_MODE" macro defined in "include/imc.h" + is used for this. + +``uint64_t operation`` + For "OPAL_NEST_IMC_PRODUCTION_MODE" mode, this parameter is used + to start and stop the IMC microcode. (include/opal-api.h) + + - OPAL_NEST_IMC_STOP -- Stop + - OPAL_NEST_IMC_START -- Start + + For other modes, this parameter is undefined for now. + +``uint64_t value_1`` + - For "OPAL_NEST_IMC_PRODUCTION_MODE" mode, this parameter should be + zero. + - For other modes, this parameter is undefined for now. + +``uint64_t value_3`` + - For "OPAL_NEST_IMC_PRODUCTION_MODE" mode, this parameter should be + zero. + - For other modes, this parameter is undefined for now. + +Returns +------- +OPAL_PARAMETER + In any one/some/all of the following cases : + + - Unsupported ``mode`` + - Unsupported ``operation`` + - Non-zero ``value_1`` or ``value_2`` +OPAL_HARDWARE + If xscom_write fails. +OPAL_SUCCESS + On successful execution of the ``operation`` in the given ``mode``.