€•æy      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ'/translations/zh_CN/misc-devices/ibmvmc”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ'/translations/zh_TW/misc-devices/ibmvmc”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ'/translations/it_IT/misc-devices/ibmvmc”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ'/translations/ja_JP/misc-devices/ibmvmc”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ'/translations/ko_KR/misc-devices/ibmvmc”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ'/translations/sp_SP/misc-devices/ibmvmc”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ!SPDX-License-Identifier: GPL-2.0+”h]”hŒ!SPDX-License-Identifier: GPL-2.0+”…””}”hh£sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1h¡hhhžhhŸŒA/var/lib/git/docbuild/linux/Documentation/misc-devices/ibmvmc.rst”h KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ5IBM Virtual Management Channel Kernel Driver (IBMVMC)”h]”hŒ5IBM Virtual Management Channel Kernel Driver (IBMVMC)”…””}”(hh»hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hh¶hžhhŸh³h KubhŒ
field_list”“”)”}”(hhh]”hŒfield”“”)”}”(hhh]”(hŒ
field_name”“”)”}”(hŒAuthors”h]”hŒAuthors”…””}”(hhÕhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÓhhÐhŸh³h K ubhŒ
field_body”“”)”}”(hŒ­Dave Engebretsen <engebret@us.ibm.com>,
Adam Reznechek <adreznec@linux.vnet.ibm.com>,
Steven Royer <seroyer@linux.vnet.ibm.com>,
Bryant G. Ly <bryantly@linux.vnet.ibm.com>,
”h]”hŒ	paragraph”“”)”}”(hŒ¬Dave Engebretsen <engebret@us.ibm.com>,
Adam Reznechek <adreznec@linux.vnet.ibm.com>,
Steven Royer <seroyer@linux.vnet.ibm.com>,
Bryant G. Ly <bryantly@linux.vnet.ibm.com>,”h]”(hŒDave Engebretsen <”…””}”(hhëhžhhŸNh NubhŒ	reference”“”)”}”(hŒengebret@us.ibm.com”h]”hŒengebret@us.ibm.com”…””}”(hhõhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œmailto:engebret@us.ibm.com”uh1hóhhëubhŒ>,
Adam Reznechek <”…””}”(hhëhžhhŸNh Nubhô)”}”(hŒadreznec@linux.vnet.ibm.com”h]”hŒadreznec@linux.vnet.ibm.com”…””}”(hj	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œ"mailto:adreznec@linux.vnet.ibm.com”uh1hóhhëubhŒ>,
Steven Royer <”…””}”(hhëhžhhŸNh Nubhô)”}”(hŒseroyer@linux.vnet.ibm.com”h]”hŒseroyer@linux.vnet.ibm.com”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œ!mailto:seroyer@linux.vnet.ibm.com”uh1hóhhëubhŒ>,
Bryant G. Ly <”…””}”(hhëhžhhŸNh Nubhô)”}”(hŒbryantly@linux.vnet.ibm.com”h]”hŒbryantly@linux.vnet.ibm.com”…””}”(hj1  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œ"mailto:bryantly@linux.vnet.ibm.com”uh1hóhhëubhŒ>,”…””}”(hhëhžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Khhåubah}”(h]”h ]”h"]”h$]”h&]”uh1hãhhÐubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÎhŸh³h KhhËhžhubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhh¶hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒIntroduction”h]”hŒIntroduction”…””}”(hj`  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj]  hžhhŸh³h Kubhê)”}”(hŒUNote: Knowledge of virtualization technology is required to understand
this document.”h]”hŒUNote: Knowledge of virtualization technology is required to understand
this document.”…””}”(hjn  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Khj]  hžhubhê)”}”(hŒ#A good reference document would be:”h]”hŒ#A good reference document would be:”…””}”(hj|  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Khj]  hžhubhê)”}”(hŒ`https://openpowerfoundation.org/wp-content/uploads/2016/05/LoPAPR_DRAFT_v11_24March2016_cmt1.pdf”h]”hô)”}”(hjŒ  h]”hŒ`https://openpowerfoundation.org/wp-content/uploads/2016/05/LoPAPR_DRAFT_v11_24March2016_cmt1.pdf”…””}”(hjŽ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”jŒ  uh1hóhjŠ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Khj]  hžhubhê)”}”(hXN  The Virtual Management Channel (VMC) is a logical device which provides an
interface between the hypervisor and a management partition. This interface
is like a message passing interface. This management partition is intended
to provide an alternative to systems that use a Hardware Management
Console (HMC) - based system management.”h]”hXN  The Virtual Management Channel (VMC) is a logical device which provides an
interface between the hypervisor and a management partition. This interface
is like a message passing interface. This management partition is intended
to provide an alternative to systems that use a Hardware Management
Console (HMC) - based system management.”…””}”(hj¢  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Khj]  hžhubhê)”}”(hX-  The primary hardware management solution that is developed by IBM relies
on an appliance server named the Hardware Management Console (HMC),
packaged as an external tower or rack-mounted personal computer. In a
Power Systems environment, a single HMC can manage multiple POWER
processor-based systems.”h]”hX-  The primary hardware management solution that is developed by IBM relies
on an appliance server named the Hardware Management Console (HMC),
packaged as an external tower or rack-mounted personal computer. In a
Power Systems environment, a single HMC can manage multiple POWER
processor-based systems.”…””}”(hj°  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Khj]  hžhubhµ)”}”(hhh]”(hº)”}”(hŒManagement Application”h]”hŒManagement Application”…””}”(hjÁ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj¾  hžhhŸh³h K$ubhê)”}”(hŒúIn the management partition, a management application exists which enables
a system administrator to configure the systemâ€™s partitioning
characteristics via a command line interface (CLI) or Representational
State Transfer Application (REST API's).”h]”hŒüIn the management partition, a management application exists which enables
a system administrator to configure the systemâ€™s partitioning
characteristics via a command line interface (CLI) or Representational
State Transfer Application (REST APIâ€™s).”…””}”(hjÏ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K&hj¾  hžhubhê)”}”(hX‚  The management application runs on a Linux logical partition on a
POWER8 or newer processor-based server that is virtualized by PowerVM.
System configuration, maintenance, and control functions which
traditionally require an HMC can be implemented in the management
application using a combination of HMC to hypervisor interfaces and
existing operating system methods. This tool provides a subset of the
functions implemented by the HMC and enables basic partition configuration.
The set of HMC to hypervisor messages supported by the management
application component are passed to the hypervisor over a VMC interface,
which is defined below.”h]”hX‚  The management application runs on a Linux logical partition on a
POWER8 or newer processor-based server that is virtualized by PowerVM.
System configuration, maintenance, and control functions which
traditionally require an HMC can be implemented in the management
application using a combination of HMC to hypervisor interfaces and
existing operating system methods. This tool provides a subset of the
functions implemented by the HMC and enables basic partition configuration.
The set of HMC to hypervisor messages supported by the management
application component are passed to the hypervisor over a VMC interface,
which is defined below.”…””}”(hjÝ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K+hj¾  hžhubhê)”}”(hŒQThe VMC enables the management partition to provide basic partitioning
functions:”h]”hŒQThe VMC enables the management partition to provide basic partitioning
functions:”…””}”(hjë  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K6hj¾  hžhubhŒbullet_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒ"Logical Partitioning Configuration”h]”hê)”}”(hj  h]”hŒ"Logical Partitioning Configuration”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K9hj   ubah}”(h]”h ]”h"]”h$]”h&]”uh1jþ  hjû  hžhhŸh³h Nubjÿ  )”}”(hŒ1Start, and stop actions for individual partitions”h]”hê)”}”(hj  h]”hŒ1Start, and stop actions for individual partitions”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K:hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jþ  hjû  hžhhŸh³h Nubjÿ  )”}”(hŒDisplay of partition status”h]”hê)”}”(hj0  h]”hŒDisplay of partition status”…””}”(hj2  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K;hj.  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jþ  hjû  hžhhŸh³h Nubjÿ  )”}”(hŒManagement of virtual Ethernet”h]”hê)”}”(hjG  h]”hŒManagement of virtual Ethernet”…””}”(hjI  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K<hjE  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jþ  hjû  hžhhŸh³h Nubjÿ  )”}”(hŒManagement of virtual Storage”h]”hê)”}”(hj^  h]”hŒManagement of virtual Storage”…””}”(hj`  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K=hj\  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jþ  hjû  hžhhŸh³h Nubjÿ  )”}”(hŒBasic system management
”h]”hê)”}”(hŒBasic system management”h]”hŒBasic system management”…””}”(hjw  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K>hjs  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jþ  hjû  hžhhŸh³h Nubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1jù  hŸh³h K9hj¾  hžhubeh}”(h]”Œmanagement-application”ah ]”h"]”Œmanagement application”ah$]”h&]”uh1h´hj]  hžhhŸh³h K$ubhµ)”}”(hhh]”(hº)”}”(hŒ Virtual Management Channel (VMC)”h]”hŒ Virtual Management Channel (VMC)”…””}”(hjž  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj›  hžhhŸh³h KAubhê)”}”(hX4  A logical device, called the Virtual Management Channel (VMC), is defined
for communicating between the management application and the hypervisor. It
basically creates the pipes that enable virtualization management
software. This device is presented to a designated management partition as
a virtual device.”h]”hX4  A logical device, called the Virtual Management Channel (VMC), is defined
for communicating between the management application and the hypervisor. It
basically creates the pipes that enable virtualization management
software. This device is presented to a designated management partition as
a virtual device.”…””}”(hj¬  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h KChj›  hžhubhê)”}”(hXA  This communication device uses Command/Response Queue (CRQ) and the
Remote Direct Memory Access (RDMA) interfaces. A three-way handshake is
defined that must take place to establish that both the hypervisor and
management partition sides of the channel are running prior to
sending/receiving any of the protocol messages.”h]”hXA  This communication device uses Command/Response Queue (CRQ) and the
Remote Direct Memory Access (RDMA) interfaces. A three-way handshake is
defined that must take place to establish that both the hypervisor and
management partition sides of the channel are running prior to
sending/receiving any of the protocol messages.”…””}”(hjº  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h KIhj›  hžhubhê)”}”(hX
  This driver also utilizes Transport Event CRQs. CRQ messages are sent
when the hypervisor detects one of the peer partitions has abnormally
terminated, or one side has called H_FREE_CRQ to close their CRQ.
Two new classes of CRQ messages are introduced for the VMC device. VMC
Administrative messages are used for each partition using the VMC to
communicate capabilities to their partner. HMC Interface messages are used
for the actual flow of HMC messages between the management partition and
the hypervisor. As most HMC messages far exceed the size of a CRQ buffer,
a virtual DMA (RMDA) of the HMC message data is done prior to each HMC
Interface CRQ message. Only the management partition drives RDMA
operations; hypervisors never directly cause the movement of message data.”h]”hX
  This driver also utilizes Transport Event CRQs. CRQ messages are sent
