| Message ID | 20190531061351.22973-24-stewart@linux.ibm.com |
|---|---|
| State | Accepted |
| Headers | show
Return-Path: <skiboot-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org> X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [203.11.71.2]) (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 45FZCk4BFlz9s00 for <incoming@patchwork.ozlabs.org>; Fri, 31 May 2019 16:24:02 +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 45FZCk3BTjzDqWm for <incoming@patchwork.ozlabs.org>; Fri, 31 May 2019 16:24:02 +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.156.1; helo=mx0a-001b2d01.pphosted.com; envelope-from=stewart@linux.ibm.com; receiver=<UNKNOWN>) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=linux.ibm.com 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 45FZ0K6ZrJzDqYh for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 16:14:09 +1000 (AEST) Received: from pps.filterd (m0098394.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.27/8.16.0.27) with SMTP id x4V66ULL092904 for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 02:14:07 -0400 Received: from e13.ny.us.ibm.com (e13.ny.us.ibm.com [129.33.205.203]) by mx0a-001b2d01.pphosted.com with ESMTP id 2stv42d06p-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 02:14:06 -0400 Received: from localhost by e13.ny.us.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for <skiboot@lists.ozlabs.org> from <stewart@linux.ibm.com>; Fri, 31 May 2019 07:14:05 +0100 Received: from b01cxnp22035.gho.pok.ibm.com (9.57.198.25) by e13.ny.us.ibm.com (146.89.104.200) 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:03 +0100 Received: from b01ledav002.gho.pok.ibm.com (b01ledav002.gho.pok.ibm.com [9.57.199.107]) by b01cxnp22035.gho.pok.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id x4V6E2bT30670952 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:02 GMT Received: from b01ledav002.gho.pok.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 3CF59124054 for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:02 +0000 (GMT) Received: from b01ledav002.gho.pok.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id EEBC3124055 for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:01 +0000 (GMT) Received: from birb.localdomain (unknown [9.185.142.91]) by b01ledav002.gho.pok.ibm.com (Postfix) with ESMTP for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:01 +0000 (GMT) Received: by birb.localdomain (Postfix, from userid 1000) id C221D503F64; Fri, 31 May 2019 16:13:56 +1000 (AEST) From: Stewart Smith <stewart@linux.ibm.com> To: skiboot@lists.ozlabs.org Date: Fri, 31 May 2019 16:12: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-0064-0000-0000-000003E76F3A 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.00636340; IPR=6.00992124; MB=3.00027126; MTD=3.00000008; XFM=3.00000015; UTC=2019-05-31 06:14:03 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 19053106-0065-0000-0000-00003DAD78DF Message-Id: <20190531061351.22973-24-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=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1905310040 Subject: [Skiboot] [PATCH 023/110] doc: prettify OPAL_PRD_MSG X-BeenThere: skiboot@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Mailing list for skiboot development <skiboot.lists.ozlabs.org> List-Unsubscribe: <https://lists.ozlabs.org/options/skiboot>, <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>, <mailto:skiboot-request@lists.ozlabs.org?subject=subscribe> Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: skiboot-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "Skiboot" <skiboot-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org> |
| Series |
Big documentation cleanup/expansion
|
expand
|
diff --git a/doc/opal-api/opal-messages.rst b/doc/opal-api/opal-messages.rst index b023622d2d26..e7de77d96850 100644 --- a/doc/opal-api/opal-messages.rst +++ b/doc/opal-api/opal-messages.rst @@ -134,6 +134,8 @@ requested and a forced shutdown will happen in future. Host OS can use OPAL_GET_DPO_STATUS API to query OPAL the number of seconds remaining before a forced poweroff will occur. +.. _OPAL_MSG_PRD: + OPAL_MSG_PRD ------------ @@ -177,7 +179,7 @@ struct opal_prd_msg: :: }; Responses from the kernel use the same message format, but are passed -through the opal_prd_msg call. +through the :ref:`OPAL_PRD_MSG` call. OPAL_MSG_OCC ------------ diff --git a/doc/opal-api/opal-prd-msg-113.rst b/doc/opal-api/opal-prd-msg-113.rst index 0cda30aa5285..91d30aca7552 100644 --- a/doc/opal-api/opal-prd-msg-113.rst +++ b/doc/opal-api/opal-prd-msg-113.rst @@ -1,8 +1,16 @@ +.. _OPAL_PRD_MSG: + OPAL_PRD_MSG ============ +.. code-block:: c + + #define OPAL_PRD_MSG 113 + + int64_t opal_prd_msg(struct opal_prd_msg *msg); + The OPAL_PRD_MSG call is used to pass a struct opal_prd_msg from the HBRT -code into opal, and is paired with the OPAL_PRD_MSG message type. +code into opal, and is paired with the :ref:`OPAL_PRD_MSG` message type. Parameters ----------
Signed-off-by: Stewart Smith <stewart@linux.ibm.com> --- doc/opal-api/opal-messages.rst | 4 +++- doc/opal-api/opal-prd-msg-113.rst | 10 +++++++++- 2 files changed, 12 insertions(+), 2 deletions(-)