systemsoftware
/
Linux-Architecture-Reference
35
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

File cleanup. Table cleanup. Minor edits.

Browse Source 
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
pull/2/head
Jeff Scheel 5 years ago
parent c250b41348
commit 51a1657033
66 changed files with 1898 additions and 1666 deletions
Show Stats Download Patch File Download Diff File

2
LoPAR/app_bibliography.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

7
LoPAR/app_capi_error_handling.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -16,7 +16,10 @@

-->
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="app_coherent_platform_facility_error_handling_recovery">
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en"
xml:id="app_coherent_platform_facility_error_handling_recovery">
<title>Coherent Platform Facility Error Handling and Recovery</title>

<para>During the course of operation, a coherent platform function can encounter errors.

20
LoPAR/app_cmo_def.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -39,14 +39,14 @@
<table frame="all" pgwide="1" xml:id="dbdoclet.50569382_93865">
<title>CMO Terms</title>
<tgroup cols="2">
<colspec colname="c1" colwidth="50*" />
<colspec colname="c2" colwidth="50*" />
<tbody>
<colspec colname="c1" colwidth="30*" align="center" />
<colspec colname="c2" colwidth="70*" />
<tbody valign="middle" >
<row>
<entry>
<para>Term</para>
</entry>
<entry>
<entry align="center">
<para>Definition</para>
</entry>
</row>
@ -107,11 +107,11 @@
<table frame="all" pgwide="1" xml:id="dbdoclet.50569382_70763">
<title>CMO Characteristics</title>
<tgroup cols="4">
<colspec colname="c1" colwidth="25*" />
<colspec colname="c2" colwidth="25*" />
<colspec colname="c3" colwidth="25*" />
<colspec colname="c1" colwidth="25*" align="center" />
<colspec colname="c2" colwidth="25*" align="center" />
<colspec colname="c3" colwidth="25*" align="center" />
<colspec colname="c4" colwidth="25*" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Characteristics</para>
@ -122,7 +122,7 @@
<entry>
<para>Values</para>
</entry>
<entry>
<entry align="center">
<para>Notes</para>
</entry>
</row>

221
LoPAR/app_eeh_handling.xml
Unescape Escape View File

@ -1,116 +1,133 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569381_46906"
version="5.0"
xml:lang="en">
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569381_46906"
version="5.0"
xml:lang="en">

<title>EEH Error Processing</title>

<para>This appendix describes the architectural intent for EEH error processing.
This appendix does not attempt to illustrate all possible scenarios, and other
<para>This appendix describes the architectural intent for EEH error processing.
This appendix does not attempt to illustrate all possible scenarios, and other
implementations are possible.</para>

<section xml:id="dbdoclet.50569381_11923">
<title>General Scenarios</title>
<para>In general, the device driver recovery consists of issuing an
<emphasis>ibm,read-slot-reset-state2</emphasis> call prior to doing any recovery
to determine if (1) the IOA is in the MMIO Stopped and DMA Stopped state (that is,
that an error has occurred which has put it into this state), and (2) whether or
not the PE has been reset by the platform in the process of entering the MMIO
<para>In general, the device driver recovery consists of issuing an
<emphasis>ibm,read-slot-reset-state2</emphasis> call prior to doing any recovery
to determine if (1) the IOA is in the MMIO Stopped and DMA Stopped state (that is,
that an error has occurred which has put it into this state), and (2) whether or
not the PE has been reset by the platform in the process of entering the MMIO
Stopped and DMA Stopped state, and then doing one of the following:</para>

<orderedlist>
<orderedlist>
<listitem>
<para>Simplest approach: </para>
<itemizedlist>
<itemizedlist>
<listitem>
<para>Reset the PE</para>
</listitem>

<listitem>
<para>Reconfigure the PE</para>
</listitem>
</itemizedlist>
</itemizedlist>
</listitem>

<listitem xml:id="dbdoclet.50569381_39262">
<para>Most general approach (detailed more in <xref linkend="dbdoclet.50569381_38095"/>): </para>
<itemizedlist>
<itemizedlist>
<listitem>
<para>Release the PE for <emphasis>Load</emphasis> /<emphasis>Store</emphasis></para>
</listitem>

<listitem>
<para>Issue <emphasis>Load</emphasis> /<emphasis> Store</emphasis> instructions t
o get any desired state information from the IOA</para>
</listitem>

<listitem>
<para>Call the <emphasis>ibm,slot-error-detail</emphasis> RTAS call to get the
<para>Call the <emphasis>ibm,slot-error-detail</emphasis> RTAS call to get the
platform error information</para>
</listitem>

<listitem>
<para>Log the error information</para>
</listitem>

<listitem>
<para>Reset the PE</para>
</listitem>

<listitem>
<para>Reconfigure the PE</para>
</listitem>
</itemizedlist>
</itemizedlist>
</listitem>

<listitem>
<para>Most robust (no reset unless necessary): </para>
<itemizedlist>
<itemizedlist>
<listitem>
<para>Release the PE for <emphasis>Load</emphasis> /<emphasis>Store</emphasis></para>
</listitem>

<listitem>
<para>Issue <emphasis> Load</emphasis> /<emphasis> Store</emphasis> instructions
<para>Issue <emphasis> Load</emphasis> /<emphasis> Store</emphasis> instructions
to get any desired state information from the IOA</para>
</listitem>

<listitem>
<para>Call the <emphasis> ibm,slot-error-detail</emphasis> RTAS call to get the
<para>Call the <emphasis> ibm,slot-error-detail</emphasis> RTAS call to get the
platform error information</para>
</listitem>

<listitem>
<para>Log the error information</para>
</listitem>

<listitem>
<para>Device driver does IOA cleanup</para>
</listitem>

<listitem>
<para>Release the PE for DMA and restart operations (no reset) </para>
</listitem>
</itemizedlist>
</itemizedlist>
</listitem>
</orderedlist>
</orderedlist>

<para>In any scenario, after several retries of a recoverable operation, the OS
may determine that further recovery efforts should cease. In such a case,
calling <emphasis>ibm,slot-error-detail</emphasis> with <emphasis>Function</emphasis> 2
(Permanent Error), in addition to returning error information, marks that the PE is
<para>In any scenario, after several retries of a recoverable operation, the OS
may determine that further recovery efforts should cease. In such a case,
calling <emphasis>ibm,slot-error-detail</emphasis> with <emphasis>Function</emphasis> 2
(Permanent Error), in addition to returning error information, marks that the PE is
no longer accessible due to previous errors.</para>
</section>

<section xml:id="dbdoclet.50569381_38095">
<title>More Detail on the Most General Approach</title>
<para>The following gives a more detailed look at scenario #<xref linkend="dbdoclet.50569381_39262"/>
in <xref linkend="dbdoclet.50569381_11923"/>. This will be broken up into two groups of operations:
<para>The following gives a more detailed look at scenario #<xref linkend="dbdoclet.50569381_39262"/>
in <xref linkend="dbdoclet.50569381_11923"/>. This will be broken up into two groups of operations:
error logging and error recovery.</para>
<para>These scenarios assume that:</para>

<orderedlist>
<orderedlist>
<listitem>
<para>The <emphasis> ibm,configure-pe</emphasis> RTAS call is implemented.</para>
</listitem>
@ -118,18 +135,18 @@ xml:lang="en">
<listitem>
<para>The attempts at recovery stop when Max_Retries_Exceeded is true.</para>
</listitem>
</orderedlist>
</orderedlist>

<section>
<title>Error Logging</title>

<orderedlist>
<orderedlist>
<listitem>
<para>If the device driver is going to capture internal IOA-specific information
as a part of the error logging process or if the IOA controlled by the device driver
requires a longer wait after reset than the normal PCI specified minimum wait time,
then the device driver determines whether its IOA has been reset as a result of entering
EEH Stopped State, by looking at the <emphasis>PE Recovery Info</emphasis> output of
<para>If the device driver is going to capture internal IOA-specific information
as a part of the error logging process or if the IOA controlled by the device driver
requires a longer wait after reset than the normal PCI specified minimum wait time,
then the device driver determines whether its IOA has been reset as a result of entering
EEH Stopped State, by looking at the <emphasis>PE Recovery Info</emphasis> output of
the <emphasis>ibm,read-slot-reset-state2</emphasis> RTAS call.</para>
</listitem>

@ -138,106 +155,106 @@ xml:lang="en">
</listitem>