when the hypervisor detects one of the peer partitions has abnormally
terminated, or one side has called H_FREE_CRQ to close their CRQ.
Two new classes of CRQ messages are introduced for the VMC device. VMC
Administrative messages are used for each partition using the VMC to
communicate capabilities to their partner. HMC Interface messages are used
for the actual flow of HMC messages between the management partition and
the hypervisor. As most HMC messages far exceed the size of a CRQ buffer,
a virtual DMA (RMDA) of the HMC message data is done prior to each HMC
Interface CRQ message. Only the management partition drives RDMA
operations; hypervisors never directly cause the movement of message data.”…””}”(hjÈ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h KOhj›  hžhubeh}”(h]”Œvirtual-management-channel-vmc”ah ]”h"]”Œ virtual management channel (vmc)”ah$]”h&]”uh1h´hj]  hžhhŸh³h KAubhµ)”}”(hhh]”(hº)”}”(hŒTerminology”h]”hŒTerminology”…””}”(hjá  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjÞ  hžhhŸh³h K]ubhŒdefinition_list”“”)”}”(hhh]”(hŒdefinition_list_item”“”)”}”(hŒâRDMA
Remote Direct Memory Access is DMA transfer from the server to its
client or from the server to its partner partition. DMA refers
to both physical I/O to and from memory operations and to memory
to memory move operations.”h]”(hŒterm”“”)”}”(hŒRDMA”h]”hŒRDMA”…””}”(hjü  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jú  hŸh³h Kahjö  ubhŒ
definition”“”)”}”(hhh]”hê)”}”(hŒÝRemote Direct Memory Access is DMA transfer from the server to its
client or from the server to its partner partition. DMA refers
to both physical I/O to and from memory operations and to memory
to memory move operations.”h]”hŒÝRemote Direct Memory Access is DMA transfer from the server to its
client or from the server to its partner partition. DMA refers
to both physical I/O to and from memory operations and to memory
to memory move operations.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K_hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j
  hjö  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jô  hŸh³h Kahjñ  ubjõ  )”}”(hŒÅCRQ
Command/Response Queue a facility which is used to communicate
between partner partitions. Transport events which are signaled
from the hypervisor to partition are also reported in this queue.
”h]”(jû  )”}”(hŒCRQ”h]”hŒCRQ”…””}”(hj-  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jú  hŸh³h Kfhj)  ubj  )”}”(hhh]”hê)”}”(hŒÀCommand/Response Queue a facility which is used to communicate
between partner partitions. Transport events which are signaled
from the hypervisor to partition are also reported in this queue.”h]”hŒÀCommand/Response Queue a facility which is used to communicate
between partner partitions. Transport events which are signaled
from the hypervisor to partition are also reported in this queue.”…””}”(hj>  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Kdhj;  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j
  hj)  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jô  hŸh³h Kfhjñ  hžhubeh}”(h]”h ]”h"]”h$]”h&]”uh1jï  hjÞ  hžhhŸh³h Nubeh}”(h]”Œterminology”ah ]”h"]”Œterminology”ah$]”h&]”uh1h´hj]  hžhhŸh³h K]ubeh}”(h]”Œintroduction”ah ]”h"]”Œintroduction”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒ1Example Management Partition VMC Driver Interface”h]”hŒ1Example Management Partition VMC Driver Interface”…””}”(hjq  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjn  hžhhŸh³h Kiubhê)”}”(hX0  This section provides an example for the management application
