Message ID | 20190531061351.22973-31-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 45FZ9N3JPvz9s00 for <incoming@patchwork.ozlabs.org>; Fri, 31 May 2019 16:22:00 +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 45FZ9N1vMmzDqYV for <incoming@patchwork.ozlabs.org>; Fri, 31 May 2019 16:22:00 +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.158.5; 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 (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 45FZ0K2h8BzDqY1 for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 16:14:08 +1000 (AEST) Received: from pps.filterd (m0098413.ppops.net [127.0.0.1]) by mx0b-001b2d01.pphosted.com (8.16.0.27/8.16.0.27) with SMTP id x4V68XUG037753 for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 02:14:06 -0400 Received: from e36.co.us.ibm.com (e36.co.us.ibm.com [32.97.110.154]) by mx0b-001b2d01.pphosted.com with ESMTP id 2stxr105ns-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 e36.co.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 b03cxnp08025.gho.boulder.ibm.com (9.17.130.17) by e36.co.us.ibm.com (192.168.1.136) 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 b03ledav004.gho.boulder.ibm.com (b03ledav004.gho.boulder.ibm.com [9.17.130.235]) by b03cxnp08025.gho.boulder.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id x4V6E2Ja19530054 (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 b03ledav004.gho.boulder.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id B6F627805C for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:02 +0000 (GMT) Received: from b03ledav004.gho.boulder.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 7DC1678060 for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:02 +0000 (GMT) Received: from birb.localdomain (unknown [9.185.142.91]) by b03ledav004.gho.boulder.ibm.com (Postfix) with ESMTP for <skiboot@lists.ozlabs.org>; Fri, 31 May 2019 06:14:02 +0000 (GMT) Received: by birb.localdomain (Postfix, from userid 1000) id E3CF7503F6B; 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:31 +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-0020-0000-0000-00000EF2737A 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:04 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 19053106-0021-0000-0000-000066081ED2 Message-Id: <20190531061351.22973-31-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 suspectscore=1 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 lowpriorityscore=0 mlxlogscore=944 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1905310040 Subject: [Skiboot] [PATCH 030/110] doc: combine OPAL_RTC_READ and OPAL_RTC_WRITE pages 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-rtc-read-3.rst b/doc/opal-api/opal-rtc-read-write-3-4.rst similarity index 83% rename from doc/opal-api/opal-rtc-read-3.rst rename to doc/opal-api/opal-rtc-read-write-3-4.rst index e2d492f2e0bf..e324e1a3c667 100644 --- a/doc/opal-api/opal-rtc-read-3.rst +++ b/doc/opal-api/opal-rtc-read-write-3-4.rst @@ -1,3 +1,7 @@ +=============================== +OPAL Real Time Clock (RTC) APIs +=============================== + .. _OPAL_RTC_READ: OPAL_RTC_READ @@ -73,3 +77,15 @@ Return codes :ref:`OPAL_BUSY` request may be in flight + +.. _OPAL_RTC_WRITE: + +OPAL_RTC_WRITE +============== + +:ref:`OPAL_RTC_WRITE` is much like :ref:`OPAL_RTC_READ` in that it can be asynchronous. + +If multiple WRITES are issued before the first one completes, subsequent +writes are ignored. There can only be one write in flight at any one time. + +Format of the time is the same as for :ref:`OPAL_RTC_READ`. diff --git a/doc/opal-api/opal-rtc-write-4.rst b/doc/opal-api/opal-rtc-write-4.rst deleted file mode 100644 index c5ef7503bef7..000000000000 --- a/doc/opal-api/opal-rtc-write-4.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _OPAL_RTC_WRITE: - -OPAL_RTC_WRITE -============== - -:ref:`OPAL_RTC_WRITE` is much like :ref:`OPAL_RTC_READ` in that it can be asynchronous. - -If multiple WRITES are issued before the first one completes, subsequent -writes are ignored. There can only be one write in flight at any one time. - -Format of the time is the same as for :ref:`OPAL_RTC_READ`.
One page for Real Time Clock is a bit clearer. Signed-off-by: Stewart Smith <stewart@linux.ibm.com> --- ...tc-read-3.rst => opal-rtc-read-write-3-4.rst} | 16 ++++++++++++++++ doc/opal-api/opal-rtc-write-4.rst | 11 ----------- 2 files changed, 16 insertions(+), 11 deletions(-) rename doc/opal-api/{opal-rtc-read-3.rst => opal-rtc-read-write-3-4.rst} (83%) delete mode 100644 doc/opal-api/opal-rtc-write-4.rst