<listitem>
<para>If the IOA requires longer wait after reset times than the specified minimum,
and the PE was reset (see step #1) as a result of the EEH event, then wait the
<para>If the IOA requires longer wait after reset times than the specified minimum,
and the PE was reset (see step #1) as a result of the EEH event, then wait the
additional necessary time before continuing.</para>
</listitem>

<listitem xml:id="dbdoclet.50569381_59303">
<para>The OS or device driver
enables PE MMIOs by calling the <emphasis>ibm,set-eeh-option</emphasis> RTAS call
<para>The OS or device driver
enables PE MMIOs by calling the <emphasis>ibm,set-eeh-option</emphasis> RTAS call
with <emphasis>Function</emphasis> 2. </para>
</listitem>

<listitem>
<para>The OS or device driver calls the <emphasis>ibm,configure-pe</emphasis> RTAS call. </para>
<orderedlist numeration="loweralpha">
<orderedlist numeration="loweralpha">
<listitem>
<para>If the PCI fabric does not need configuring (the PE was not reset previous to the
call or was reset but was previously configured with <emphasis>ibm,configure-pe</emphasis> ),
then the call returns without doing anything, otherwise it attempts to configure
<para>If the PCI fabric does not need configuring (the PE was not reset previous to the
call or was reset but was previously configured with <emphasis>ibm,configure-pe</emphasis> ),
then the call returns without doing anything, otherwise it attempts to configure
the fabric up to but not including the endpoint IOA configuration registers.</para>
</listitem>

<listitem>
<para>If an EEH event occurs as a result of probing during the
<emphasis>ibm,configure-pe</emphasis> RTAS call that results in a
reset of the PE, the PE will be returned in the PE state of 2. Software
does not necessarily need to check this on return from the call. The case
where this occurs is expected to be rare, and probably signals a non-transient error.
In this case the software can continue on with the recovery phase of the EEH processing,
<para>If an EEH event occurs as a result of probing during the
<emphasis>ibm,configure-pe</emphasis> RTAS call that results in a
reset of the PE, the PE will be returned in the PE state of 2. Software
does not necessarily need to check this on return from the call. The case
where this occurs is expected to be rare, and probably signals a non-transient error.
In this case the software can continue on with the recovery phase of the EEH processing,
and will eventually hit the same EEH event on further processing.</para>
</listitem>
</orderedlist>
</orderedlist>
</listitem>

<listitem xml:id="dbdoclet.50569381_74560">
<para>If the PE was
reset (see step #1) as a result of the EEH event, then if the device driver is
going to gather IOA-specific information for logging, it needs to finish the
configuration of the IOA PCI configuration registers, by restoring the PCI
configuration space registers of the IOA(s) in the PE (for example, BARs,
<para>If the PE was
reset (see step #1) as a result of the EEH event, then if the device driver is
going to gather IOA-specific information for logging, it needs to finish the
configuration of the IOA PCI configuration registers, by restoring the PCI
configuration space registers of the IOA(s) in the PE (for example, BARs,
Memory Space Enable, etc.). </para>
</listitem>

<listitem xml:id="dbdoclet.50569381_29191">
<para>If desired, the
<para>If desired, the
device driver gathers IOA-specific information via MMIOs, by doing MMIOs to its IOA.</para>
</listitem>

<listitem>
<para>The OS or device driver calls <emphasis>ibm,slot-error-detail</emphasis> .
Any data captured in step #<xref linkend="dbdoclet.50569381_29191"/> is passed in the
call. Note that maximum amount of data will be captured in some cases only when the
<emphasis>ibm,slot-error-detail</emphasis> call is made with PE not in the MMIO Stopped
<para>The OS or device driver calls <emphasis>ibm,slot-error-detail</emphasis> .
Any data captured in step #<xref linkend="dbdoclet.50569381_29191"/> is passed in the
call. Note that maximum amount of data will be captured in some cases only when the
<emphasis>ibm,slot-error-detail</emphasis> call is made with PE not in the MMIO Stopped
State (as it should be in step #<xref linkend="dbdoclet.50569381_59303"/>). </para>
<orderedlist numeration="loweralpha">
<orderedlist numeration="loweralpha">
<listitem>
<para>If Max_Retries_Exceeded is true, then call <emphasis>ibm,slot-error-detail</emphasis>
<para>If Max_Retries_Exceeded is true, then call <emphasis>ibm,slot-error-detail</emphasis>
with <emphasis> Function</emphasis> 2 (Permanent Error).</para>
</listitem>

<listitem>
<para>If Max_Retries_Exceeded is not true, then call <emphasis>ibm,slot-error-detail</emphasis>
<para>If Max_Retries_Exceeded is not true, then call <emphasis>ibm,slot-error-detail</emphasis>
with <emphasis>Function</emphasis> 1(Temporary Error).</para>
</listitem>
</orderedlist>
</orderedlist>
</listitem>

<listitem>
<para>The <emphasis>ibm,slot-error-detail</emphasis> RTAS call captures whatever
PCI config space registers it can between the configuration address passed in the call
and the system (PHB), and including at the configuration address and at the PHB, and
returns them along with the device specific data in an error log in the return information
from the call. This call may encounter another EEH event, in which case it returns what
<para>The <emphasis>ibm,slot-error-detail</emphasis> RTAS call captures whatever
PCI config space registers it can between the configuration address passed in the call
and the system (PHB), and including at the configuration address and at the PHB, and
returns them along with the device specific data in an error log in the return information
from the call. This call may encounter another EEH event, in which case it returns what
information it can in the call, with a <emphasis>Status</emphasis> of 0 (Success).</para>
</listitem>

<listitem>
<para>The OS or device driver logs the log entry returned from the
<para>The OS or device driver logs the log entry returned from the
<emphasis>ibm,slot-error-detail</emphasis> RTAS call.</para>
</listitem>

<listitem>
<para>If Max_Retries_Exceeded is not true, then the next step is PE Recovery,
<para>If Max_Retries_Exceeded is not true, then the next step is PE Recovery,
otherwise stop and mark the IOA(s) in the PE as unusable.</para>
</listitem>
</orderedlist>
</orderedlist>
</section>

<section>
<title>PE Recovery</title>

<orderedlist>
<orderedlist>
<listitem>
<para>OS or device driver does a PE reset sequence. Note that this step is
required even if the PE was reset as a result of the initial EEH event, because
the error logging steps (for example, the <emphasis>ibm,configure-pe</emphasis>
or <emphasis> ibm,slot-error-detail</emphasis> calls) could have encountered
<para>OS or device driver does a PE reset sequence. Note that this step is
required even if the PE was reset as a result of the initial EEH event, because
the error logging steps (for example, the <emphasis>ibm,configure-pe</emphasis>
or <emphasis> ibm,slot-error-detail</emphasis> calls) could have encountered
another EEH event. </para>
<orderedlist numeration="loweralpha">
<orderedlist numeration="loweralpha">
<listitem>
<para>The device driver or OS calls <emphasis>ibm,set-slot-reset</emphasis> with
<para>The device driver or OS calls <emphasis>ibm,set-slot-reset</emphasis> with
<emphasis>Function</emphasis> 1 or 3 to activate the reset.</para>
</listitem>

@ -246,26 +263,26 @@ xml:lang="en">
</listitem>

<listitem>
<para>The device driver or OS calls <emphasis>ibm,set-slot-reset</emphasis> with
<para>The device driver or OS calls <emphasis>ibm,set-slot-reset</emphasis> with
<emphasis>Function</emphasis> 0 to deactivate the reset.</para>
</listitem>

<listitem>
<para>The minimum reset inactive to first configuration cycles is waited.
If the IOA requires more than the standard PCI specified time, then wait that
<para>The minimum reset inactive to first configuration cycles is waited.
If the IOA requires more than the standard PCI specified time, then wait that
longer time, instead.</para>
</listitem>
</orderedlist>
</orderedlist>
</listitem>

<listitem>
<para>The OS or device driver calls <emphasis>ibm,configure-pe.</emphasis>
<note><para>If an EEH event occurs as a result of probing
during the <emphasis>ibm,configure-pe</emphasis> RTAS call that results in a reset
of the PE, the PE will be returned in the PE state of 2. Software does not necessarily
need to check this on return from the call. The case where this occurs is expected to
be rare, and probably signals a non-transient error. In this case the software can
continue on with the recovery phase of the EEH processing, and will eventually hit
<note><para>If an EEH event occurs as a result of probing
during the <emphasis>ibm,configure-pe</emphasis> RTAS call that results in a reset
of the PE, the PE will be returned in the PE state of 2. Software does not necessarily
need to check this on return from the call. The case where this occurs is expected to
be rare, and probably signals a non-transient error. In this case the software can
continue on with the recovery phase of the EEH processing, and will eventually hit
the same EEH event on further processing.</para></note>
</para>
</listitem>
@ -277,7 +294,7 @@ xml:lang="en">
<listitem>
<para>The device driver initializes the IOA for operations.</para>
</listitem>
</orderedlist>
</orderedlist>

</section>
</section>

9
LoPAR/app_fault_v_errorlog.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -16,7 +16,10 @@

-->
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdoclet.50569385_36278">
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en"
xml:id="dbdoclet.50569385_36278">
<title>
When to use: Fault vs. Error Log Indicators (Lightpath Mode)</title>
<para>This appendix gives
@ -113,7 +116,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdo
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>All</para>

90
LoPAR/app_firmware_dump.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -72,11 +72,11 @@
<table frame="all" pgwide="1">
<title>Register Save Area Format</title>
<tgroup cols="5">
<colspec colname="c1" colwidth="20*" />
<colspec colname="c2" colwidth="20*" />
<colspec colname="c3" colwidth="20*" />
<colspec colname="c4" colwidth="20*" />
<colspec colname="c5" colwidth="20*" />
<colspec colname="c1" colwidth="15*" align="center" />
<colspec colname="c2" colwidth="15*" align="center" />
<colspec colname="c3" colwidth="23*" align="center" />
<colspec colname="c4" colwidth="23*" />
<colspec colname="c5" colwidth="23*" />
<thead>
<row>
<entry>
@ -94,19 +94,19 @@
<emphasis role="bold">Name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Value</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Description</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle">
<row>
<entry>
<para>0x00</para>
@ -301,11 +301,11 @@
<table frame="all" pgwide="1">
<title>RegEntry Format</title>
<tgroup cols="5">
<colspec colname="c1" colwidth="20*" />
<colspec colname="c2" colwidth="20*" />
<colspec colname="c3" colwidth="20*" />
<colspec colname="c4" colwidth="20*" />
<colspec colname="c5" colwidth="20*" />
<colspec colname="c1" colwidth="15*" align="center" />
<colspec colname="c2" colwidth="15*" align="center" />
<colspec colname="c3" colwidth="23*" align="center" />
<colspec colname="c4" colwidth="23*" align="center" />
<colspec colname="c5" colwidth="23*" />
<thead>
<row>
<entry>
@ -328,14 +328,14 @@
<emphasis role="bold">Value</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Description</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x0</para>
@ -377,10 +377,10 @@
<table frame="all" pgwide="1">
<title>CPUSTRT and CPUEND have the following format</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="33*" />
<colspec colname="c2" colwidth="33*" />
<colspec colname="c3" colwidth="33*" />
<tbody>
<colspec colname="c1" colwidth="50*" align="center" />
<colspec colname="c2" colwidth="25*" align="center" />
<colspec colname="c3" colwidth="25*" align="center" />
<tbody valign="middle" >
<row>
<entry>
<para>8 Byte Identifier</para>
@ -399,9 +399,9 @@
<table frame="all" pgwide="1">
<title>8-Byte RegEntries</title>
<tgroup cols="2">
<colspec colname="c1" colwidth="50*" />
<colspec colname="c2" colwidth="50*" />
<tbody>
<colspec colname="c1" colwidth="50*" align="center" />
<colspec colname="c2" colwidth="50*" align="center" />
<tbody valign="middle" >
<row>
<entry>
<para>8 Byte Identifier</para>
@ -417,10 +417,10 @@
<table frame="all" pgwide="1">
<title>4-Byte RegEntries</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="33*" />
<colspec colname="c2" colwidth="33*" />
<colspec colname="c3" colwidth="33*" />
<tbody>
<colspec colname="c1" colwidth="50*" align="center" />
<colspec colname="c2" colwidth="25*" align="center" />
<colspec colname="c3" colwidth="25*" align="center" />
<tbody valign="middle" >
<row>
<entry>
<para>8 Byte Identifier</para>
@ -440,8 +440,8 @@
<title>Identifiers Supported in Version 0x0 of the
Table</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="25*" />
<colspec colname="c2" colwidth="25*" />
<colspec colname="c1" colwidth="25*" align="center" />
<colspec colname="c2" colwidth="25*" align="center" />
<colspec colname="c3" colwidth="50*" />
<thead>
<row>
@ -455,14 +455,14 @@
<emphasis role="bold">Identifier (ASCII)</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Description</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x4350555354525400</para>
@ -6004,11 +6004,11 @@
<table frame="all" pgwide="1">
<title>HPT Entry Save Area Format</title>
<tgroup cols="5">
<colspec colname="c1" colwidth="20*" />
<colspec colname="c2" colwidth="20*" />
<colspec colname="c3" colwidth="20*" />
<colspec colname="c4" colwidth="20*" />
<colspec colname="c5" colwidth="20*" />
<colspec colname="c1" colwidth="15*" align="center" />
<colspec colname="c2" colwidth="15*" align="center" />
<colspec colname="c3" colwidth="23*" align="center" />
<colspec colname="c4" colwidth="23*" align="center" />
<colspec colname="c5" colwidth="23*" />
<thead>
<row>
<entry>
@ -6031,14 +6031,14 @@
<emphasis role="bold">Value</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Description</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x00</para>
@ -6184,11 +6184,11 @@
<table frame="all" pgwide="1">
<title>HPT Entry Format</title>
<tgroup cols="5">
<colspec colname="c1" colwidth="20*" />
<colspec colname="c2" colwidth="20*" />
<colspec colname="c3" colwidth="20*" />
<colspec colname="c4" colwidth="20*" />
<colspec colname="c5" colwidth="20*" />
<colspec colname="c1" colwidth="15*" align="center" />
<colspec colname="c2" colwidth="15*" align="center" />
<colspec colname="c3" colwidth="23*" align="center" />
<colspec colname="c4" colwidth="23*" align="center" />
<colspec colname="c5" colwidth="23*" />
<thead>
<row>
<entry>
@ -6211,14 +6211,14 @@
<emphasis role="bold">Value</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Description</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x0</para>

10
LoPAR/app_glossary.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -16,10 +16,10 @@

-->
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="dbdoclet.50569388_37308">
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="dbdoclet.50569388_37308">
<?dbhtml stop-chunking?>
<title>Glossary</title>
<para>This glossary contains an alphabetical list of terms, phrases, and abbreviations used in this document. </para>

22
LoPAR/app_pa_processor_binding.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -592,7 +592,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>phys.lo cell:</para>
@ -810,7 +810,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>2.04</para>
@ -1135,7 +1135,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0</para>
@ -1456,7 +1456,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="7">
<para>0</para>
@ -2181,7 +2181,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="3">
<para>0</para>
@ -2328,7 +2328,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="1">
<para>0</para>
@ -2440,7 +2440,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="1">
<para>0</para>
@ -2554,7 +2554,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0</para>
@ -3103,7 +3103,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>&#160;</para>
@ -3522,7 +3522,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>msr</para>

38
LoPAR/app_papr_binding.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -287,7 +287,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Installation Media:</para>
@ -991,7 +991,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1</para>
@ -1625,7 +1625,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>C5</para>
@ -1757,7 +1757,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Version</para>
@ -2018,7 +2018,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0</para>
@ -2155,7 +2155,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>ethernet_mac</para>
@ -2544,7 +2544,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="18">
<para>Base</para>
@ -4804,7 +4804,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="7">
<para>0</para>
@ -5860,7 +5860,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>storage-system-io</para>
@ -6062,7 +6062,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0</para>
@ -6335,7 +6335,7 @@
<colspec colname="c1" colwidth="20*" align="center" />
<colspec colname="c2" colwidth="20*" align="center" />
<colspec colname="c3" colwidth="60*" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Name</para>
@ -8329,7 +8329,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>
@ -10320,7 +10320,7 @@ where:
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>100</para>
@ -10408,7 +10408,7 @@ where:
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="3" valign="middle">
<para>&#160;</para>
@ -10753,7 +10753,7 @@ where:
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Version</para>
@ -10832,7 +10832,7 @@ where:
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Block_type</para>
@ -10891,7 +10891,7 @@ where:
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Block_type</para>
@ -10981,7 +10981,7 @@ where:
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Block_type</para>

22
LoPAR/app_platform_hcalls.xml
Unescape Escape View File

@ -1,5 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdoclet.50569383_58396">
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en"
xml:id="dbdoclet.50569383_58396">
<title>Platform Dependent hcall()s</title>

<para>This appendix defines the set of hypervisor calls (hcall()s) that are

24
LoPAR/app_splar.xml
Unescape Escape View File

@ -1,8 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en"
xml:id="dbdoclet.50569367_15730">
<title>SPLPAR Characteristics Definitions</title>
<section>
<title xml:id="dbdoclet.50569367_15730">SPLPAR Characteristics Definitions</title>
<title>SPLPAR Characteristics Definitions</title>

<para>This appendix defines the string that is returned by the
ibm,get-system-parameter RTAS call when the parameter token value of 20

24
LoPAR/app_virtual_nic.xml
Unescape Escape View File

@ -1,6 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<title xml:id="dbdoclet.50569384_75285">A Protocol for VNIC Communications</title>
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en"
xml:id="dbdoclet.50569384_75285">
<title>A Protocol for VNIC Communications</title>

<section>
<title>Introduction</title>

22
LoPAR/app_virtual_scsi.xml
Unescape Escape View File

@ -1,5 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdoclet.50569379_75285">
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en"
xml:id="dbdoclet.50569379_75285">
<title>A Protocol for VSCSI Communications</title>

<section>

7
LoPAR/app_virtual_tpm.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -16,7 +16,10 @@

-->
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="ch_virtual_trusted_platform_module">
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en"
xml:id="ch_virtual_trusted_platform_module">
<title>Virtual Trusted Platform Module (VTPM)</title>

<section>

38
LoPAR/app_virtual_tty.xml
Unescape Escape View File

@ -1,5 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdoclet.50569375_64200">
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en"
xml:id="dbdoclet.50569375_64200">
<title>A Protocol for a Virtual TTY Interface</title>

<section>
@ -78,7 +98,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdo
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x0</para>
@ -166,7 +186,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdo
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x0</para>
@ -266,7 +286,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdo
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x6</para>
@ -421,7 +441,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdo
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x6</para>
@ -472,7 +492,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdo
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>TSCD</para>
@ -553,7 +573,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdo
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x0</para>
@ -664,7 +684,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdo
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x0</para>
@ -833,7 +853,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdo
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0xFF</para>

45
LoPAR/app_vmc_comm.xml
Unescape Escape View File

@ -1,5 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en">
<title>A Protocol for VMC Communications</title>

<section>
@ -72,7 +91,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<colspec colname="c1" colwidth="15*" align="center" />
<colspec colname="c2" colwidth="15*" align="center" />
<colspec colname="c3" colwidth="70*" align="center" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1 B</para>
@ -123,7 +142,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<colspec colname="c7" colwidth="11*" align="center" />
<colspec colname="c8" colwidth="11*" align="center" />
<colspec colname="c9" colwidth="11*" align="center" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1 B</para>
@ -240,7 +259,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<colspec colname="c7" colwidth="11*" align="center" />
<colspec colname="c8" colwidth="11*" align="center" />
<colspec colname="c9" colwidth="11*" align="center" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1 B</para>
@ -402,7 +421,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<colspec colname="c6" colwidth="12*" align="center" />
<colspec colname="c7" colwidth="12*" align="center" />
<colspec colname="c8" colwidth="12*" align="center" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1 B</para>
@ -492,7 +511,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<colspec colname="c6" colwidth="12*" align="center" />
<colspec colname="c7" colwidth="12*" align="center" />
<colspec colname="c8" colwidth="12*" align="center" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1 B</para>
@ -570,7 +589,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<colspec colname="c6" colwidth="12*" align="center" />
<colspec colname="c7" colwidth="12*" align="center" />
<colspec colname="c8" colwidth="12*" align="center" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1 B</para>
@ -646,7 +665,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<colspec colname="c6" colwidth="12*" align="center" />
<colspec colname="c7" colwidth="12*" align="center" />
<colspec colname="c8" colwidth="12*" align="center" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1 B</para>
@ -723,7 +742,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<colspec colname="c7" colwidth="11*" align="center" />
<colspec colname="c8" colwidth="11*" align="center" />
<colspec colname="c9" colwidth="11*" align="center" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1 B</para>
@ -834,7 +853,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<colspec colname="c6" colwidth="12*" align="center" />
<colspec colname="c7" colwidth="12*" align="center" />
<colspec colname="c8" colwidth="12*" align="center" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1 B</para>
@ -914,7 +933,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<colspec colname="c6" colwidth="12*" align="center" />
<colspec colname="c7" colwidth="12*" align="center" />
<colspec colname="c8" colwidth="12*" align="center" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1 B</para>
@ -1022,7 +1041,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<colspec colname="c6" colwidth="12*" align="center" />
<colspec colname="c7" colwidth="12*" align="center" />
<colspec colname="c8" colwidth="12*" align="center" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1 B</para>
@ -1102,7 +1121,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<colspec colname="c7" colwidth="11*" align="center" />
<colspec colname="c8" colwidth="11*" align="center" />
<colspec colname="c9" colwidth="11*" align="center" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1 B</para>

2
LoPAR/bk_main.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

13
LoPAR/ch_LoPAPR_preface.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -15,11 +15,12 @@
limitations under the License.

-->
<preface xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="ch_PAPR_preface">
<preface xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="ch_PAPR_preface">

<title>About This Document</title>
<?dbhtml stop-chunking?>


23
LoPAR/ch_address_map.xml
Unescape Escape View File

@ -1,6 +1,25 @@
<?xml version="1.0"?>
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdoclet.50569328_Address-Map">
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en"
xml:id="dbdoclet.50569328_Address-Map">
<title>Address Map</title>

<para>The address map of an LoPAR platform is made up of several distinct

17
LoPAR/ch_dynamic_reconfig.xml
Unescape Escape View File

@ -1,3 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"

30
LoPAR/ch_interrupt_controller.xml
Unescape Escape View File

@ -1,9 +1,25 @@
<?xml version="1.0"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569331_37856"
version="5.0"
xml:lang="en">
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569331_37856"
version="5.0"
xml:lang="en">
<title>Interrupt Controller</title>

<para>This chapter specifies the requirements for the LoPAR interrupt
@ -306,7 +322,7 @@ xml:lang="en">
particular, these calls assign additional MSI resources to an IOA function (as
defined by its PCI configuration address: <emphasis>PHB_Unit_ID_Hi,
PHB_Unit_ID_Low, and config_addr</emphasis>), when supported by the platform.
See <xref linkend="dbdoclet.50569332_61719"/> for more information on theses RTAS calls for
See <xref linkend="dbdoclet.50569332_61719"/> for more information on theses RTAS calls for
MSI management.</para>
<para>This architecture will refer generically to the MSI and MSI-X
capabilities as simply &#x201C;MSI,&#x201D; except where differentiation is

216
LoPAR/ch_introduction.xml
Unescape Escape View File

@ -1,130 +1,146 @@
<?xml version="1.0"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569326_38341"
version="5.0"
xml:lang="en">
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569326_38341"
version="5.0"
xml:lang="en">
<title>Introduction</title>
<para>This architecture specification provides a comprehensive computer
system platform-to-software interface definition, combined with minimum system
requirements, that enables the development of and software porting to a range
of compatible industry-standard computer systems from workstations through
servers. These systems are based on the requirements defined in
<xref linkend="dbdoclet.50569387_99718"/><footnote xml:id="pgfId-1000323"><para>The
term &#x201C;Processor Architecture&#x201D; (PA) is used throughout this
document to mean compliance with the requirements specified in
<xref linkend="dbdoclet.50569387_99718"/>.</para></footnote>. The definition supports
the development of both uniprocessor and multiprocessor system

<para>This architecture specification provides a comprehensive computer
system platform-to-software interface definition, combined with minimum system
requirements, that enables the development of and software porting to a range
of compatible industry-standard computer systems from workstations through
servers. These systems are based on the requirements defined in
<xref linkend="dbdoclet.50569387_99718"/><footnote xml:id="pgfId-1000323"><para>The
term &#x201C;Processor Architecture&#x201D; (PA) is used throughout this
document to mean compliance with the requirements specified in
<xref linkend="dbdoclet.50569387_99718"/>.</para></footnote>. The definition supports
the development of both uniprocessor and multiprocessor system
implementations.</para>
<para>A key attribute and benefit of this architecture is the ability of
platform developers to have degrees of freedom of implementation below the
level of architected interfaces and therefore have the opportunity for adding
unique value. This flexibility is achieved through architecture facilities
including: (1) device drivers; (2) Open Firmware (OF); (3)
Run-Time Abstraction Services (RTAS);
and (4) hardware abstraction layers. The role of items 1
and 4 are described in separate operating system (OS) documentation. The role
that items 2 and 3 play in this architecture will be described in subsequent
<para>A key attribute and benefit of this architecture is the ability of
platform developers to have degrees of freedom of implementation below the
level of architected interfaces and therefore have the opportunity for adding
unique value. This flexibility is achieved through architecture facilities
including: (1) device drivers; (2) Open Firmware (OF); (3)
Run-Time Abstraction Services (RTAS);
and (4) hardware abstraction layers. The role of items 1
and 4 are described in separate operating system (OS) documentation. The role
that items 2 and 3 play in this architecture will be described in subsequent
paragraphs and chapters.</para>
<para>This architecture combines leading-edge technologies to create a
superior computing platform. By design, it supports a wide range of computing
needs including personal productivity, engineering design, data management,
information analysis, education, desktop publishing, multimedia, entertainment,
and database, file, and application servers. This architecture effectively
leverages industry-standard I/O through the PCI bus. Systems based on this
architecture are expected to offer price/performance advantages and to address
<para>This architecture combines leading-edge technologies to create a
superior computing platform. By design, it supports a wide range of computing
needs including personal productivity, engineering design, data management,
information analysis, education, desktop publishing, multimedia, entertainment,
and database, file, and application servers. This architecture effectively
leverages industry-standard I/O through the PCI bus. Systems based on this
architecture are expected to offer price/performance advantages and to address
the expected growth in computing performance and functionality.</para>
<para><emphasis role="bold">Architecture Note:</emphasis> In modern platforms, designers may choose
between various PCI topology standards. This architecture uses the term
&#x201C;PCI&#x201D; as a general term to describe the most recent versions of
all forms of PCI standards including any approved Engineering Change Requests
(ECRs) against them. In cases where there are significant differences between
individual PCI standards, the following terminology is used to differentiate
<para><emphasis role="bold">Architecture Note:</emphasis> In modern platforms, designers may choose
between various PCI topology standards. This architecture uses the term
&#x201C;PCI&#x201D; as a general term to describe the most recent versions of
all forms of PCI standards including any approved Engineering Change Requests
(ECRs) against them. In cases where there are significant differences between
individual PCI standards, the following terminology is used to differentiate
between the PCI standards.</para>

<itemizedlist>
<itemizedlist>
<listitem>
<para>The term &#x201C;conventional PCI&#x201D; refers to behavior or
features that conform to the most recent version of the
<xref linkend="dbdoclet.50569387_65468"/>, including any approved ECRs against it.
<para>The term &#x201C;conventional PCI&#x201D; refers to behavior or
features that conform to the most recent version of the
<xref linkend="dbdoclet.50569387_65468"/>, including any approved ECRs against it.
</para>
</listitem>

<listitem>
<para>The term &#x201C;PCI-X&#x201D; refers to behavior or features that
conform to the most recent version of the
<para>The term &#x201C;PCI-X&#x201D; refers to behavior or features that
conform to the most recent version of the
<xref linkend="dbdoclet.50569387_26550"/>, including any approved ECRs against it.</para>
</listitem>

<listitem>
<para>The term &#x201C;PCI Express&#x201D; refers to behavior or features
that conform to the most recent version of the
<xref linkend="dbdoclet.50569387_66784"/> including any approved ECRs against it. In
addition, the terms &#x201C;bus,&#x201D; &#x201C;bridge&#x201D; and &#x201C;PCI
Host Bridge (PHB)&#x201D; used in relation to &#x201C;PCI&#x201D; throughout
this architecture may refer to a PCI Express &#x201C;link,&#x201D;
<para>The term &#x201C;PCI Express&#x201D; refers to behavior or features
that conform to the most recent version of the
<xref linkend="dbdoclet.50569387_66784"/> including any approved ECRs against it. In
addition, the terms &#x201C;bus,&#x201D; &#x201C;bridge&#x201D; and &#x201C;PCI
Host Bridge (PHB)&#x201D; used in relation to &#x201C;PCI&#x201D; throughout
this architecture may refer to a PCI Express &#x201C;link,&#x201D;
&#x201C;switch,&#x201D; and &#x201C;root complex&#x201D; respectively.</para>
</listitem>
</itemizedlist>
</itemizedlist>

<section>
<title>Platform Topology</title>
<para>To the experienced computer designer and system manufacturer, much of
the content of this architecture will be familiar. A typical desktop topology
is shown in <xref linkend="dbdoclet.50569326_34945"/>. This topology consists
of a single PA processor, volatile System Memory, and a single Host Bridge
providing a PCI Bus. The PCI Bus provides for connection of I/O adapters
(IOAs). See <xref linkend="dbdoclet.50569388_37308"/> for the definition of an
<para>To the experienced computer designer and system manufacturer, much of
the content of this architecture will be familiar. A typical desktop topology
is shown in <xref linkend="dbdoclet.50569326_34945"/>. This topology consists
of a single PA processor, volatile System Memory, and a single Host Bridge
providing a PCI Bus. The PCI Bus provides for connection of I/O adapters
(IOAs). See <xref linkend="dbdoclet.50569388_37308"/> for the definition of an
IOA.</para>
<para>A more complex general topology is shown in
<xref linkend="dbdoclet.50569326_34945"/>. All platforms consist of one or more PA
processors, a volatile System Memory separate from other subsystems, and a
number of IOAs, which may initiate transactions to System Memory. The
processors are linked over the primary processor bus/switch to each other, to
the System Memory, and to one or more Host Bridges. In general, IOAs do not
connect to the primary processor bus/switch. The Host Bridges connect to
secondary buses which have IOAs connected to them. In turn, one or more bus
bridges may be employed to tertiary buses (and beyond) with additional IOAs
connected to them. Typically, the bus speeds and throughput decrease and the
number of supportable loads increases as one progresses from the primary
<para>A more complex general topology is shown in
<xref linkend="dbdoclet.50569326_34945"/>. All platforms consist of one or more PA
processors, a volatile System Memory separate from other subsystems, and a
number of IOAs, which may initiate transactions to System Memory. The
processors are linked over the primary processor bus/switch to each other, to
the System Memory, and to one or more Host Bridges. In general, IOAs do not
connect to the primary processor bus/switch. The Host Bridges connect to
secondary buses which have IOAs connected to them. In turn, one or more bus
bridges may be employed to tertiary buses (and beyond) with additional IOAs
connected to them. Typically, the bus speeds and throughput decrease and the
number of supportable loads increases as one progresses from the primary
processor bus to more remote buses. </para>
<para>There are variations on these topologies, which are likely to occur
and are therefore worth describing below. This architecture describes
interfaces, not implementation. The logical software model must remain the
<para>There are variations on these topologies, which are likely to occur
and are therefore worth describing below. This architecture describes
interfaces, not implementation. The logical software model must remain the
same, even if the physical topology is different.</para>

<itemizedlist>
<itemizedlist>
<listitem>
<para>In a smaller platform, the Host Bridge and/or the memory and/or an
IOA may be integrated into a single chip. In this case, the topology would not
look like <xref linkend="dbdoclet.50569326_34945"/> from a chip point of view,
<para>In a smaller platform, the Host Bridge and/or the memory and/or an
IOA may be integrated into a single chip. In this case, the topology would not
look like <xref linkend="dbdoclet.50569326_34945"/> from a chip point of view,
but instead would be integrated onto the single chip.</para>
</listitem>

<listitem>
<para>In a larger platform, secondary buses may be implemented, with two
or more Host Bridges, as two or more parallel expansion buses for performance
reasons. Similarly, tertiary buses may be two or more parallel expansion buses
off each secondary bus. This is indicated by the ellipses near the Host Bridge
<para>In a larger platform, secondary buses may be implemented, with two
or more Host Bridges, as two or more parallel expansion buses for performance
reasons. Similarly, tertiary buses may be two or more parallel expansion buses
off each secondary bus. This is indicated by the ellipses near the Host Bridge
and the Bus Bridge.</para>
</listitem>

<listitem>
<para>In a high performance platform, with multiple processors and
multiple memoriea switch may be employed to allow multiple parallel accesses
by the processors to memory. The path through the switches would be decided by
the addressing of ths, a switch may be employed to allow multiple parallel accesses
by the processors to memory. The path through the switches would be decided by
<para>In a high performance platform, with multiple processors and
multiple memoriea switch may be employed to allow multiple parallel accesses
by the processors to memory. The path through the switches would be decided by
the addressing of ths, a switch may be employed to allow multiple parallel accesses
by the processors to memory. The path through the switches would be decided by
the addressing of the memory.</para>
</listitem>
</itemizedlist>
<para>Each of the following chapters provides information necessary to
successfully implement compliant systems. It is recommended that the reader
become thoroughly familiar with the contents of these chapters and their
references prior to beginning system or software development. It is anticipated
that standard chip sets will simplify the development of compliant
implementations consistent with the topologies shown below and will be
</itemizedlist>
<para>Each of the following chapters provides information necessary to
successfully implement compliant systems. It is recommended that the reader
become thoroughly familiar with the contents of these chapters and their
references prior to beginning system or software development. It is anticipated
that standard chip sets will simplify the development of compliant
implementations consistent with the topologies shown below and will be
available from third-party industry sources.</para>
<figure xml:id="dbdoclet.50569326_34945">
<title>Typical Desktop Topology</title>
@ -140,9 +156,9 @@ xml:lang="en">
<imageobject role="fo"><imagedata contentdepth="100%" fileref="figures/PAPR-4.gif" format="GIF" scalefit="1" width="100%"/></imageobject>
</mediaobject>
</figure>
<para><emphasis role="bold">Note:</emphasis> To enable the implementation of a large number of I/O adapters in a large
system, the Host Bridge may be split into two pieces -- a Hub and a Bridge --
with the two connected by a cable, thus enabling the I/O adapters to be housed
<para><emphasis role="bold">Note:</emphasis> To enable the implementation of a large number of I/O adapters in a large
system, the Host Bridge may be split into two pieces -- a Hub and a Bridge --
with the two connected by a cable, thus enabling the I/O adapters to be housed
at a distance from the main processor enclosure.</para>
</section>
</chapter>

26
LoPAR/ch_io_devices.xml
Unescape Escape View File

@ -1,6 +1,24 @@
<?xml version="1.0"?>
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en">
<title>I/O Devices</title>

<para>This chapter describes requirements for IOAs. It adds detail to areas
@ -299,7 +317,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="3">
<para> Command</para>
@ -583,7 +601,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Entire adapter assigned to OS, IOV not enabled</para>

28
LoPAR/ch_io_topology.xml
Unescape Escape View File

@ -1,9 +1,25 @@
<?xml version="1.0"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569330_13240"
version="5.0"
xml:lang="en">
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569330_13240"
version="5.0"
xml:lang="en">
<title>I/O Bridges and Topologies</title>

<para>There will be at least one bridge in a platform which interfaces to the

42
LoPAR/ch_lpar_option.xml
Unescape Escape View File

@ -1,5 +1,25 @@
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdoclet.50569344_14591">
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en"
xml:id="dbdoclet.50569344_14591">
<title>Logical Partitioning Option</title>

<section>
@ -8077,7 +8097,7 @@ hcall ( const int64 H_BLOCK_REMOVE, /* Function Code */
<entry><para role="font-size:6pt">7</para></entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry namest="c1" nameend="c8">
<para role="font-size:6pt">Control</para>
@ -8117,7 +8137,7 @@ hcall ( const int64 H_BLOCK_REMOVE, /* Function Code */
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry><para>Type</para></entry>
<entry><para>&#160;</para></entry>
@ -23176,7 +23196,7 @@ hcall ( const H_STOP_COP_OP,
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="3">
<para>43:44</para>
@ -23410,7 +23430,7 @@ hcall ( const uint64 H_MEMSTAT_CTRL, uint64 flags);]]></programlisting>
<entry><para>31</para></entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry><para>0</para></entry>
<entry><para>R</para></entry>
@ -23477,7 +23497,7 @@ hcall ( const uint64 H_MEMSTAT_CTRL, uint64 flags);]]></programlisting>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0</para>
@ -23569,7 +23589,7 @@ hcall ( const uint64 H_MEMSTAT_CTRL, uint64 flags);]]></programlisting>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0</para>
@ -23644,7 +23664,7 @@ hcall ( const uint64 H_MEMSTAT_CTRL, uint64 flags);]]></programlisting>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0</para>
@ -23954,7 +23974,7 @@ hcall ( const uint64 H_RETURN_PAGEINFO,
<entry><para>7</para></entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry><para>0</para></entry>
<entry namest="c2" nameend="c3"><para>Ar</para></entry>
@ -24140,7 +24160,7 @@ hcall ( const uint64 H_RETURN_PAGEINFO,
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>lpx</para>

26
LoPAR/ch_nonvolatile_memory.xml
Unescape Escape View File

@ -1,8 +1,24 @@
<?xml version="1.0"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569333_15433"
version="5.0" xml:lang="en">
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569333_15433"
version="5.0" xml:lang="en">
<title>Non-Volatile Memory</title>

<para>This chapter describes the requirements relating to Non-Volatile

2
LoPAR/ch_notifications.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

28
LoPAR/ch_numa.xml
Unescape Escape View File

@ -1,9 +1,25 @@
<?xml version="1.0"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569346_35960"
version="5.0"
xml:lang="en">
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569346_35960"
version="5.0"
xml:lang="en">
<title>Non Uniform Memory Access (NUMA) Option</title>

<section>

24
LoPAR/ch_processors_memory.xml
Unescape Escape View File

@ -1,6 +1,24 @@
<?xml version="1.0"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en">
<title>Processor and Memory</title>

<para>The purpose of this chapter is to specify the processor and memory

28
LoPAR/ch_product_topology.xml
Unescape Escape View File

@ -1,9 +1,25 @@
<?xml version="1.0"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569341_39268"
version="5.0"
xml:lang="en">
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569341_39268"
version="5.0"
xml:lang="en">
<title>Product Topology</title>

<section xml:id="dbdoclet.50569341_34882">

2
LoPAR/ch_rtas.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

40
LoPAR/ch_service_indicators.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -799,9 +799,9 @@
<?dbhtml table-width="75%" ?>
<?dbfo table-width="75%" ?>
<tgroup cols="3">
<colspec colname="c1" colwidth="33*" />
<colspec colname="c2" colwidth="33*" />
<colspec colname="c3" colwidth="33*" />
<colspec colname="c1" colwidth="33*" align="center" />
<colspec colname="c2" colwidth="33*" align="center" />
<colspec colname="c3" colwidth="33*" align="center" />
<thead>
<row>
<entry>
@ -821,7 +821,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Number of FRUs</para>
@ -3751,7 +3751,7 @@
<?dbhtml table-width="80%" ?>
<?dbfo table-width="80%" ?>
<tgroup cols="2">
<colspec colname="c1" colwidth="40*" />
<colspec colname="c1" colwidth="40*" align="center" />
<colspec colname="c2" colwidth="60*" />
<thead>
<row>
@ -3760,14 +3760,14 @@
<emphasis role="bold">Green Indicator State</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Usage</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Any not already covered in this table</para>
@ -3833,7 +3833,7 @@
<?dbhtml table-width="80%" ?>
<?dbfo table-width="80%" ?>
<tgroup cols="2">
<colspec colname="c1" colwidth="40*" />
<colspec colname="c1" colwidth="40*" align="center" />
<colspec colname="c2" colwidth="60*" />
<thead>
<row>
@ -3842,14 +3842,14 @@
<emphasis role="bold">Green Indicator State</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Usage</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Any not already covered in this table</para>
@ -3936,7 +3936,7 @@
<?dbhtml table-width="80%" ?>
<?dbfo table-width="80%" ?>
<tgroup cols="2">
<colspec colname="c1" colwidth="40*" />
<colspec colname="c1" colwidth="40*" align="center" />
<colspec colname="c2" colwidth="60*" />
<thead>
<row>
@ -3945,14 +3945,14 @@
<emphasis role="bold">Green Indicator State</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Usage</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Any not already covered in this table</para>
@ -4025,7 +4025,7 @@
<?dbhtml table-width="80%" ?>
<?dbfo table-width="80%" ?>
<tgroup cols="2">
<colspec colname="c1" colwidth="40*" />
<colspec colname="c1" colwidth="40*" align="center" />
<colspec colname="c2" colwidth="60*" />
<thead>
<row>
@ -4034,14 +4034,14 @@
<emphasis role="bold">Green Indicator State</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Usage</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Any not already covered in this table</para>
@ -4110,7 +4110,7 @@
<?dbhtml table-width="80%" ?>
<?dbfo table-width="80%" ?>
<tgroup cols="2">
<colspec colname="c1" colwidth="40*" />
<colspec colname="c1" colwidth="40*" align="center" />
<colspec colname="c2" colwidth="60*" />
<thead>
<row>
@ -4119,14 +4119,14 @@
<emphasis role="bold">Green Indicator State</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Usage</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Any not already covered in this table</para>

28
LoPAR/ch_smp.xml
Unescape Escape View File

@ -1,9 +1,25 @@
<?xml version="1.0"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569340_14972"
version="5.0"
xml:lang="en">
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569340_14972"
version="5.0"
xml:lang="en">
<title>The Symmetric Multiprocessor Option</title>

<para>This architecture supports the implementation of symmetric

28
LoPAR/ch_system_reqs.xml
Unescape Escape View File

@ -1,9 +1,25 @@
<?xml version="1.0"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569327_31987"
version="5.0"
xml:lang="en">
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xml:id="dbdoclet.50569327_31987"
version="5.0"
xml:lang="en">
<title>System Requirements</title>

<para>This chapter gives an operational overview of LoPAR systems and

24
LoPAR/ch_virtual_io.xml
Unescape Escape View File

@ -1,5 +1,25 @@
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en" xml:id="dbdoclet.50569348_71217">
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
version="5.0"
xml:lang="en"
xml:id="dbdoclet.50569348_71217">
<title>Virtualized Input/Output</title>
<para>Virtualized I/O is an optional feature of platforms that have
hypervisor support. Virtual I/O (VIO) provides to a given partition the

22
LoPAR/pom.xml
Unescape Escape View File

@ -1,7 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<!--
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<parent>

<groupId>org.openpowerfoundation.docs</groupId>

54
LoPAR/sec_LoPAPR_audience.xml
Unescape Escape View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
@ -13,36 +13,36 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<section xmlns="http://docbook.org/ns/docbook"
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="section_PAPR_audience">
<?dbhtml stop-chunking?>
<?dbhtml stop-chunking?>

<title> Audience for This Document</title>
<para>This document defines the platform and system requirements for designing
LoPAR platforms. This document is the primary source of information that a platform,
OS, or hardware component developer would need to create compatible products.
Additional requirements are defined by the industry standards referenced in this

<para>This document defines the platform and system requirements for designing
LoPAR platforms. This document is the primary source of information that a platform,
OS, or hardware component developer would need to create compatible products.
Additional requirements are defined by the industry standards referenced in this
document.</para>
<para>This document describes the platform to OS interface which must be provided
in these platforms. Platform designers must assemble components and firmware which
match this interface. Also, the document defines minimum system configuration
requirements. Platform designers must meet or exceed these minimums to build a

<para>This document describes the platform to OS interface which must be provided
in these platforms. Platform designers must assemble components and firmware which
match this interface. Also, the document defines minimum system configuration
requirements. Platform designers must meet or exceed these minimums to build a
standard platform. </para>
<para>This document must be used by those designing compatible software including
the OS, boot software, or firmware. If a function is supported, software developers
must provide support for the interfaces described in this document. This software
must provide the mandatory functions and capabilities as described in the requirements
in this document. However, this document does not limit this software from going beyond
the specification through software tailored to specific hardware. For example, the OS
must implement the interface to the required abstracted interfaces to hardware, but the

<para>This document must be used by those designing compatible software including
the OS, boot software, or firmware. If a function is supported, software developers
must provide support for the interfaces described in this document. This software
must provide the mandatory functions and capabilities as described in the requirements
in this document. However, this document does not limit this software from going beyond
the specification through software tailored to specific hardware. For example, the OS
must implement the interface to the required abstracted interfaces to hardware, but the
OS may also implement fast paths to specific hardware that it recognizes.</para>

</section>

123
LoPAR/sec_LoPAPR_conventions.xml
Unescape Escape View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
@ -13,77 +13,80 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<section xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="section_PAPR_conventions">
<?dbhtml stop-chunking?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0" xml:id="section_PAPR_conventions">

<?dbhtml stop-chunking?>

<title> Document-specific Conventions</title>

<simplesect>
<title> Requirement Enumeration</title>
<para>Within the body of this document requirements are clearly defined by separate
paragraphs beginning with a bold text sequence number. A list of all these are
available as a separate document. These requirements may point to other standards
documents, or figures or tables which conveniently show the requirement. The
referenced material becomes part of the requirements in this document. Users of this
document must comply with these requirements to build a standard platform. Other
material in this document is supportive description of these requirements, architecture
notes, or implementation notes. Architecture or implementation notes are flagged with
a descriptive phrase&#8212;for example, &#8220;Hardware Implementation Note&#8221;&#8212;
and followed by indented paragraphs. The descriptive material and notes provide no
<para>Within the body of this document requirements are clearly defined by separate
paragraphs beginning with a bold text sequence number. A list of all these are
available as a separate document. These requirements may point to other standards
documents, or figures or tables which conveniently show the requirement. The
referenced material becomes part of the requirements in this document. Users of this
document must comply with these requirements to build a standard platform. Other
material in this document is supportive description of these requirements, architecture
notes, or implementation notes. Architecture or implementation notes are flagged with
a descriptive phrase&#8212;for example, &#8220;Hardware Implementation Note&#8221;&#8212;
and followed by indented paragraphs. The descriptive material and notes provide no
additional requirements and may be used for their information content.</para>
</simplesect>

<simplesect>
<title> Big-Endian Numbering</title>
<para>Big-Endian numbering of bytes and bits is used in this document, unless
indicated otherwise. Numbering of bits starts at 0 for the most significant bit and
continues to the least significant bit, unless indicated otherwise. All data structures
used for communicating between the OS and the platform (for example, RTAS and hypervisor
<para>Big-Endian numbering of bytes and bits is used in this document, unless
indicated otherwise. Numbering of bits starts at 0 for the most significant bit and
continues to the least significant bit, unless indicated otherwise. All data structures
used for communicating between the OS and the platform (for example, RTAS and hypervisor
calls) will be in Big-Endian format, unless otherwise designated.</para>
</simplesect>

<simplesect>
<title> Hypertext Links</title>
<para>This document makes use of hypertext links. Cross references, Table of Contents
entries, List of Tables entries, and List of Figures entries are all clickable hypertext
<para>This document makes use of hypertext links. Cross references, Table of Contents
entries, List of Tables entries, and List of Figures entries are all clickable hypertext
links, to make navigation of the document easier.</para>
</simplesect>

<simplesect>
<title> Specific Terms</title>
<para>In this document:</para>
<itemizedlist>
<listitem>
<para>The term &#8220;Processor Architecture&#8221; (PA) is used to mean compliance with
<para>The term &#8220;Processor Architecture&#8221; (PA) is used to mean compliance with
the requirements specified in <citetitle><xref linkend="dbdoclet.50569387_99718"/></citetitle>.</para>
</listitem>
<listitem>
<para>The term &#8220;processor&#8221; is used as a general term to mean &#8220;processor,
&#8221; or &#8220;processor core,&#8221; or &#8220;thread of a multi-threaded processor
design.&#8221; In any case where it makes a difference, the specific terminology for that
&#8221; or &#8220;processor core,&#8221; or &#8220;thread of a multi-threaded processor
design.&#8221; In any case where it makes a difference, the specific terminology for that
case is used.</para>
</listitem>
<listitem>
<para>The term &#8220;real&#8221; used in relationship with addresses is a generic term
that means &#8220;processor real address&#8221; when the platform is running in SMP (non-LPAR)
mode and partition &#8220;logical real address&#8221; when the platform is running in LPAR
<para>The term &#8220;real&#8221; used in relationship with addresses is a generic term
that means &#8220;processor real address&#8221; when the platform is running in SMP (non-LPAR)
mode and partition &#8220;logical real address&#8221; when the platform is running in LPAR
mode.</para>
</listitem>
<listitem>
<para>The term &#8220;PCI&#8221; is used as a general term to describe the most recent
versions of all forms of PCI standards. In cases where there are significant differences
between individual PCI standards, the following terminology is used to differentiate between
<para>The term &#8220;PCI&#8221; is used as a general term to describe the most recent
versions of all forms of PCI standards. In cases where there are significant differences
between individual PCI standards, the following terminology is used to differentiate between
the PCI standards: conventional PCI, PCI-X, and PCI Express.</para>
</listitem>
</itemizedlist>
</simplesect>

<simplesect>
<title> Typographical Conventions</title>
<para>Typographical conventions used in this document are described in
<para>Typographical conventions used in this document are described in
<xref linkend="dbdoclet.50569325_36717"/>.</para>
<para><anchor xml:id="dbdoclet.50569325_12795" xreflabel=""/>&#160;</para>
<table frame="all" pgwide="1" xml:id="dbdoclet.50569325_36717">
@ -98,14 +101,14 @@
</thead><tbody>
<row>
<entry><para> Rn-m-x.</para></entry>
<entry><para> A requirement number. The number &#8220;n&#8221; indicates a requirement
sequence number and is changed only when it is necessary change the sequence numbers
of one or more requirements on an update. The number &#8220;m&#8221; is the section
that the requirement appears in, and the number &#8220;x&#8221; is the number of the
requirement within that section. The sequence numbers are automatically generated and
are restarted at the beginning of each new section. Sequence numbers for existing
requirements will not change unless it becomes necessary to insert a requirement between
other requirements or to add a section that renumbers other sections (at which point,
<entry><para> A requirement number. The number &#8220;n&#8221; indicates a requirement
sequence number and is changed only when it is necessary change the sequence numbers
of one or more requirements on an update. The number &#8220;m&#8221; is the section
that the requirement appears in, and the number &#8220;x&#8221; is the number of the
requirement within that section. The sequence numbers are automatically generated and
are restarted at the beginning of each new section. Sequence numbers for existing
requirements will not change unless it becomes necessary to insert a requirement between
other requirements or to add a section that renumbers other sections (at which point,
the number &#8220;n&#8221; will be incremented for the next publication of the document).</para></entry>
</row>
<row>
@ -116,8 +119,8 @@
</row>
<row>
<entry><para> <emphasis role="bold"><literal> Courier Bold</literal></emphasis></para></entry>
<entry><para> Indicates OF properties, methods, configuration variables, node names
and encode functions (for example, <emphasis> encode-int</emphasis> and <emphasis>
<entry><para> Indicates OF properties, methods, configuration variables, node names
and encode functions (for example, <emphasis> encode-int</emphasis> and <emphasis>
encode-string</emphasis> ). In addition, OF properties are enclosed in quotes.</para>
<para>Indicates NVRAM partition names</para></entry>
</row>
@ -139,44 +142,44 @@
</row>
<row>
<entry><para> 0xF... FFF100</para></entry>
<entry><para> This hexadecimal notation represents a replication of the hexadecimal
character to the right of the ellipsis to fill out the field width. For example, the
address 0xF... FFF100 would be 0xFFFFF100 on a processor with a 32-bit address bus or
<entry><para> This hexadecimal notation represents a replication of the hexadecimal
character to the right of the ellipsis to fill out the field width. For example, the
address 0xF... FFF100 would be 0xFFFFF100 on a processor with a 32-bit address bus or
0xFFFFFFFFFFFFF100 on a processor with a 64-bit address bus.</para></entry>
</row>
<row>
<entry><para> 0:9</para></entry>
<entry><para> Ranges of bits are specified by two numbers separated by a colon. The
<entry><para> Ranges of bits are specified by two numbers separated by a colon. The
range includes the first number, all numbers in between, and the last number.</para></entry>
</row>
<row>
<entry><para> 0xm-0xn</para></entry>
<entry><para> A range of addresses or values within the document is always inclusive,
<entry><para> A range of addresses or values within the document is always inclusive,
from m up to and including n.</para></entry>
</row>
<row>
<entry><para> &lt;token&gt;</para></entry>
<entry><para> This notation means the character or character string named within the
less than and greater than symbols is used in the place of the symbols and name. For
<entry><para> This notation means the character or character string named within the
less than and greater than symbols is used in the place of the symbols and name. For
instance, the property name <emphasis role="bold"> &#8220;ibm,sensor-</emphasis> <emphasis>&lt;token&gt;</emphasis>
<emphasis role="bold">&#8221;</emphasis> indicates the set of properties
<emphasis role="bold">&#8221;</emphasis> indicates the set of properties
<emphasis role="bold">&#8220;ibm,sensor-9000&#8221;</emphasis>,
<emphasis role="bold">&#8220;ibm,sensor-9001&#8221;</emphasis> , . . .</para></entry>
</row>
<row>
<entry><para> Reserved For Compatibility</para></entry>
<entry><para> This notation is a placeholder used to reserve numbering (for example,
chapter, section and requirement numbers) so that subsequent numbering remains consistent
<entry><para> This notation is a placeholder used to reserve numbering (for example,
chapter, section and requirement numbers) so that subsequent numbering remains consistent
with document changes.</para></entry>
</row>
<row>
<entry><para> NULL vs. null</para></entry>
<entry><para> NULL designates an ASCII NULL string (0x00). The term &#8220;null&#8221;
<entry><para> NULL designates an ASCII NULL string (0x00). The term &#8220;null&#8221;
indicates the empty set.</para></entry>
</row>
</tbody>
</tgroup>
</table>
</simplesect>

</section>

69
LoPAR/sec_LoPAPR_goals.xml
Unescape Escape View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
@ -13,73 +13,76 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<section xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="section_PAPR_goals">
<?dbhtml stop-chunking?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0" xml:id="section_PAPR_goals">

<?dbhtml stop-chunking?>

<title> Goals of This Specification</title>

<para>The specific goals of this specification are as follows:</para>

<itemizedlist>

<listitem>
<para>To create a stable platform architecture to be used by platforms based on processors
defined by <xref linkend="dbdoclet.50569387_99718"/>. <emphasis>Processor</emphasis>
implementations based on this
<para>To create a stable platform architecture to be used by platforms based on processors
defined by <xref linkend="dbdoclet.50569387_99718"/>. <emphasis>Processor</emphasis>
implementations based on this
architecture include IBM POWER8&#8482; processors and their successors. </para>
</listitem>

<listitem>
<para>To create an architecture which will allow platforms to operate with previous versions
<para>To create an architecture which will allow platforms to operate with previous versions
of the OS (&#8220;n-1&#8221; capability). </para>
</listitem>

<listitem>
<para>To leverage existing and future industry-standard buses and interfaces.</para>
</listitem>

<listitem>
<para>To provide a flexible address map. Another key attribute of this specification
is the relocatability of devices and subsystems within the Processor Architecture (PA)
address space. Subsystem address information, which defines where I/O Adapters (IOAs)
reside, is detected by the OF and passed to the OS in the device tree. This architecture
accommodates the use of multiple identical buses and IOAs in the same platform without
<para>To provide a flexible address map. Another key attribute of this specification
is the relocatability of devices and subsystems within the Processor Architecture (PA)
address space. Subsystem address information, which defines where I/O Adapters (IOAs)
reside, is detected by the OF and passed to the OS in the device tree. This architecture
accommodates the use of multiple identical buses and IOAs in the same platform without
address conflicts.</para>
</listitem>

<listitem>
<para>To build upon the OF boot environment defined in
<para>To build upon the OF boot environment defined in
<xref linkend="dbdoclet.50569387_45524"/>.</para>
</listitem>

<listitem>
<para>To provide an architecture which can evolve as technology changes. </para>
</listitem>

<listitem>
<para>To minimize the support cost for multiple OS versions through the definition of common
platform abstraction techniques. Common and compatible approaches to the abstraction of
<para>To minimize the support cost for multiple OS versions through the definition of common
platform abstraction techniques. Common and compatible approaches to the abstraction of
hardware will reduce the burden on hardware developers who produce differentiated machines.</para>
</listitem>

<listitem>
<para>To architect a mechanism for error handling, error reporting, and fault isolation. This
architecture provides for the implementation of more robust systems, if desired by the system
<para>To architect a mechanism for error handling, error reporting, and fault isolation. This
architecture provides for the implementation of more robust systems, if desired by the system
developers.</para>
</listitem>

<listitem>
<para>To architect a mechanism for Dynamic Reconfiguration of the hardware.</para>
</listitem>

<listitem>
<para>To provide an architecture which allows for the logical partitioning of system resources,
<para>To provide an architecture which allows for the logical partitioning of system resources,
in order to execute multiple concurrent OS instances.</para>
</listitem>
</itemizedlist>


</section>

36
LoPAR/sec_LoPAPR_reading.xml
Unescape Escape View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
@ -13,26 +13,30 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<section xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="section_PAPR_reading">
<?dbhtml stop-chunking?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="section_PAPR_reading">

<?dbhtml stop-chunking?>

<title> Suggested Reading</title>
<para><xref linkend="dbdoclet.50569387_27251"/> provides a full list of references and ordering information

<para><xref linkend="dbdoclet.50569387_27251"/> provides a full list of references and ordering information
for these references.</para>

<para>This document assumes the reader has an understanding of computer architecture in general,
the Processor Architecture, the various Peripheral Component Interconnect (PCI) specifications,
and OF. Some understanding of the current personal computer and workstation architectures is also
<para>This document assumes the reader has an understanding of computer architecture in general,
the Processor Architecture, the various Peripheral Component Interconnect (PCI) specifications,
and OF. Some understanding of the current personal computer and workstation architectures is also
useful. A list of suggested background reading includes:</para>

<itemizedlist>
<listitem>
<para><citetitle><xref linkend="dbdoclet.50569387_99718"/></citetitle>.
Note that this specification is referred to as the &#8220;Processor Architecture,&#8221; or &#8220;PA,&#8221;
<para><citetitle><xref linkend="dbdoclet.50569387_99718"/></citetitle>.
Note that this specification is referred to as the &#8220;Processor Architecture,&#8221; or &#8220;PA,&#8221;
in the body of this document.</para>
</listitem>
<listitem>
@ -48,5 +52,5 @@
<para><citetitle><xref linkend="dbdoclet.50569387_45524"/></citetitle> and relevant bindings</para>
</listitem>
</itemizedlist>

</section>

68
LoPAR/sec_error_codes.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -147,14 +147,14 @@
<?dbhtml table-width="50%" ?>
<?dbfo table-width="50%" ?>
<tgroup cols="8">
<colspec colname="c1" colwidth="12*" />
<colspec colname="c2" colwidth="12*" />
<colspec colname="c3" colwidth="12*" />
<colspec colname="c4" colwidth="12*" />
<colspec colname="c5" colwidth="12*" />
<colspec colname="c6" colwidth="12*" />
<colspec colname="c7" colwidth="12*" />
<colspec colname="c8" colwidth="12*" />
<colspec colname="c1" colwidth="12*" align="center" />
<colspec colname="c2" colwidth="12*" align="center" />
<colspec colname="c3" colwidth="12*" align="center" />
<colspec colname="c4" colwidth="12*" align="center" />
<colspec colname="c5" colwidth="12*" align="center" />
<colspec colname="c6" colwidth="12*" align="center" />
<colspec colname="c7" colwidth="12*" align="center" />
<colspec colname="c8" colwidth="12*" align="center" />
<thead>
<row>
<entry nameend="c5" namest="c1">
@ -169,7 +169,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry nameend="c2" namest="c1">
<para>
@ -228,7 +228,7 @@
<?dbhtml table-width="80%" ?>
<?dbfo table-width="80%" ?>
<tgroup cols="2">
<colspec colname="c1" colwidth="15*" />
<colspec colname="c1" colwidth="15*" align="center" />
<colspec colname="c2" colwidth="85*" />
<thead>
<row>
@ -237,14 +237,14 @@
<emphasis role="bold">Field</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Description</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>S1</para>
@ -349,8 +349,8 @@
<?dbhtml table-width="75%" ?>
<?dbfo table-width="75%" ?>
<tgroup cols="3">
<colspec colname="c1" colwidth="20*" />
<colspec colname="c2" colwidth="20*" />
<colspec colname="c1" colwidth="20*" align="center" />
<colspec colname="c2" colwidth="20*" align="center" />
<colspec colname="c3" colwidth="60*" />
<thead>
<row>
@ -365,19 +365,19 @@
<emphasis role="bold">PCI Sub-ClassS3-S4</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Description</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="2">
<para>0</para>
</entry>
<entry nameend="c3" namest="c2">
<entry nameend="c3" namest="c2" align="center">
<para>Devices that were built before the class code field was
defined</para>
</entry>
@ -403,7 +403,7 @@
<entry morerows="6">
<para>1</para>
</entry>
<entry nameend="c3" namest="c2">
<entry nameend="c3" namest="c2" align="center">
<para>Mass storage controller.</para>
</entry>
</row>
@ -461,7 +461,7 @@
<entry morerows="5">
<para>2</para>
</entry>
<entry nameend="c3" namest="c2">
<entry nameend="c3" namest="c2" align="center">
<para>Network controller.</para>
</entry>
</row>
@ -509,7 +509,7 @@
<entry morerows="3">
<para>3</para>
</entry>
<entry nameend="c3" namest="c2">
<entry nameend="c3" namest="c2" align="center">
<para>Display controller.</para>
</entry>
</row>
@ -541,7 +541,7 @@
<entry morerows="3">
<para>4</para>
</entry>
<entry nameend="c3" namest="c2">
<entry nameend="c3" namest="c2" align="center">
<para>Multimedia device</para>
</entry>
</row>
@ -573,7 +573,7 @@
<entry morerows="3">
<para>5</para>
</entry>
<entry nameend="c3" namest="c2">
<entry nameend="c3" namest="c2" align="center">
<para>Memory controller.</para>
</entry>
</row>
@ -605,7 +605,7 @@
<entry morerows="9">
<para>6</para>
</entry>
<entry nameend="c3" namest="c2">
<entry nameend="c3" namest="c2" align="center">
<para>Bridge IOAs.</para>
</entry>
</row>
@ -685,7 +685,7 @@
<entry morerows="3">
<para>7</para>
</entry>
<entry nameend="c3" namest="c2">
<entry nameend="c3" namest="c2" align="center">
<para>Simple communication controllers.</para>
</entry>
</row>
@ -717,7 +717,7 @@
<entry morerows="5">
<para>8</para>
</entry>
<entry nameend="c3" namest="c2">
<entry nameend="c3" namest="c2" align="center">
<para>Generic system peripherals</para>
</entry>
</row>
@ -765,7 +765,7 @@
<entry morerows="4">
<para>9</para>
</entry>
<entry nameend="c3" namest="c2">
<entry nameend="c3" namest="c2" align="center">
<para>Input devices</para>
</entry>
</row>
@ -805,7 +805,7 @@
<entry morerows="2">
<para>A</para>
</entry>
<entry nameend="c3" namest="c2">
<entry nameend="c3" namest="c2" align="center">
<para>Docking stations</para>
</entry>
</row>
@ -829,7 +829,7 @@
<entry morerows="2">
<para>B</para>
</entry>
<entry nameend="c3" namest="c2">
<entry nameend="c3" namest="c2" align="center">
<para>Processors</para>
</entry>
</row>
@ -853,7 +853,7 @@
<entry morerows="2">
<para>C</para>
</entry>
<entry nameend="c3" namest="c2">
<entry nameend="c3" namest="c2" align="center">
<para>Serial bus controllers</para>
</entry>
</row>
@ -883,8 +883,8 @@
<?dbhtml table-width="75%" ?>
<?dbfo table-width="75%" ?>
<tgroup cols="3">
<colspec colname="c1" colwidth="20*" />
<colspec colname="c2" colwidth="20*" />
<colspec colname="c1" colwidth="20*" align="center" />
<colspec colname="c2" colwidth="20*" align="center" />
<colspec colname="c3" colwidth="60*" />
<thead>
<row>
@ -898,14 +898,14 @@
<emphasis role="bold">Sub-ClassS3-S4</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Description</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="13">
<para>0</para>

4
LoPAR/sec_error_introduction.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -34,7 +34,7 @@
via two RTAS functions,
<emphasis>event-scan</emphasis> and
<emphasis>check-exception</emphasis>, which are described further in
<xref linkend="dbdoclet.50569332_16852"/>. A further RTAS function,
<xref linkend="dbdoclet.50569332_16852"/>. A further RTAS function,
<emphasis>rtas-last-error</emphasis>, is also provided to return
information about hardware failures detected specifically within an RTAS
call.</para>

2
LoPAR/sec_pa_processor_binding_terms.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

2
LoPAR/sec_papr_binding_terms.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

884
LoPAR/sec_rtas_call_defn.xml
View File

File diff suppressed because it is too large Load Diff

23
LoPAR/sec_rtas_configure_kernel_dump.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -40,13 +40,12 @@
<xref linkend="dbdoclet.50569332_24141" />.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_24141">
<title>Argument Call Buffer
<emphasis>ibm,configure-kernel-dump</emphasis></title>
<title><emphasis>ibm,configure-kernel-dump</emphasis> Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Parameter Type</para>
@ -54,7 +53,7 @@
<entry>
<para>Name</para>
</entry>
<entry>
<entry align="center">
<para>Values</para>
</entry>
</row>
@ -174,9 +173,9 @@
<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_76933">
<title>Kernel Assisted Dump Memory Structure</title>
<tgroup cols="5">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="1*" />
<colspec colname="c3" colwidth="1*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="1*" align="center" />
<colspec colname="c3" colwidth="1*" align="center" />
<colspec colname="c4" colwidth="2*" />
<colspec colname="c5" colwidth="2*" />
<thead>
@ -188,7 +187,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Offset</para>
@ -196,7 +195,7 @@
<entry nameend="c3" namest="c2">
<para>Number of Bytes</para>
</entry>
<entry nameend="c5" namest="c4">
<entry nameend="c5" namest="c4" align="center">
<para>Value</para>
</entry>
</row>

54
LoPAR/sec_rtas_dma_window.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -227,11 +227,10 @@
<xref linkend="dbdoclet.50569332_53901" />.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_53901">
<title>Argument Call Buffer
<emphasis>ibm,query-pe-dma-window</emphasis></title>
<title><emphasis>ibm,query-pe-dma-window</emphasis> Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
@ -245,14 +244,14 @@
<emphasis role="bold">Name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Values</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="5" valign="middle">
<para>In</para>
@ -457,11 +456,10 @@
<xref linkend="dbdoclet.50569332_26269" />.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_26269">
<title>Argument Call Buffer
<emphasis>ibm,create-pe-dma-window</emphasis></title>
<title><emphasis>ibm,create-pe-dma-window</emphasis> Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
@ -475,14 +473,14 @@
<emphasis role="bold">Name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Values</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="7" valign="middle">
<para>In</para>
@ -684,11 +682,10 @@
<xref linkend="dbdoclet.50569332_36074" />.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_36074">
<title>Argument Call Buffer
<emphasis>ibm,remove-pe-dma-window</emphasis></title>
<title><emphasis>ibm,remove-pe-dma-window</emphasis> Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
@ -702,14 +699,14 @@
<emphasis role="bold">Name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Values</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="3" valign="middle">
<para>In</para>
@ -853,9 +850,9 @@
<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_25585">
<title>DDW Option Extensions</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="33*" />
<colspec colname="c2" colwidth="33*" />
<colspec colname="c3" colwidth="33*" />
<colspec colname="c1" colwidth="15*" align="center" />
<colspec colname="c2" colwidth="30*" align="center" />
<colspec colname="c3" colwidth="55*" align="center" />
<thead>
<row>
<entry>
@ -877,7 +874,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>2.7</para>
@ -954,11 +951,10 @@
<xref linkend="dbdoclet.50569332_68052" />.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_68052">
<title>Argument Call Buffer
<emphasis>ibm,reset-pe-dma-windows</emphasis></title>
<title><emphasis>ibm,reset-pe-dma-windows</emphasis> Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
@ -972,14 +968,14 @@
<emphasis role="bold">Name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Values</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="5" valign="middle">
<para>In</para>

124
LoPAR/sec_rtas_env_epow.xml
Unescape Escape View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
@ -13,16 +13,16 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<section xmlns="http://docbook.org/ns/docbook"
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="dbdoclet.50569337_17513">

<title>Environmental and Power Warnings</title>

<para>Environmental and Power Warnings (EPOW) is an option that provides
a means for the platform to inform the OS of these types of events. The
intent is to enable the OS to provide basic information to the user about
@ -32,86 +32,86 @@
the loss of power. Even on platforms that provide hardware protection of
data during environmental events, EPOW notification allows discrimination
between I/O errors caused by hardware failures versus EPOW events.</para>

<para>These warnings include action codes that the platform can use to
influence the OS behavior when various hardware components fail. For
example, a fan failure where the system can continue to operate in the
safe cooling range may just generate an action code of WARN_COOLING, but
a fan failure where the system cannot operate in the safe cooling range
may generate an action code of SYSTEM_HALT.</para>

<para><emphasis role="bold">Implementation Note:</emphasis> Hardware cannot assume that the OS will
process or take action on these warnings. These warnings are only
provided to the OS in order to allow the OS a chance to cleanly abort
operations in progress at the time of the warning. Hardware still assumes
responsibility for preventing hardware damage due to environmental or
power problems.</para>
<para>An OS that wants to be EPOW-aware will look for the

<para>An OS that wants to be EPOW-aware will look for the
<emphasis>epow-events</emphasis> node in the OF device tree, enable the
interrupts listed in its
interrupts listed in its
<literal>&#8220;interrupts&#8221;</literal> property, and provide an
interrupt handler to call
interrupt handler to call
<emphasis>check-exception</emphasis> when one of those interrupts are
received.</para>
<para>When an EPOW event occurs, whether reported by
<emphasis>check-exception</emphasis> or

<para>When an EPOW event occurs, whether reported by
<emphasis>check-exception</emphasis> or
<emphasis>event-scan</emphasis>, RTAS will directly pass back the EPOW
sensor value as part of the Extended Error Log format as described in
sensor value as part of the Extended Error Log format as described in
<xref linkend="dbdoclet.50569337_39498"/>, assuming the extended log is
requested. Doing so avoids the need for the OS to make an extra RTAS call
to obtain the sensor value. For critical power problems, the
to obtain the sensor value. For critical power problems, the
<emphasis>check-exception</emphasis> function is used to immediately
report changes of state to the OS, while the
report changes of state to the OS, while the
<emphasis>get-sensor-state</emphasis> function allows the OS to monitor
the condition (for example, loss of AC power) to see if the problem
corrects itself.</para>

<variablelist>

<varlistentry>
<term><emphasis role="bold">R1-<xref linkend="dbdoclet.50569337_17513"
<term><emphasis role="bold">R1-<xref linkend="dbdoclet.50569337_17513"
xrefstyle="select: labelnumber nopage"/>-1.</emphasis></term>
<listitem>
<para> If the platform supports Environmental and
Power Warnings by including a EPOW device tree entry, then the platform
must support the EPOW sensor for the
must support the EPOW sensor for the
<emphasis>get-sensor-state</emphasis> RTAS function.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><emphasis role="bold">R1-<xref linkend="dbdoclet.50569337_17513"
<term><emphasis role="bold">R1-<xref linkend="dbdoclet.50569337_17513"
xrefstyle="select: labelnumber nopage"/>-2.</emphasis></term>
<listitem>
<para> The EPOW sensor, if provided, must contain
the EPOW action code (defined in
the EPOW action code (defined in
<xref linkend="dbdoclet.50569337_45557"/>) in the least significant 4
bits. In cases where multiple EPOW actions are required, the action code
with the highest numerical value (where 0 is lowest and 7 is highest)
must be presented to the OS. The platform may implement any subset of
these action codes, but must operate as described in
these action codes, but must operate as described in
<xref linkend="dbdoclet.50569337_45557"/> for those it does implement.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><emphasis role="bold">R1-<xref linkend="dbdoclet.50569337_17513"
<term><emphasis role="bold">R1-<xref linkend="dbdoclet.50569337_17513"
xrefstyle="select: labelnumber nopage"/>-3.</emphasis></term>
<listitem>
<para>To ensure adequate response time,
platforms which implement the EPOW_MAIN_ENCLOSURE or EPOW_POWER_OFF
action codes must do so via interrupt and
<emphasis>check-exception</emphasis> notification, rather than by
<emphasis>event-scan</emphasis> notification.
<emphasis>(Except as modified by Requirement
action codes must do so via interrupt and
<emphasis>check-exception</emphasis> notification, rather than by
<emphasis>event-scan</emphasis> notification.
<emphasis>(Except as modified by Requirement
<xref linkend="dbdoclet.50569337_83439"/>)</emphasis></para>
</listitem>
</varlistentry>

<varlistentry xml:id="dbdoclet.50569337_83439">
<term><emphasis role="bold">R1-<xref linkend="dbdoclet.50569337_17513"
<term><emphasis role="bold">R1-<xref linkend="dbdoclet.50569337_17513"
xrefstyle="select: labelnumber nopage"/>-4.</emphasis></term>
<listitem>
<para>If the platform
@ -120,54 +120,54 @@
to the EPOW event.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><emphasis role="bold">R1-<xref linkend="dbdoclet.50569337_17513"
<term><emphasis role="bold">R1-<xref linkend="dbdoclet.50569337_17513"
xrefstyle="select: labelnumber nopage"/>-5.</emphasis></term>
<listitem>
<para>For interrupt-driven EPOW events, the
platform must ensure that an EPOW interrupt is not lost in the case where
a numerically higher-priority EPOW event occurs between the time when
a numerically higher-priority EPOW event occurs between the time when
<emphasis>check-exception</emphasis> gathers the sensor value and when it
resets the interrupt.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><emphasis role="bold">R1-<xref linkend="dbdoclet.50569337_17513"
<term><emphasis role="bold">R1-<xref linkend="dbdoclet.50569337_17513"
xrefstyle="select: labelnumber nopage"/>-6.</emphasis></term>
<listitem>
<para>For SYSTEM_SHUTDOWN EPOW class 3, after a
SYSTEM_SHUTDOWN EPOW commences and when the delay interval timer expires,
if an
if an
<emphasis role="bold"><literal>&#8220;ibm,recoverable-epow3&#8221;</literal></emphasis>
encode-null
property in the
property in the
<emphasis role="bold"><literal>/rtas</literal></emphasis> node is present, then the OS code that manages
preserving storage must check the EPOW sensor state and the
preserving storage must check the EPOW sensor state and the
<emphasis role="bold"><literal>&#8220;ibm,request-partition-shutdown&#8221;</literal></emphasis>
property if present. A normal boot must only occur when the EPOW sensor state
indicates that the EPOW condition requiring a shutdown no longer exists
(EPOW 0) and the
<emphasis role="bold"><literal>&#8220;ibm,request-partition-shutdown&#8221;</literal></emphasis>
(EPOW 0) and the
<emphasis role="bold"><literal>&#8220;ibm,request-partition-shutdown&#8221;</literal></emphasis>
is not present. Otherwise, the code that manages preserving storage must take
the action as identified by the property.</para>
</listitem>
</varlistentry>

</variablelist>

<para><emphasis role="bold">Implementation Note:</emphasis> One way for hardware to prevent the loss of an
EPOW interrupt is by deferring the generation of a new EPOW interrupt
until the existing EPOW interrupt is reset by a call to the RTAS
until the existing EPOW interrupt is reset by a call to the RTAS
<emphasis>check-exception</emphasis> function. Another way is to ignore
resets to the interrupt until all EPOW events have been reported.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569337_45557">
<title>EPOW Action Codes</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="30*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="30*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="60*" />
<thead>
<row>
@ -181,14 +181,14 @@
<emphasis role="bold">Value</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Description</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>EPOW_RESET/MESSAGE</para>
@ -289,32 +289,32 @@
</tbody>
</tgroup>
</table>

<para><emphasis role="bold">Software Implementation Note:</emphasis> A recommended OS processing method
for an EPOW_MAIN_ENCLOSURE event is as follows:</para>

<itemizedlist>
<listitem>

<para>Prepare for shutdown, mask the EPOW interrupt, and wait for 50
milliseconds. Then call get-sensor-state to read the EPOW sensor.</para>

</listitem>
<listitem>

<para>If the EPOW action code is unchanged, wait an additional 50
milliseconds.</para>

</listitem>
<listitem>

<para>If the action code is EPOW_POWER_OFF, attempt to power off.
Otherwise, the power condition may have stabilized, so interrupts may be
enabled and normal operation resumed.</para>

</listitem>
</itemizedlist>

<para>
<emphasis role="bold">Implementation Note:</emphasis> EPOW_RESET (EPOW action code 0)
may be used to indicate that a previously reported EPOW condition is no
@ -324,7 +324,7 @@
error log that specified the type of WARN_POWER EPOW generated would be
set in the EPOW_RESET error log to indicate the specific EPOW event that
was reset.</para>

<para>Systems that do not support an EPOW interrupt would generally be
unable to support the EPOW action codes 5 and 7. In those cases, there
could not be an EPOW event to indicate a loss of power. However, after
@ -332,5 +332,5 @@
the system had lost power previously and the power had been restored. The
EPOW_RESET should only be used in this way if the system is unable to
generate an EPOW class 5 or class 7.</para>

</section>

410
LoPAR/sec_rtas_environment.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -308,9 +308,9 @@
<title>Use of
<emphasis role="bold"><literal>&#8220;used-by-rtas&#8221;</literal></emphasis></title>
<tgroup cols="3">
<colspec colname="c1" colwidth="33*" />
<colspec colname="c2" colwidth="33*" />
<colspec colname="c3" colwidth="33*" />
<colspec colname="c1" colwidth="33*" align="center" />
<colspec colname="c2" colwidth="33*" align="center" />
<colspec colname="c3" colwidth="33*" align="center" />
<thead>
<row>
<entry>
@ -330,7 +330,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Only used by OS</para>
@ -663,8 +663,8 @@
<emphasis role="bold"><literal>instantiate-rtas-64</literal></emphasis>
Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
@ -673,7 +673,7 @@
<emphasis role="bold">Parameter Type</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Name</emphasis>
</para>
@ -685,7 +685,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>In</para>
@ -774,8 +774,8 @@
<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_20008">
<title>RTAS Tokens for Functions</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="33*" />
<colspec colname="c2" colwidth="33*" />
<colspec colname="c1" colwidth="33*" align="center" />
<colspec colname="c2" colwidth="33*" align="center" />
<colspec colname="c3" colwidth="33*" />
<thead>
<row>
@ -789,21 +789,19 @@
<emphasis role="bold">Required?</emphasis>
</para>
</entry>
<entry>
<entry align="center" >
<para>
<emphasis role="bold">Notes</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;nvram-fetch&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_96529" />
<emphasis role="bold"><literal>&#8220;nvram-fetch&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_96529" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -816,10 +814,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;nvram-store&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_57392" />
<emphasis role="bold"><literal>&#8220;nvram-store&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_57392" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -832,10 +828,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;get-time-of-day&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_88127" />
<emphasis role="bold"><literal>&#8220;get-time-of-day&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_88127" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -848,10 +842,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;set-time-of-day&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_35194" />
<emphasis role="bold"><literal>&#8220;set-time-of-day&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_35194" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -864,10 +856,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;set-time-for-power-on&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_13743" />
<emphasis role="bold"><literal>&#8220;set-time-for-power-on&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_13743" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -880,10 +870,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;event-scan&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_24845" />
<emphasis role="bold"><literal>&#8220;event-scan&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_24845" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -896,10 +884,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;check-exception&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_71287" />
<emphasis role="bold"><literal>&#8220;check-exception&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_71287" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -912,10 +898,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;rtas-last-error&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_71223" />
<emphasis role="bold"><literal>&#8220;rtas-last-error&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_71223" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -928,10 +912,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,platform-dump&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_98203" />
<emphasis role="bold"><literal>&#8220;ibm,platform-dump&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_98203" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -944,10 +926,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,read-pci-config&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_59536" />
<emphasis role="bold"><literal>&#8220;ibm,read-pci-config&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_59536" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry morerows="1">
@ -960,20 +940,16 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,write-pci-config&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_54555" />
<emphasis role="bold"><literal>&#8220;ibm,write-pci-config&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_54555" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;display-character&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_10053" />
<emphasis role="bold"><literal>&#8220;display-character&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_10053" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -986,10 +962,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;set-indicator&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_32164" />
<emphasis role="bold"><literal>&#8220;set-indicator&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_32164" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1003,10 +977,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;get-sensor-state&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_10754" />
<emphasis role="bold"><literal>&#8220;get-sensor-state&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_10754" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1019,10 +991,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,set-system-parameter&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_31665" />
<emphasis role="bold"><literal>&#8220;ibm,set-system-parameter&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_31665" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1035,10 +1005,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,get-system-parameter&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_62190" />
<emphasis role="bold"><literal>&#8220;ibm,get-system-parameter&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_62190" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1051,10 +1019,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;set-power-level&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_45884" />
<emphasis role="bold"><literal>&#8220;set-power-level&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_45884" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry morerows="1">
@ -1068,10 +1034,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;get-power-level&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_67298" />
<emphasis role="bold"><literal>&#8220;get-power-level&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_67298" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1081,10 +1045,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;power-off&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_79728" />
<emphasis role="bold"><literal>&#8220;power-off&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_79728" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1098,10 +1060,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,power-off-ups&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_50770" />
<emphasis role="bold"><literal>&#8220;ibm,power-off-ups&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_50770" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1115,10 +1075,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;system-reboot&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_50284" />
<emphasis role="bold"><literal>&#8220;system-reboot&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_50284" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1131,10 +1089,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,update-flash-64-and-reboot&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_77103" />
<emphasis role="bold"><literal>&#8220;ibm,update-flash-64-and-reboot&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_77103" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1147,10 +1103,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,manage-flash-image&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_81833" />
<emphasis role="bold"><literal>&#8220;ibm,manage-flash-image&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_81833" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1163,10 +1117,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,validate-flash-image&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_40640" />
<emphasis role="bold"><literal>&#8220;ibm,validate-flash-image&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_40640" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1179,10 +1131,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,activate-firmware&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_28163" />
<emphasis role="bold"><literal>&#8220;ibm,activate-firmware&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_28163" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1195,10 +1145,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;stop-self&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_68497" />
<emphasis role="bold"><literal>&#8220;stop-self&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_68497" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry morerows="2">
@ -1211,10 +1159,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;start-cpu&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_39014" />
<emphasis role="bold"><literal>&#8220;start-cpu&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_39014" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1224,10 +1170,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;query-cpu-stopped-state&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_81575" />
<emphasis role="bold"><literal>&#8220;query-cpu-stopped-state&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_81575" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1237,10 +1181,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,os-term&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_42118" />
<emphasis role="bold"><literal>&#8220;ibm,os-term&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_42118" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1253,10 +1195,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,exti2c&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_19739" />
<emphasis role="bold"><literal>&#8220;ibm,exti2c&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_19739" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1269,10 +1209,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,get-xive&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_48295" />
<emphasis role="bold"><literal>&#8220;ibm,get-xive&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_48295" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry morerows="3">
@ -1285,10 +1223,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,set-xive&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_13631" />
<emphasis role="bold"><literal>&#8220;ibm,set-xive&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_13631" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1298,10 +1234,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,int-off&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_95487" />
<emphasis role="bold"><literal>&#8220;ibm,int-off&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_95487" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1311,10 +1245,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,int-on&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_61000" />
<emphasis role="bold"><literal>&#8220;ibm,int-on&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_61000" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1324,10 +1256,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,configure-connector&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569342_39636" />
<emphasis role="bold"><literal>&#8220;ibm,configure-connector&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569342_39636" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1341,10 +1271,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,set-eeh-option&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_27269" />
<emphasis role="bold"><literal>&#8220;ibm,set-eeh-option&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_27269" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry morerows="1">
@ -1357,10 +1285,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,set-slot-reset&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_86249" />
<emphasis role="bold"><literal>&#8220;ibm,set-slot-reset&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_86249" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1387,10 +1313,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,read-slot-reset-state2&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_87326" />
<emphasis role="bold"><literal>&#8220;ibm,read-slot-reset-state2&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_87326" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1403,10 +1327,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,get-config-addr-info2&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_68098" />
<emphasis role="bold"><literal>&#8220;ibm,get-config-addr-info2&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_68098" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1419,10 +1341,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,slot-error-detail&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_43482" />
<emphasis role="bold"><literal>&#8220;ibm,slot-error-detail&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_43482" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1435,10 +1355,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,open-errinjct&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_22302" />
<emphasis role="bold"><literal>&#8220;ibm,open-errinjct&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_22302" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry morerows="2">
@ -1451,10 +1369,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,errinjct&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_22302" />
<emphasis role="bold"><literal>&#8220;ibm,errinjct&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_22302" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1464,10 +1380,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,close-errinjct&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_22302" />
<emphasis role="bold"><literal>&#8220;ibm,close-errinjct&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_22302" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1477,10 +1391,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,nmi-register&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_12478" />
<emphasis role="bold"><literal>&#8220;ibm,nmi-register&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_12478" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry morerows="1">
@ -1493,10 +1405,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,nmi-interlock&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_12478" />
<emphasis role="bold"><literal>&#8220;ibm,nmi-interlock&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_12478" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1506,10 +1416,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,configure-bridge&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_65423" />
<emphasis role="bold"><literal>&#8220;ibm,configure-bridge&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_65423" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1522,10 +1430,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,configure-pe&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_45262" />
<emphasis role="bold"><literal>&#8220;ibm,configure-pe&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_45262" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1538,10 +1444,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,get-indices&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="sec_get_indices_rtas_call" />
<emphasis role="bold"><literal>&#8220;ibm,get-indices&#8221;</literal></emphasis><?linebreak?>
<xref linkend="sec_get_indices_rtas_call" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1555,10 +1459,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,get-vpd&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_72964" />
<emphasis role="bold"><literal>&#8220;ibm,get-vpd&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_72964" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1571,10 +1473,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,manage-storage-preservation&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_28221" />
<emphasis role="bold"><literal>&#8220;ibm,manage-storage-preservation&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_28221" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1587,10 +1487,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,get-dynamic-sensor-state&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_61055" />
<emphasis role="bold"><literal>&#8220;ibm,get-dynamic-sensor-state&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_61055" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1604,10 +1502,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,set-dynamic-indicator&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_30542" />
<emphasis role="bold"><literal>&#8220;ibm,set-dynamic-indicator&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_30542" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1621,10 +1517,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,change-msi&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_16274" />
<emphasis role="bold"><literal>&#8220;ibm,change-msi&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_16274" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1638,10 +1532,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,suspend-me&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_45918" />
<emphasis role="bold"><literal>&#8220;ibm,suspend-me&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_45918" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1654,10 +1546,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,update-nodes&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_84414" />
<emphasis role="bold"><literal>&#8220;ibm,update-nodes&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_84414" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1670,10 +1560,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,update-properties&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_40069" />
<emphasis role="bold"><literal>&#8220;ibm,update-properties&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_40069" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1686,10 +1574,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,configure-kernel-dump&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_67111" />
<emphasis role="bold"><literal>&#8220;ibm,configure-kernel-dump&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_67111" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1703,10 +1589,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,query-pe-dma-window&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_99826" />
<emphasis role="bold"><literal>&#8220;ibm,query-pe-dma-window&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_99826" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry morerows="2">
@ -1719,10 +1603,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,create-pe-dma-window&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_49009" />
<emphasis role="bold"><literal>&#8220;ibm,create-pe-dma-window&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_49009" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1732,10 +1614,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,remove-pe-dma-window&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_60545" />
<emphasis role="bold"><literal>&#8220;ibm,remove-pe-dma-window&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_60545" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1745,10 +1625,8 @@
<row>
<entry>
<para>
<emphasis role="bold"><literal>&#8220;ibm,reset-pe-dma-windows&#8221;</literal></emphasis>
</para>
<para>
<xref linkend="dbdoclet.50569332_60545" />
<emphasis role="bold"><literal>&#8220;ibm,reset-pe-dma-windows&#8221;</literal></emphasis><?linebreak?>
<xref linkend="dbdoclet.50569332_60545" xrefstyle="select: labelnumber pagenumber" />
</para>
</entry>
<entry>
@ -1787,7 +1665,7 @@
<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_38140">
<title>OF Device Tree Properties</title>
<tgroup cols="2">
<colspec colname="c1" colwidth="50*" />
<colspec colname="c1" colwidth="50*" align="center" />
<colspec colname="c2" colwidth="50*" />
<thead>
<row>
@ -1796,14 +1674,14 @@
<emphasis role="bold">name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">value</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>
@ -2189,7 +2067,7 @@
<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_22280">
<title>RTAS Argument Call Buffer</title>
<tgroup cols="2">
<colspec colname="c1" colwidth="50*" />
<colspec colname="c1" colwidth="50*" align="center" />
<colspec colname="c2" colwidth="50*" />
<thead>
<row>
@ -2198,14 +2076,14 @@
<emphasis role="bold">Cell Number</emphasis>
</para>
</entry>
<entry>
<entry align="center" >
<para>
<emphasis role="bold">Use</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>1</para>
@ -2407,7 +2285,7 @@
<title>RTAS
<emphasis>Status</emphasis> Word Values</title>
<tgroup cols="2">
<colspec colname="c1" colwidth="50*" />
<colspec colname="c1" colwidth="50*" align="center" />
<colspec colname="c2" colwidth="50*" />
<thead>
<row>
@ -2416,7 +2294,7 @@
<emphasis role="bold">Values</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">
<emphasis>Status</emphasis> Word Meanings</emphasis>
@ -2424,7 +2302,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0</para>

10
LoPAR/sec_rtas_error_classes.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -49,9 +49,9 @@
<?dbhtml table-width="75%" ?>
<?dbfo table-width="75%" ?>
<tgroup cols="3">
<colspec colname="c1" colwidth="40*" />
<colspec colname="c2" colwidth="40*" />
<colspec colname="c3" colwidth="20*" />
<colspec colname="c1" colwidth="40*" align="center" />
<colspec colname="c2" colwidth="40*" align="center" />
<colspec colname="c3" colwidth="20*" align="center" />
<thead>
<row>
<entry>
@ -74,7 +74,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Internal Errors</para>

112
LoPAR/sec_rtas_error_indications.xml
Unescape Escape View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
@ -13,21 +13,21 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<section xmlns="http://docbook.org/ns/docbook"
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="Internal_Error_Indications">

<title>Internal Error Indications</title>

<para>Hardware may detect a variety of problems during operation, ranging
from soft errors which have already been corrected by the time they are
reported, to hard errors of such severity that the OS (and perhaps the
hardware) cannot meaningfully continue operation. The mechanisms
described in
described in
<xref linkend="dbdoclet.50569337_66258"/> are used to report such errors to the
OS. This section describes the architectural sources of errors, and
describes a method that platforms can use to report the error. All OSs
@ -36,7 +36,7 @@
may be introduced via RTAS, and the OS may not have to handle the error
directly. More robust error detection, reporting, and correcting are at
the option of the hardware vendor.</para>

<para>
<anchor xml:id="dbdoclet.50569337_marker-13885" xreflabel="" />
<anchor xml:id="dbdoclet.50569337_marker-13886" xreflabel="" />The
@ -51,12 +51,12 @@
handle such cases, a special hardware mechanism may be provided to gather
and store residual error data, to be analyzed when the system goes
through a subsequent successful reboot.</para>

<para>Less critical internal errors may also be signaled to the OS
through a platform-specific interrupt in the &#8220;Internal
Errors&#8221; class, or by periodic polling with the
Errors&#8221; class, or by periodic polling with the
<emphasis>event-scan</emphasis> RTAS function.</para>

<para><emphasis role="bold">Architecture Note:</emphasis> The machine check interrupt will not be listed
in the OF node for the &#8220;Internal Errors&#8221; class, since it is a
standard architectural mechanism. The machine check interrupt mechanism
@ -69,55 +69,55 @@
connection to the processor machine check interrupt pin, or via a system
bus error indicator (for example, Transfer Error Acknowledge -
TEA).</para>

<variablelist>

<varlistentry xml:id="dbdoclet.50569337_38528">
<term><emphasis role="bold">R1-<xref linkend="Internal_Error_Indications"
<term><emphasis role="bold">R1-<xref linkend="Internal_Error_Indications"
xrefstyle="select: labelnumber nopage"/>-1.</emphasis></term>
<listitem>
<para>OSs must set
MSRME=1 prior to the occurrence of a machine check interrupt in order to
enable machine check processing via the
<emphasis>check-exception</emphasis> RTAS function.</para>

<para>
<emphasis role="bold">Architecture Note:</emphasis> Requirement
<emphasis role="bold">Architecture Note:</emphasis> Requirement
<xref linkend="dbdoclet.50569337_38528"/> is not applicable when the FWNMI
option is used.</para>

</listitem>
</varlistentry>

<varlistentry xml:id="dbdoclet.50569337_36603">
<term><emphasis role="bold">R1-<xref linkend="Internal_Error_Indications"
<term><emphasis role="bold">R1-<xref linkend="Internal_Error_Indications"
xrefstyle="select: labelnumber nopage"/>-2.</emphasis></term>
<listitem>
<para>For
hardware-detected errors, platforms must generate error indications as
described in
described in
<xref linkend="dbdoclet.50569337_30773"/>, unless the error can be handled
through a less severe platform-specific interrupt, or the nature of the
error forces a checkstop condition.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><emphasis role="bold">R1-<xref linkend="Internal_Error_Indications"
<term><emphasis role="bold">R1-<xref linkend="Internal_Error_Indications"
xrefstyle="select: labelnumber nopage"/>-3.</emphasis></term>
<listitem>
<para>Platforms which detect and report the
errors described in
errors described in
<xref linkend="dbdoclet.50569337_30773"/> must provide information to the OS
via the RTAS
via the RTAS
<emphasis>check-exception</emphasis> function, using the reporting format
described in
described in
<xref linkend="dbdoclet.50569337_21249"/>.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="dbdoclet.50569337_16228">
<term><emphasis role="bold">R1-<xref linkend="Internal_Error_Indications"
<term><emphasis role="bold">R1-<xref linkend="Internal_Error_Indications"
xrefstyle="select: labelnumber nopage"/>-4.</emphasis></term>
<listitem>
<para>To prevent error
@ -126,7 +126,7 @@
interrupt signaled via the external machine check interrupt pin.</para>
</listitem>
</varlistentry>

</variablelist>

<para>
@ -135,8 +135,8 @@

<orderedlist>
<listitem>
<para>The intent of Requirement

<para>The intent of Requirement
<xref linkend="dbdoclet.50569337_36603"/> is to define standard error
notification mechanisms for different hardware error types. For most
hardware errors, the signaling mechanism is the machine check interrupt,
@ -156,15 +156,15 @@
summarize, platforms should not use platform-specific interrupts to
signal hardware errors unless there is a complete hardware/RTAS platform
solution for handling such errors.</para>

</listitem>
<listitem>

<para>The intent of Requirement
<para>The intent of Requirement
<xref linkend="dbdoclet.50569337_16228"/> is that most hardware errors would be
signaled simultaneously to all processors, so that processors could
synchronize the error handling process; that is, one processor would be
chosen to do the call to
chosen to do the call to
<emphasis>check-exception</emphasis>, while the other processors remained
idle so that they would not interfere with RTAS while it gathered machine
check error data. While this is a straightforward wiring solution for
@ -178,13 +178,13 @@
such propagation should be avoided, and such errors should be signaled
through the machine check interrupt pin to ensure proper error
handling.</para>

</listitem>
</orderedlist>

<section xml:id="dbdoclet.50569337_52952">
<title>Error Indication Mechanisms</title>

<para>
<xref linkend="dbdoclet.50569337_30773"/> describes the mechanisms by
which software will be notified of the occurrence of operational failures
@ -198,12 +198,12 @@
<table frame="all" pgwide="1" xml:id="dbdoclet.50569337_30773">
<title>Error Indications for System Operations</title>
<tgroup cols="6">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c3" colwidth="20*" />
<colspec colname="c4" colwidth="20*" />
<colspec colname="c5" colwidth="20*" />
<colspec colname="c6" colwidth="20*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="20*" align="center" />
<colspec colname="c4" colwidth="20*" align="center" />
<colspec colname="c5" colwidth="20*" align="center" />
<colspec colname="c6" colwidth="20*" align="center" />
<thead>
<row>
<entry>
@ -238,7 +238,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Processor</para>
@ -451,7 +451,7 @@
</entry>
<entry>
<para>Firmware receives a machine check, OS receives
all=1&#8217;s data along with a
all=1&#8217;s data along with a
<emphasis>Status</emphasis> of -1 from the RTAS call</para>
</entry>
<entry>
@ -466,7 +466,7 @@
</entry>
<entry>
<para>All-1&#8217;s data returned, along with a
&#8220;Success&#8221;
&#8220;Success&#8221;
<emphasis>Status</emphasis> from the RTAS call</para>
</entry>
<entry>
@ -482,7 +482,7 @@
<para>Various, except no response from IOA</para>
</entry>
<entry>
<para>Firmware receives a machine check, OS receives a
<para>Firmware receives a machine check, OS receives a
<emphasis>Status</emphasis> of -1 from the RTAS call</para>
</entry>
<entry>
@ -496,7 +496,7 @@
<para>No response from an IOA</para>
</entry>
<entry>
<para>Operation ignored, OS receives a &#8220;Success&#8221;
<para>Operation ignored, OS receives a &#8220;Success&#8221;
<emphasis>Status</emphasis> from the RTAS call</para>
</entry>
<entry>
@ -603,21 +603,21 @@
</entry>
<entry>
<para>Various, including but not limited to:</para>
<itemizedlist>

<itemizedlist>
<listitem>
<para>Invalid addr accepted by a bridge</para>
</listitem>

<listitem>
<para>TCE extent</para>
</listitem>

<listitem>
<para>TCE Page Mapping and Control mis-match or invalid
TCE</para>
</listitem>
</itemizedlist>
</itemizedlist>

</entry>
<entry>
@ -696,7 +696,7 @@
</tbody>
</tgroup>
</table>

<para><emphasis role="bold">Implementation Note:</emphasis> IOAs should, whenever possible, detect the
occurrence of PCI errors on DMA and report them via an external interrupt
(for possible device driver recovery) or retry the operation. Since
@ -705,7 +705,7 @@
cause a catastrophic error. Systems which wish to recover from these
types of errors should choose devices and device drivers which are
designed to handle them correctly.</para>

</section>

</section>

2
LoPAR/sec_rtas_error_reporting.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

16
LoPAR/sec_rtas_error_reporting_introduction.xml
Unescape Escape View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
@ -13,16 +13,16 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="sec_rtas_error_reporting_intro">

<title>Introduction</title>

<para>This section describes the data formats used to report events and
errors from RTAS to the OS. A common format is used for errors and events
to simplify software both in RTAS and in the OS. Both errors and events
@ -36,5 +36,5 @@
mapping exists, and platform features may not be fully supported by the
OS. In such cases, error reports may also be non-specific, leaving
platform-specific details to platform-aware software.</para>
</section>

</section>

2
LoPAR/sec_rtas_error_reporting_location_codes.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

153
LoPAR/sec_rtas_error_reporting_return_format.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -311,10 +311,9 @@
indicated in decimal unless noted otherwise.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569337_21249">
<title>RTAS Event Return Format (Fixed Part)
<emphasis>(Continued)</emphasis></title>
<title>RTAS Event Return Format (Fixed Part)</title>
<tgroup cols="2">
<colspec colname="c1" colwidth="30*" />
<colspec colname="c1" colwidth="30*" align="center" />
<colspec colname="c2" colwidth="70*" />
<thead>
<row>
@ -324,7 +323,7 @@
number(s))</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Description, Values (Described in
<xref linkend="dbdoclet.50569337_75663"/>)</emphasis>
@ -332,7 +331,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Version (0:7)</para>
@ -664,8 +663,8 @@
<table frame="all" pgwide="1" xml:id="dbdoclet.50569337_85491">
<title>RTAS General Extended Event Log Format, Version 6</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -675,12 +674,12 @@
<entry>
<para><emphasis role="bold">Bit</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="7">
<para>0</para>
@ -861,8 +860,8 @@
<title>Overview of Platform Event Log Format, Version
6</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -872,12 +871,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>12-15</para>
@ -1076,8 +1075,8 @@
<title>Platform Event Log Format, Version 6, Main-A
Section</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -1087,12 +1086,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x00</para>
@ -1288,8 +1287,8 @@
<title>Platform Event Log Format, Version 6, Main-B
Section</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -1299,12 +1298,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x00</para>
@ -1897,8 +1896,8 @@
<title>Platform Event Log Format, Version 6, Logical
Resource Identification Section</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -1908,12 +1907,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x00</para>
@ -2052,8 +2051,8 @@
<title>Platform Event Log Format, Version 6, Primary SRC
Section</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -2063,12 +2062,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x00</para>
@ -2357,8 +2356,8 @@
<title>Platform Event Log Format, Version 6, FRU Call-out
Structure</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -2368,12 +2367,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x00</para>
@ -2747,8 +2746,8 @@
<title>Platform Event Log Format, Version 6, Dump Locator
Section</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -2758,12 +2757,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x00</para>
@ -2928,8 +2927,8 @@
<title>Platform Event Log Format, Version 6, EPOW
Section</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -2939,12 +2938,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x00</para>
@ -3089,8 +3088,8 @@
<title>Platform Event Log Format, Version 6, IO Events
Section</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -3100,12 +3099,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x00</para>
@ -3287,8 +3286,8 @@
<title>Platform Event Log Format, Version 6, Failing
Enclosure MTMS</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -3298,12 +3297,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x00</para>
@ -3432,12 +3431,12 @@
<title>Platform Event Log Format, Version 6, Impacted
Partitions</title>
<tgroup cols="6">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c3" colwidth="20*" />
<colspec colname="c4" colwidth="20*" />
<colspec colname="c5" colwidth="20*" />
<colspec colname="c6" colwidth="20*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="20*" align="center" />
<colspec colname="c4" colwidth="20*" align="center" />
<colspec colname="c5" colwidth="20*" align="center" />
<colspec colname="c6" colwidth="20*" align="center" />
<thead>
<row>
<entry>
@ -3460,7 +3459,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0</para>
@ -3584,8 +3583,8 @@
<title>Platform Error Event Log Format, Version 6, Failing
Memory Address</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -3595,12 +3594,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x00</para>
@ -3721,8 +3720,8 @@
<table frame="all" pgwide="1">
<title>UE Error Information</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -3732,12 +3731,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x11</para>
@ -3820,8 +3819,8 @@
<table frame="all" pgwide="1">
<title>SLB Error Information</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -3831,12 +3830,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x11</para>
@ -3902,8 +3901,8 @@
<table frame="all" pgwide="1">
<title>ERAT Error Information</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -3913,12 +3912,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x11</para>
@ -3984,8 +3983,8 @@
<table frame="all" pgwide="1">
<title>TLB Error Information</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="10*" />
<colspec colname="c2" colwidth="10*" />
<colspec colname="c1" colwidth="10*" align="center" />
<colspec colname="c2" colwidth="10*" align="center" />
<colspec colname="c3" colwidth="80*" />
<thead>
<row>
@ -3995,12 +3994,12 @@
<entry>
<para><emphasis role="bold">Length in Bytes</emphasis></para>
</entry>
<entry>
<entry align="center">
<para><emphasis role="bold">Description</emphasis></para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x11</para>

13
LoPAR/sec_rtas_get_dynamic_sensor_state.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -49,11 +49,10 @@
<xref linkend="dbdoclet.50569332_71500" />.</para>
<para>&#160;</para>
<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_71500">
<title>Argument Call Buffer
<emphasis>ibm,get-dynamic-sensor-state</emphasis></title>
<title><emphasis>ibm,get-dynamic-sensor-state</emphasis> Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
@ -67,14 +66,14 @@
<emphasis role="bold">Name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Values</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>In</para>

13
LoPAR/sec_rtas_get_indices.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -64,11 +64,10 @@
<xref linkend="dbdoclet.50569332_50675" />.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_50675">
<title>Argument Call Buffer
<emphasis>ibm,get-indices</emphasis></title>
<title><emphasis>ibm,get-indices</emphasis> Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
@ -82,14 +81,14 @@
<emphasis role="bold">Name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Values</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="7" valign="middle">
<para>In</para>

13
LoPAR/sec_rtas_get_vpd.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -54,11 +54,10 @@
<xref linkend="dbdoclet.50569332_62393" />.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_62393">
<title>Argument Call Buffer
<emphasis>ibm,get-vpd</emphasis></title>
<title><emphasis>ibm,get-vpd</emphasis> Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
@ -72,14 +71,14 @@
<emphasis role="bold">Name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Values</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="6" valign="middle">
<para>In</para>

2
LoPAR/sec_rtas_hot_plug.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

2
LoPAR/sec_rtas_introduction.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

13
LoPAR/sec_rtas_lpar_perftools.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -49,11 +49,10 @@
<xref linkend="dbdoclet.50569332_48993" />.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_48993">
<title>Argument Call Buffer
<emphasis>ibm,lpar-perftools</emphasis></title>
<title><emphasis>ibm,lpar-perftools</emphasis> Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
@ -67,14 +66,14 @@
<emphasis role="bold">Name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Values</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="7" valign="middle">
<para>In</para>

12
LoPAR/sec_rtas_manage_storage_preservation.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -42,9 +42,9 @@
<title><emphasis>ibm,manage-storage-preservation</emphasis> Argument Call
Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="33*" />
<colspec colname="c2" colwidth="33*" />
<colspec colname="c3" colwidth="33*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
<entry>
@ -57,14 +57,14 @@
<emphasis role="bold">Name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Values</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="5" valign="middle">
<para>In</para>

13
LoPAR/sec_rtas_set_dynamic_indicator.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -50,11 +50,10 @@
<xref linkend="dbdoclet.50569332_14870" />.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_14870">
<title>Argument Call Buffer
<emphasis>ibm,set-dynamic-indicator</emphasis></title>
<title><emphasis>ibm,set-dynamic-indicator</emphasis> Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
@ -70,14 +69,14 @@
</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Values</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="5" valign="middle">
<para>In</para>

21
LoPAR/sec_rtas_suspend_me.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -78,11 +78,10 @@
<xref linkend="dbdoclet.50569332_91600" />.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_91600">
<title>Argument Call Buffer
<emphasis>ibm,suspend-me</emphasis></title>
<title><emphasis>ibm,suspend-me</emphasis> Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
@ -96,14 +95,14 @@
<emphasis role="bold">Name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Values</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="2" valign="middle">
<para>In</para>
@ -379,9 +378,9 @@
<title>System Parameters that May Change During Partition
Migration and Hibernation</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="33*" />
<colspec colname="c2" colwidth="33*" />
<colspec colname="c3" colwidth="33*" />
<colspec colname="c1" colwidth="33*" align="center" />
<colspec colname="c2" colwidth="33*" align="center" />
<colspec colname="c3" colwidth="33*" align="center" />
<thead>
<row>
<entry>
@ -401,7 +400,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0-15</para>

29
LoPAR/sec_rtas_update_nodes.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -110,11 +110,10 @@
<xref linkend="dbdoclet.50569332_55185" />.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_55185">
<title>Argument Call Buffer
<emphasis>ibm,update-nodes</emphasis></title>
<title><emphasis>ibm,update-nodes</emphasis> Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
@ -128,14 +127,14 @@
<emphasis role="bold">Name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Values</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="4" valign="middle">
<para>In</para>
@ -248,7 +247,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>12 bytes of 0x00 (reserved)</para>
@ -281,7 +280,7 @@
<emphasis>ibm,update-nodes</emphasis></title>
<tgroup cols="1">
<colspec colname="c1" colwidth="100*" align="center" />
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>State Variable (4 Bytes)</para>
@ -463,7 +462,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Don&#8217;t Care . . .</para>
@ -515,7 +514,7 @@
<emphasis>ibm,update-nodes</emphasis> with Device Reconfiguration Scope</title>
<tgroup cols="1">
<colspec colname="c1" colwidth="100*" align="center"/>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x00000000 (State Variable indicates Initial call for specified <emphasis>Scope</emphasis>)</para>
@ -549,9 +548,9 @@
<emphasis>ibm,update-nodes</emphasis> for a Given Value of the
&#8220;<emphasis>Scope</emphasis>&#8221; Argument</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="33*" />
<colspec colname="c2" colwidth="33*" />
<colspec colname="c3" colwidth="33*" />
<colspec colname="c1" colwidth="33*" align="center" />
<colspec colname="c2" colwidth="33*" align="center" />
<colspec colname="c3" colwidth="33*" align="center" />
<thead>
<row>
<entry>
@ -567,7 +566,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="7" valign="middle">
<para>Negative values: Platform Resource Reassignment events as

35
LoPAR/sec_rtas_update_properties.xml
Unescape Escape View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016 OpenPOWER Foundation
Copyright (c) 2016, 2020 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -75,11 +75,10 @@
<xref linkend="dbdoclet.50569332_63317" />.</para>

<table frame="all" pgwide="1" xml:id="dbdoclet.50569332_63317">
<title>Argument Call Buffer
<emphasis>ibm,update-properties</emphasis></title>
<title><emphasis>ibm,update-properties</emphasis> Argument Call Buffer</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="1*" />
<colspec colname="c2" colwidth="2*" />
<colspec colname="c1" colwidth="1*" align="center" />
<colspec colname="c2" colwidth="2*" align="center" />
<colspec colname="c3" colwidth="4*" />
<thead>
<row>
@ -93,14 +92,14 @@
<emphasis role="bold">Name</emphasis>
</para>
</entry>
<entry>
<entry align="center">
<para>
<emphasis role="bold">Values</emphasis>
</para>
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="4" valign="middle">
<para>In</para>
@ -204,7 +203,7 @@
<title>Initial Format of Work Area for
<emphasis>ibm,update-properties</emphasis></title>
<tgroup cols="1">
<colspec colname="c1" colwidth="100*" />
<colspec colname="c1" colwidth="100*" align="center" />
<thead>
<row>
<entry>
@ -214,7 +213,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>0x00000000 (Indicates Initial call for specified
@ -251,8 +250,8 @@
<title>Return Format of Work Area for
<emphasis>ibm,update-properties</emphasis></title>
<tgroup cols="2">
<colspec colname="c1" colwidth="50*" />
<colspec colname="c2" colwidth="50*" />
<colspec colname="c1" colwidth="50*" align="center" />
<colspec colname="c2" colwidth="50*" align="center" />
<thead>
<row>
<entry>
@ -265,7 +264,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>
@ -390,7 +389,7 @@
<title>Format of Work Area for Subsequent Calls to
<emphasis>ibm,update-properties</emphasis></title>
<tgroup cols="1">
<colspec colname="c1" colwidth="100*" />
<colspec colname="c1" colwidth="100*" align="center" />
<thead>
<row>
<entry>
@ -400,7 +399,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry>
<para>Value from last call to
@ -445,9 +444,9 @@
<emphasis>ibm,update-properties</emphasis> for a &#8220;
<emphasis>Scope</emphasis>&#8221;</title>
<tgroup cols="3">
<colspec colname="c1" colwidth="33*" />
<colspec colname="c2" colwidth="33*" />
<colspec colname="c3" colwidth="33*" />
<colspec colname="c1" colwidth="33*" align="center" />
<colspec colname="c2" colwidth="33*" align="center" />
<colspec colname="c3" colwidth="33*" align="center" />
<thead>
<row>
<entry>
@ -463,7 +462,7 @@
</entry>
</row>
</thead>
<tbody>
<tbody valign="middle" >
<row>
<entry morerows="6" valign="middle">
<para>All negative values: Resource Reassignment events as from

Write Preview
Loading…
Cancel
Save