implementation where a device driver is used to interface to the VMC
device. This driver consists of a new device, for example /dev/ibmvmc,
which provides interfaces to open, close, read, write, and perform
ioctlâ€™s against the VMC device.”h]”hX0  This section provides an example for the management application
implementation where a device driver is used to interface to the VMC
device. This driver consists of a new device, for example /dev/ibmvmc,
which provides interfaces to open, close, read, write, and perform
ioctlâ€™s against the VMC device.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Kkhjn  hžhubhµ)”}”(hhh]”(hº)”}”(hŒVMC Interface Initialization”h]”hŒVMC Interface Initialization”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj  hžhhŸh³h Krubhê)”}”(hX‡  The device driver is responsible for initializing the VMC when the driver
is loaded. It first creates and initializes the CRQ. Next, an exchange of
VMC capabilities is performed to indicate the code version and number of
resources available in both the management partition and the hypervisor.
Finally, the hypervisor requests that the management partition create an
initial pool of VMC buffers, one buffer for each possible HMC connection,
which will be used for management application  session initialization.
Prior to completion of this initialization sequence, the device returns
EBUSY to open() calls. EIO is returned for all open() failures.”h]”hX‡  The device driver is responsible for initializing the VMC when the driver
is loaded. It first creates and initializes the CRQ. Next, an exchange of
VMC capabilities is performed to indicate the code version and number of
resources available in both the management partition and the hypervisor.
Finally, the hypervisor requests that the management partition create an
initial pool of VMC buffers, one buffer for each possible HMC connection,
which will be used for management application  session initialization.
Prior to completion of this initialization sequence, the device returns
EBUSY to open() calls. EIO is returned for all open() failures.”…””}”(hjž  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Kthj  hžhubhŒliteral_block”“”)”}”(hX  Management Partition            Hypervisor
                CRQ INIT
---------------------------------------->
           CRQ INIT COMPLETE
<----------------------------------------
              CAPABILITIES
---------------------------------------->
         CAPABILITIES RESPONSE
<----------------------------------------
      ADD BUFFER (HMC IDX=0,1,..)         _
<----------------------------------------  |
          ADD BUFFER RESPONSE              | - Perform # HMCs Iterations
----------------------------------------> -”h]”hX  Management Partition            Hypervisor
                CRQ INIT
