{"id":814254,"url":"http://patchwork.ozlabs.org/api/patches/814254/?format=json","web_url":"http://patchwork.ozlabs.org/project/skiboot/patch/1505478062-1623-9-git-send-email-akshay.adiga@linux.vnet.ibm.com/","project":{"id":44,"url":"http://patchwork.ozlabs.org/api/projects/44/?format=json","name":"skiboot firmware development","link_name":"skiboot","list_id":"skiboot.lists.ozlabs.org","list_email":"skiboot@lists.ozlabs.org","web_url":"http://github.com/open-power/skiboot","scm_url":"http://github.com/open-power/skiboot","webscm_url":"","list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<1505478062-1623-9-git-send-email-akshay.adiga@linux.vnet.ibm.com>","list_archive_url":null,"date":"2017-09-15T12:21:02","name":"[v5,8/8] Add Documenation for opal_slw_set_reg","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"a2574f2db7d458957b250b38997b171c4028dd88","submitter":{"id":68766,"url":"http://patchwork.ozlabs.org/api/people/68766/?format=json","name":"Akshay Adiga","email":"akshay.adiga@linux.vnet.ibm.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/skiboot/patch/1505478062-1623-9-git-send-email-akshay.adiga@linux.vnet.ibm.com/mbox/","series":[{"id":3295,"url":"http://patchwork.ozlabs.org/api/series/3295/?format=json","web_url":"http://patchwork.ozlabs.org/project/skiboot/list/?series=3295","date":"2017-09-15T12:20:54","name":"Enable stop4 idle state","version":5,"mbox":"http://patchwork.ozlabs.org/series/3295/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/814254/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/814254/checks/","tags":{},"related":[],"headers":{"Return-Path":"<skiboot-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org>","X-Original-To":["incoming@patchwork.ozlabs.org","skiboot@lists.ozlabs.org"],"Delivered-To":["patchwork-incoming@bilbo.ozlabs.org","skiboot@lists.ozlabs.org"],"Received":["from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3])\n\t(using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits))\n\t(No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 3xtvhQ3thkz9s3w\n\tfor <incoming@patchwork.ozlabs.org>;\n\tFri, 15 Sep 2017 22:23:50 +1000 (AEST)","from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3])\n\tby lists.ozlabs.org (Postfix) with ESMTP id 3xtvhQ2L9RzDrbL\n\tfor <incoming@patchwork.ozlabs.org>;\n\tFri, 15 Sep 2017 22:23:50 +1000 (AEST)","from mx0a-001b2d01.pphosted.com (mx0b-001b2d01.pphosted.com\n\t[148.163.158.5])\n\t(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256\n\tbits)) (No client certificate requested)\n\tby lists.ozlabs.org (Postfix) with ESMTPS id 3xtvgS2SHJzDrYl\n\tfor <skiboot@lists.ozlabs.org>; Fri, 15 Sep 2017 22:23:00 +1000 (AEST)","from pps.filterd (m0098421.ppops.net [127.0.0.1])\n\tby mx0a-001b2d01.pphosted.com (8.16.0.21/8.16.0.21) with SMTP id\n\tv8FCIvEI037323\n\tfor <skiboot@lists.ozlabs.org>; Fri, 15 Sep 2017 08:22:58 -0400","from e23smtp06.au.ibm.com (e23smtp06.au.ibm.com [202.81.31.148])\n\tby mx0a-001b2d01.pphosted.com with ESMTP id 2d0d6m4jvr-1\n\t(version=TLSv1.2 cipher=AES256-SHA bits=256 verify=NOT)\n\tfor <skiboot@lists.ozlabs.org>; Fri, 15 Sep 2017 08:22:56 -0400","from localhost\n\tby e23smtp06.au.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use\n\tOnly! Violators will be prosecuted\n\tfor <skiboot@lists.ozlabs.org> from <akshay.adiga@linux.vnet.ibm.com>;\n\tFri, 15 Sep 2017 22:22:53 +1000","from d23relay10.au.ibm.com (202.81.31.229)\n\tby e23smtp06.au.ibm.com (202.81.31.212) with IBM ESMTP SMTP Gateway:\n\tAuthorized Use Only! Violators will be prosecuted; \n\tFri, 15 Sep 2017 22:22:51 +1000","from d23av06.au.ibm.com (d23av06.au.ibm.com [9.190.235.151])\n\tby d23relay10.au.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id\n\tv8FCLarZ39256156\n\tfor <skiboot@lists.ozlabs.org>; Fri, 15 Sep 2017 22:21:36 +1000","from d23av06.au.ibm.com (localhost [127.0.0.1])\n\tby d23av06.au.ibm.com (8.14.4/8.14.4/NCO v10.0 AVout) with ESMTP id\n\tv8FCLZVG024918\n\tfor <skiboot@lists.ozlabs.org>; Fri, 15 Sep 2017 22:21:35 +1000","from aksadiga.in.ibm.com (aksadiga.in.ibm.com [9.124.35.28])\n\tby d23av06.au.ibm.com (8.14.4/8.14.4/NCO v10.0 AVin) with ESMTP id\n\tv8FCL61Q024170; Fri, 15 Sep 2017 22:21:33 +1000"],"Authentication-Results":"ozlabs.org;\n\tspf=none (mailfrom) smtp.mailfrom=linux.vnet.ibm.com\n\t(client-ip=148.163.158.5; helo=mx0a-001b2d01.pphosted.com;\n\tenvelope-from=akshay.adiga@linux.vnet.ibm.com; receiver=<UNKNOWN>)","From":"Akshay Adiga <akshay.adiga@linux.vnet.ibm.com>","To":"skiboot@lists.ozlabs.org","Date":"Fri, 15 Sep 2017 17:51:02 +0530","X-Mailer":"git-send-email 2.5.5","In-Reply-To":"<1505478062-1623-1-git-send-email-akshay.adiga@linux.vnet.ibm.com>","References":"<1505478062-1623-1-git-send-email-akshay.adiga@linux.vnet.ibm.com>","X-TM-AS-MML":"disable","x-cbid":"17091512-0040-0000-0000-00000356427D","X-IBM-AV-DETECTION":"SAVI=unused REMOTE=unused XFE=unused","x-cbparentid":"17091512-0041-0000-0000-00000CD6AA57","Message-Id":"<1505478062-1623-9-git-send-email-akshay.adiga@linux.vnet.ibm.com>","X-Proofpoint-Virus-Version":"vendor=fsecure engine=2.50.10432:, ,\n\tdefinitions=2017-09-15_05:, , signatures=0","X-Proofpoint-Spam-Details":"rule=outbound_notspam policy=outbound score=0\n\tspamscore=0 suspectscore=1\n\tmalwarescore=0 phishscore=0 adultscore=0 bulkscore=0 classifier=spam\n\tadjust=0 reason=mlx scancount=1 engine=8.0.1-1707230000\n\tdefinitions=main-1709150179","Subject":"[Skiboot] [PATCH v5 8/8] Add Documenation for opal_slw_set_reg","X-BeenThere":"skiboot@lists.ozlabs.org","X-Mailman-Version":"2.1.24","Precedence":"list","List-Id":"Mailing list for skiboot development <skiboot.lists.ozlabs.org>","List-Unsubscribe":"<https://lists.ozlabs.org/options/skiboot>,\n\t<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>,\n\t<mailto:skiboot-request@lists.ozlabs.org?subject=subscribe>","Cc":"ego@linux.vnet.ibm.com, shriyak@linux.vnet.ibm.com","MIME-Version":"1.0","Content-Type":"text/plain; charset=\"utf-8\"","Content-Transfer-Encoding":"base64","Errors-To":"skiboot-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org","Sender":"\"Skiboot\"\n\t<skiboot-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org>"},"content":"Signed-off-by: Akshay Adiga <akshay.adiga@linux.vnet.ibm.com>\nReviewed-by: Vaidyanathan Srinivasan <svaidy@linux.vnet.ibm.com>\n---\n doc/opal-api/opal-slw-set-reg-100.rst | 46 +++++++++++++++++++++++++++++++++++\n 1 file changed, 46 insertions(+)\n create mode 100644 doc/opal-api/opal-slw-set-reg-100.rst","diff":"diff --git a/doc/opal-api/opal-slw-set-reg-100.rst b/doc/opal-api/opal-slw-set-reg-100.rst\nnew file mode 100644\nindex 0000000..64ecdee\n--- /dev/null\n+++ b/doc/opal-api/opal-slw-set-reg-100.rst\n@@ -0,0 +1,46 @@\n+OPAL_SLW_SET_REG\n+==============================\n+::\n+\n+    int64_t opal_slw_set_reg(uint64_t cpu_pir, uint64_t sprn, uint64_t val)\n+\n+\n+OPAL_SLW_SET_REG is used to inform low-level firmware to restore a\n+given value of SPR when there is a state loss.  The actual set of SPR\n+that is supported is platform dependent.\n+\n+\n+In Power 8, it uses p8_pore_gen_cpufreq_fixed(), api provided by pore engine,\n+to inform the spr with their corresponding values with which they\n+must be restored.\n+\n+\n+In Power 9, it uses p9_stop_save_cpureg(), api provided by self restore code,\n+to inform the spr with their corresponding values with which they\n+must be restored.\n+\n+\n+Parameters\n+----------\n+\n+``uint64_t cpu_pir``\n+This parameter specifies the pir of the cpu for which the call is being made.\n+\n+``uint64_t sprn``\n+This parameter specifies the spr number as mentioned in p9_stop_api.H for\n+Power9 and p8_pore_table_gen_api.H for Power8.\n+\n+``uint64_t val``\n+This parameter specifices value with which the spr should be restored.\n+\n+Returns\n+-------\n+\n+``OPAL_INTERNAL_ERROR``\n+On failure. The actual error code from the platform specific code is logged in the OPAL logs\n+\n+``OPAL_UNSUPPORTED``\n+In power8 only, if spr restore is not supported by pore engine.\n+\n+``OPAL_SUCCESS``\n+On success\n","prefixes":["v5","8/8"]}