---------------------------------------->
           CRQ INIT COMPLETE
<----------------------------------------
              CAPABILITIES
---------------------------------------->
         CAPABILITIES RESPONSE
<----------------------------------------
      ADD BUFFER (HMC IDX=0,1,..)         _
<----------------------------------------  |
          ADD BUFFER RESPONSE              | - Perform # HMCs Iterations
----------------------------------------> -”…””}”hj®  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j¬  hŸh³h K€hj  hžhubeh}”(h]”Œvmc-interface-initialization”ah ]”h"]”Œvmc interface initialization”ah$]”h&]”uh1h´hjn  hžhhŸh³h Krubhµ)”}”(hhh]”(hº)”}”(hŒVMC Interface Open”h]”hŒVMC Interface Open”…””}”(hjÇ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjÄ  hžhhŸh³h Kubhê)”}”(hXÕ  After the basic VMC channel has been initialized, an HMC session level
connection can be established. The application layer performs an open() to
the VMC device and executes an ioctl() against it, indicating the HMC ID
(32 bytes of data) for this session. If the VMC device is in an invalid
state, EIO will be returned for the ioctl(). The device driver creates a
new HMC session value (ranging from 1 to 255) and HMC index value (starting
at index 0 and ranging to 254) for this HMC ID. The driver then does an
RDMA of the HMC ID to the hypervisor, and then sends an Interface Open
message to the hypervisor to establish the session over the VMC. After the
hypervisor receives this information, it sends Add Buffer messages to the
management partition to seed an initial pool of buffers for the new HMC
connection. Finally, the hypervisor sends an Interface Open Response
message, to indicate that it is ready for normal runtime messaging. The
following illustrates this VMC flow:”h]”hXÕ  After the basic VMC channel has been initialized, an HMC session level
connection can be established. The application layer performs an open() to
the VMC device and executes an ioctl() against it, indicating the HMC ID
(32 bytes of data) for this session. If the VMC device is in an invalid
state, EIO will be returned for the ioctl(). The device driver creates a
new HMC session value (ranging from 1 to 255) and HMC index value (starting
at index 0 and ranging to 254) for this HMC ID. The driver then does an
RDMA of the HMC ID to the hypervisor, and then sends an Interface Open
message to the hypervisor to establish the session over the VMC. After the
hypervisor receives this information, it sends Add Buffer messages to the
management partition to seed an initial pool of buffers for the new HMC
connection. Finally, the hypervisor sends an Interface Open Response
message, to indicate that it is ready for normal runtime messaging. The
following illustrates this VMC flow:”…””}”(hjÕ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K‘hjÄ  hžhubj­  )”}”(hXÇ  Management Partition             Hypervisor
              RDMA HMC ID
---------------------------------------->
            Interface Open
---------------------------------------->
              Add Buffer                  _
<----------------------------------------  |
          Add Buffer Response              | - Perform N Iterations
----------------------------------------> -
        Interface Open Response
<----------------------------------------”h]”hXÇ  Management Partition             Hypervisor
              RDMA HMC ID
---------------------------------------->
            Interface Open
---------------------------------------->
              Add Buffer                  _
<----------------------------------------  |
          Add Buffer Response              | - Perform N Iterations
----------------------------------------> -
        Interface Open Response
<----------------------------------------”…””}”hjã  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j¬  hŸh³h K¢hjÄ  hžhubeh}”(h]”Œvmc-interface-open”ah ]”h"]”Œvmc interface open”ah$]”h&]”uh1h´hjn  hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒVMC Interface Runtime”h]”hŒVMC Interface Runtime”…””}”(hjü  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjù  hžhhŸh³h K¯ubhê)”}”(hX0  During normal runtime, the management application and the hypervisor
exchange HMC messages via the Signal VMC message and RDMA operations. When
sending data to the hypervisor, the management application performs a
write() to the VMC device, and the driver RDMAâ€™s the data to the hypervisor
and then sends a Signal Message. If a write() is attempted before VMC
device buffers have been made available by the hypervisor, or no buffers
are currently available, EBUSY is returned in response to the write(). A
write() will return EIO for all other errors, such as an invalid device
state. When the hypervisor sends a message to the management, the data is
put into a VMC buffer and an Signal Message is sent to the VMC driver in
the management partition. The driver RDMAâ€™s the buffer into the partition
and passes the data up to the appropriate management application via a
read() to the VMC device. The read() request blocks if there is no buffer
available to read. The management application may use select() to wait for
the VMC device to become ready with data to read.”h]”hX0  During normal runtime, the management application and the hypervisor
exchange HMC messages via the Signal VMC message and RDMA operations. When
sending data to the hypervisor, the management application performs a
write() to the VMC device, and the driver RDMAâ€™s the data to the hypervisor
and then sends a Signal Message. If a write() is attempted before VMC
device buffers have been made available by the hypervisor, or no buffers
are currently available, EBUSY is returned in response to the write(). A
write() will return EIO for all other errors, such as an invalid device
state. When the hypervisor sends a message to the management, the data is
put into a VMC buffer and an Signal Message is sent to the VMC driver in
the management partition. The driver RDMAâ€™s the buffer into the partition
and passes the data up to the appropriate management application via a
read() to the VMC device. The read() request blocks if there is no buffer
available to read. The management application may use select() to wait for
the VMC device to become ready with data to read.”…””}”(hj
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K±hjù  hžhubj­  )”}”(hX;  Management Partition             Hypervisor
                MSG RDMA
---------------------------------------->
                SIGNAL MSG
---------------------------------------->
                SIGNAL MSG
<----------------------------------------
                MSG RDMA
<----------------------------------------”h]”hX;  Management Partition             Hypervisor
                MSG RDMA
---------------------------------------->
                SIGNAL MSG
---------------------------------------->
                SIGNAL MSG
<----------------------------------------
                MSG RDMA
<----------------------------------------”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j¬  hŸh³h KÃhjù  hžhubeh}”(h]”Œvmc-interface-runtime”ah ]”h"]”Œvmc interface runtime”ah$]”h&]”uh1h´hjn  hžhhŸh³h K¯ubhµ)”}”(hhh]”(hº)”}”(hŒVMC Interface Close”h]”hŒVMC Interface Close”…””}”(hj1  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj.  hžhhŸh³h KÎubhê)”}”(hXU  HMC session level connections are closed by the management partition when
the application layer performs a close() against the device. This action
results in an Interface Close message flowing to the hypervisor, which
causes the session to be terminated. The device driver must free any
storage allocated for buffers for this HMC connection.”h]”hXU  HMC session level connections are closed by the management partition when
the application layer performs a close() against the device. This action
results in an Interface Close message flowing to the hypervisor, which
causes the session to be terminated. The device driver must free any
storage allocated for buffers for this HMC connection.”…””}”(hj?  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h KÐhj.  hžhubj­  )”}”(hŒ½Management Partition             Hypervisor
             INTERFACE CLOSE
---------------------------------------->
        INTERFACE CLOSE RESPONSE
<----------------------------------------”h]”hŒ½Management Partition             Hypervisor
             INTERFACE CLOSE
---------------------------------------->
        INTERFACE CLOSE RESPONSE
<----------------------------------------”…””}”hjM  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1j¬  hŸh³h KØhj.  hžhubeh}”(h]”Œvmc-interface-close”ah ]”h"]”Œvmc interface close”ah$]”h&]”uh1h´hjn  hžhhŸh³h KÎubeh}”(h]”Œ1example-management-partition-vmc-driver-interface”ah ]”h"]”Œ1example management partition vmc driver interface”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kiubhµ)”}”(hhh]”(hº)”}”(hŒAdditional Information”h]”hŒAdditional Information”…””}”(hjn  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjk  hžhhŸh³h Kßubhê)”}”(hŒÃFor more information on the documentation for CRQ Messages, VMC Messages,
HMC interface Buffers, and signal messages please refer to the Linux on
Power Architecture Platform Reference. Section F.”h]”hŒÃFor more information on the documentation for CRQ Messages, VMC Messages,
HMC interface Buffers, and signal messages please refer to the Linux on
Power Architecture Platform Reference. Section F.”…””}”(hj|  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Káhjk  hžhubeh}”(h]”Œadditional-information”ah ]”h"]”Œadditional information”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kßubeh}”(h]”Œ3ibm-virtual-management-channel-kernel-driver-ibmvmc”ah ]”h"]”Œ5ibm virtual management channel kernel driver (ibmvmc)”ah$]”h&]”uh1h´hhhžhhŸh³h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h³uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¹NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j½  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h³Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(j—  j”  jk  jh  j˜  j•  jÛ  jØ  jc  j`  jh  je  jÁ  j¾  jö  jó  j+  j(  j`  j]  j  jŒ  uŒ	nametypes”}”(j—  ‰jk  ‰j˜  ‰jÛ  ‰jc  ‰jh  ‰jÁ  ‰jö  ‰j+  ‰j`  ‰j  ‰uh}”(j”  h¶jh  j]  j•  j¾  jØ  j›  j`  jÞ  je  jn  j¾  j  jó  jÄ  j(  jù  j]  j.  jŒ  jk  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.