€•œ¼      Œ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”Œ1/translations/zh_CN/PCI/endpoint/pci-ntb-function”Œ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”Œ1/translations/zh_TW/PCI/endpoint/pci-ntb-function”Œ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”Œ1/translations/it_IT/PCI/endpoint/pci-ntb-function”Œ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”Œ1/translations/ja_JP/PCI/endpoint/pci-ntb-function”Œ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”Œ1/translations/ko_KR/PCI/endpoint/pci-ntb-function”Œ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”Œ1/translations/sp_SP/PCI/endpoint/pci-ntb-function”Œ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ŸŒK/var/lib/git/docbuild/linux/Documentation/PCI/endpoint/pci-ntb-function.rst”h KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒPCI NTB Function”h]”hŒPCI NTB Function”…””}”(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ŒAuthor”h]”hŒAuthor”…””}”(hhÕhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÓhhÐhŸh³h K ubhŒ
field_body”“”)”}”(hŒ'Kishon Vijay Abraham I <kishon@ti.com>
”h]”hŒ	paragraph”“”)”}”(hŒ&Kishon Vijay Abraham I <kishon@ti.com>”h]”(hŒKishon Vijay Abraham I <”…””}”(hhëhžhhŸNh NubhŒ	reference”“”)”}”(hŒkishon@ti.com”h]”hŒkishon@ti.com”…””}”(hhõhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œmailto:kishon@ti.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X}  PCI Non-Transparent Bridges (NTB) allow two host systems to communicate
with each other by exposing each host as a device to the other host.
NTBs typically support the ability to generate interrupts on the remote
machine, expose memory ranges as BARs, and perform DMA.  They also support
scratchpads, which are areas of memory within the NTB that are accessible
from both machines.”h]”hX}  PCI Non-Transparent Bridges (NTB) allow two host systems to communicate
with each other by exposing each host as a device to the other host.
NTBs typically support the ability to generate interrupts on the remote
machine, expose memory ranges as BARs, and perform DMA.  They also support
scratchpads, which are areas of memory within the NTB that are accessible
from both machines.”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K	hh¶hžhubhê)”}”(hŒÍPCI NTB Function allows two different systems (or hosts) to communicate
with each other by configuring the endpoint instances in such a way that
transactions from one system are routed to the other system.”h]”hŒÍPCI NTB Function allows two different systems (or hosts) to communicate
with each other by configuring the endpoint instances in such a way that
transactions from one system are routed to the other system.”…””}”(hj/  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Khh¶hžhubhê)”}”(hXM  In the below diagram, PCI NTB function configures the SoC with multiple
PCI Endpoint (EP) instances in such a way that transactions from one EP
controller are routed to the other EP controller. Once PCI NTB function
configures the SoC with multiple EP instances, HOST1 and HOST2 can
communicate with each other using SoC as a bridge.”h]”hXM  In the below diagram, PCI NTB function configures the SoC with multiple
PCI Endpoint (EP) instances in such a way that transactions from one EP
controller are routed to the other EP controller. Once PCI NTB function
configures the SoC with multiple EP instances, HOST1 and HOST2 can
communicate with each other using SoC as a bridge.”…””}”(hj=  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Khh¶hžhubhŒliteral_block”“”)”}”(hX4     +-------------+                                   +-------------+
   |             |                                   |             |
   |    HOST1    |                                   |    HOST2    |
   |             |                                   |             |
   +------^------+                                   +------^------+
          |                                                 |
          |                                                 |
+---------|-------------------------------------------------|---------+
|  +------v------+                                   +------v------+  |
|  |             |                                   |             |  |
|  |     EP      |                                   |     EP      |  |
|  | CONTROLLER1 |                                   | CONTROLLER2 |  |
|  |             <----------------------------------->             |  |
|  |             |                                   |             |  |
|  |             |                                   |             |  |
|  |             |  SoC With Multiple EP Instances   |             |  |
|  |             |  (Configured using NTB Function)  |             |  |
|  +-------------+                                   +-------------+  |
+---------------------------------------------------------------------+”h]”hX4     +-------------+                                   +-------------+
   |             |                                   |             |
   |    HOST1    |                                   |    HOST2    |
   |             |                                   |             |
   +------^------+                                   +------^------+
          |                                                 |
          |                                                 |
+---------|-------------------------------------------------|---------+
|  +------v------+                                   +------v------+  |
|  |             |                                   |             |  |
|  |     EP      |                                   |     EP      |  |
|  | CONTROLLER1 |                                   | CONTROLLER2 |  |
|  |             <----------------------------------->             |  |
|  |             |                                   |             |  |
|  |             |                                   |             |  |
|  |             |  SoC With Multiple EP Instances   |             |  |
|  |             |  (Configured using NTB Function)  |             |  |
|  +-------------+                                   +-------------+  |
+---------------------------------------------------------------------+”…””}”hjM  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²Œforce”‰Œlanguage”Œtext”Œhighlight_args”}”uh1jK  hŸh³h Khh¶hžhubhµ)”}”(hhh]”(hº)”}”(hŒ$Constructs used for Implementing NTB”h]”hŒ$Constructs used for Implementing NTB”…””}”(hjc  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj`  hžhhŸh³h K1ubhŒblock_quote”“”)”}”(hŒ}1) Config Region
2) Self Scratchpad Registers
3) Peer Scratchpad Registers
4) Doorbell (DB) Registers
5) Memory Window (MW)

”h]”hŒenumerated_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒConfig Region”h]”hê)”}”(hj€  h]”hŒConfig Region”…””}”(hj‚  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K3hj~  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j|  hjy  ubj}  )”}”(hŒSelf Scratchpad Registers”h]”hê)”}”(hj—  h]”hŒSelf Scratchpad Registers”…””}”(hj™  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K4hj•  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j|  hjy  ubj}  )”}”(hŒPeer Scratchpad Registers”h]”hê)”}”(hj®  h]”hŒPeer Scratchpad Registers”…””}”(hj°  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K5hj¬  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j|  hjy  ubj}  )”}”(hŒDoorbell (DB) Registers”h]”hê)”}”(hjÅ  h]”hŒDoorbell (DB) Registers”…””}”(hjÇ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K6hjÃ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j|  hjy  ubj}  )”}”(hŒMemory Window (MW)

”h]”hê)”}”(hŒMemory Window (MW)”h]”hŒMemory Window (MW)”…””}”(hjÞ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K7hjÚ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j|  hjy  ubeh}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œarabic”Œprefix”hŒsuffix”Œ)”uh1jw  hjs  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jq  hŸh³h K3hj`  hžhubhµ)”}”(hhh]”(hº)”}”(hŒConfig Region:”h]”hŒConfig Region:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj  hžhhŸh³h K;ubhê)”}”(hXZ  Config Region is a construct that is specific to NTB implemented using NTB
Endpoint Function Driver. The host and endpoint side NTB function driver will
exchange information with each other using this region. Config Region has
Control/Status Registers for configuring the Endpoint Controller. Host can
write into this region for configuring the outbound Address Translation Unit
(ATU) and to indicate the link status. Endpoint can indicate the status of
commands issued by host in this region. Endpoint can also indicate the
scratchpad offset and number of memory windows to the host using this region.”h]”hXZ  Config Region is a construct that is specific to NTB implemented using NTB
Endpoint Function Driver. The host and endpoint side NTB function driver will
exchange information with each other using this region. Config Region has
Control/Status Registers for configuring the Endpoint Controller. Host can
write into this region for configuring the outbound Address Translation Unit
(ATU) and to indicate the link status. Endpoint can indicate the status of
commands issued by host in this region. Endpoint can also indicate the
scratchpad offset and number of memory windows to the host using this region.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K=hj  hžhubhê)”}”(hŒLThe format of Config Region is given below. All the fields here are 32 bits.”h]”hŒLThe format of Config Region is given below. All the fields here are 32 bits.”…””}”(hj"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h KFhj  hžhubjL  )”}”(hX°        +------------------------+
      |         COMMAND        |
      +------------------------+
      |         ARGUMENT       |
      +------------------------+
      |         STATUS         |
      +------------------------+
      |         TOPOLOGY       |
      +------------------------+
      |    ADDRESS (LOWER 32)  |
      +------------------------+
      |    ADDRESS (UPPER 32)  |
      +------------------------+
      |           SIZE         |
      +------------------------+
      |   NO OF MEMORY WINDOW  |
      +------------------------+
      |  MEMORY WINDOW1 OFFSET |
      +------------------------+
      |       SPAD OFFSET      |
      +------------------------+
      |        SPAD COUNT      |
      +------------------------+
      |      DB ENTRY SIZE     |
      +------------------------+
      |         DB DATA        |
      +------------------------+
      |            :           |
      +------------------------+
      |            :           |
      +------------------------+
      |         DB DATA        |
      +------------------------+


COMMAND:

      NTB function supports three commands:

        CMD_CONFIGURE_DOORBELL (0x1): Command to configure doorbell. Before
      invoking this command, the host should allocate and initialize
      MSI/MSI-X vectors (i.e., initialize the MSI/MSI-X Capability in the
      Endpoint). The endpoint on receiving this command will configure
      the outbound ATU such that transactions to Doorbell BAR will be routed
      to the MSI/MSI-X address programmed by the host. The ARGUMENT
      register should be populated with number of DBs to configure (in the
      lower 16 bits) and if MSI or MSI-X should be configured (BIT 16).

        CMD_CONFIGURE_MW (0x2): Command to configure memory window (MW). The
      host invokes this command after allocating a buffer that can be
      accessed by remote host. The allocated address should be programmed
      in the ADDRESS register (64 bit), the size should be programmed in
      the SIZE register and the memory window index should be programmed
      in the ARGUMENT register. The endpoint on receiving this command
      will configure the outbound ATU such that transactions to MW BAR
      are routed to the address provided by the host.

        CMD_LINK_UP (0x3): Command to indicate an NTB application is
      bound to the EP device on the host side. Once the endpoint
      receives this command from both the hosts, the endpoint will
      raise a LINK_UP event to both the hosts to indicate the host
      NTB applications can start communicating with each other.

ARGUMENT:

      The value of this register is based on the commands issued in
      command register. See COMMAND section for more information.

TOPOLOGY:

      Set to NTB_TOPO_B2B_USD for Primary interface
      Set to NTB_TOPO_B2B_DSD for Secondary interface

ADDRESS/SIZE:

      Address and Size to be used while configuring the memory window.
      See "CMD_CONFIGURE_MW" for more info.

MEMORY WINDOW1 OFFSET:

      Memory Window 1 and Doorbell registers are packed together in the
      same BAR. The initial portion of the region will have doorbell
      registers and the latter portion of the region is for memory window 1.
      This register will specify the offset of the memory window 1.

NO OF MEMORY WINDOW:

      Specifies the number of memory windows supported by the NTB device.

SPAD OFFSET:

      Self scratchpad region and config region are packed together in the
      same BAR. The initial portion of the region will have config region
      and the latter portion of the region is for self scratchpad. This
      register will specify the offset of the self scratchpad registers.

SPAD COUNT:

      Specifies the number of scratchpad registers supported by the NTB
      device.

DB ENTRY SIZE:

      Used to determine the offset within the DB BAR that should be written
      in order to raise doorbell. EPF NTB can use either MSI or MSI-X to
      ring doorbell (MSI-X support will be added later). MSI uses same
      address for all the interrupts and MSI-X can provide different
      addresses for different interrupts. The MSI/MSI-X address is provided
      by the host and the address it gives is based on the MSI/MSI-X
      implementation supported by the host. For instance, ARM platform
      using GIC ITS will have the same MSI-X address for all the interrupts.
      In order to support all the combinations and use the same mechanism
      for both MSI and MSI-X, EPF NTB allocates a separate region in the
      Outbound Address Space for each of the interrupts. This region will
      be mapped to the MSI/MSI-X address provided by the host. If a host
      provides the same address for all the interrupts, all the regions
      will be translated to the same address. If a host provides different
      addresses, the regions will be translated to different addresses. This
      will ensure there is no difference while raising the doorbell.

DB DATA:

      EPF NTB supports 32 interrupts, so there are 32 DB DATA registers.
      This holds the MSI/MSI-X data that has to be written to MSI address
      for raising doorbell interrupt. This will be populated by EPF NTB
      while invoking CMD_CONFIGURE_DOORBELL.”h]”hX°        +------------------------+
      |         COMMAND        |
      +------------------------+
      |         ARGUMENT       |
      +------------------------+
      |         STATUS         |
      +------------------------+
      |         TOPOLOGY       |
      +------------------------+
      |    ADDRESS (LOWER 32)  |
      +------------------------+
      |    ADDRESS (UPPER 32)  |
      +------------------------+
      |           SIZE         |
      +------------------------+
      |   NO OF MEMORY WINDOW  |
      +------------------------+
      |  MEMORY WINDOW1 OFFSET |
      +------------------------+
      |       SPAD OFFSET      |
      +------------------------+
      |        SPAD COUNT      |
      +------------------------+
      |      DB ENTRY SIZE     |
      +------------------------+
      |         DB DATA        |
      +------------------------+
      |            :           |
      +------------------------+
      |            :           |
      +------------------------+
      |         DB DATA        |
      +------------------------+


COMMAND:

      NTB function supports three commands:

        CMD_CONFIGURE_DOORBELL (0x1): Command to configure doorbell. Before
      invoking this command, the host should allocate and initialize
      MSI/MSI-X vectors (i.e., initialize the MSI/MSI-X Capability in the
      Endpoint). The endpoint on receiving this command will configure
      the outbound ATU such that transactions to Doorbell BAR will be routed
      to the MSI/MSI-X address programmed by the host. The ARGUMENT
      register should be populated with number of DBs to configure (in the
      lower 16 bits) and if MSI or MSI-X should be configured (BIT 16).

        CMD_CONFIGURE_MW (0x2): Command to configure memory window (MW). The
      host invokes this command after allocating a buffer that can be
      accessed by remote host. The allocated address should be programmed
      in the ADDRESS register (64 bit), the size should be programmed in
      the SIZE register and the memory window index should be programmed
      in the ARGUMENT register. The endpoint on receiving this command
      will configure the outbound ATU such that transactions to MW BAR
      are routed to the address provided by the host.

        CMD_LINK_UP (0x3): Command to indicate an NTB application is
      bound to the EP device on the host side. Once the endpoint
      receives this command from both the hosts, the endpoint will
      raise a LINK_UP event to both the hosts to indicate the host
      NTB applications can start communicating with each other.

ARGUMENT:

      The value of this register is based on the commands issued in
      command register. See COMMAND section for more information.

TOPOLOGY:

      Set to NTB_TOPO_B2B_USD for Primary interface
      Set to NTB_TOPO_B2B_DSD for Secondary interface

ADDRESS/SIZE:

      Address and Size to be used while configuring the memory window.
      See "CMD_CONFIGURE_MW" for more info.

MEMORY WINDOW1 OFFSET:

      Memory Window 1 and Doorbell registers are packed together in the
      same BAR. The initial portion of the region will have doorbell
      registers and the latter portion of the region is for memory window 1.
      This register will specify the offset of the memory window 1.

NO OF MEMORY WINDOW:

      Specifies the number of memory windows supported by the NTB device.

SPAD OFFSET:

      Self scratchpad region and config region are packed together in the
      same BAR. The initial portion of the region will have config region
      and the latter portion of the region is for self scratchpad. This
      register will specify the offset of the self scratchpad registers.

SPAD COUNT:

      Specifies the number of scratchpad registers supported by the NTB
      device.

DB ENTRY SIZE:

      Used to determine the offset within the DB BAR that should be written
      in order to raise doorbell. EPF NTB can use either MSI or MSI-X to
      ring doorbell (MSI-X support will be added later). MSI uses same
      address for all the interrupts and MSI-X can provide different
      addresses for different interrupts. The MSI/MSI-X address is provided
      by the host and the address it gives is based on the MSI/MSI-X
      implementation supported by the host. For instance, ARM platform
      using GIC ITS will have the same MSI-X address for all the interrupts.
      In order to support all the combinations and use the same mechanism
      for both MSI and MSI-X, EPF NTB allocates a separate region in the
      Outbound Address Space for each of the interrupts. This region will
      be mapped to the MSI/MSI-X address provided by the host. If a host
      provides the same address for all the interrupts, all the regions
      will be translated to the same address. If a host provides different
      addresses, the regions will be translated to different addresses. This
      will ensure there is no difference while raising the doorbell.

DB DATA:

      EPF NTB supports 32 interrupts, so there are 32 DB DATA registers.
      This holds the MSI/MSI-X data that has to be written to MSI address
      for raising doorbell interrupt. This will be populated by EPF NTB
      while invoking CMD_CONFIGURE_DOORBELL.”…””}”hj0  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²j[  ‰j\  Œtext”j^  }”uh1jK  hŸh³h KHhj  hžhubeh}”(h]”Œconfig-region”ah ]”h"]”Œconfig region:”ah$]”h&]”uh1h´hj`  hžhhŸh³h K;ubhµ)”}”(hhh]”(hº)”}”(hŒScratchpad Registers:”h]”hŒScratchpad Registers:”…””}”(hjK  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjH  hžhhŸh³h KÊubjr  )”}”(hX®  Each host has its own register space allocated in the memory of NTB endpoint
controller. They are both readable and writable from both sides of the bridge.
They are used by applications built over NTB and can be used to pass control
and status information between both sides of a device.

Scratchpad registers has 2 parts
      1) Self Scratchpad: Host's own register space
      2) Peer Scratchpad: Remote host's register space.
”h]”(hê)”}”(hX  Each host has its own register space allocated in the memory of NTB endpoint
controller. They are both readable and writable from both sides of the bridge.
They are used by applications built over NTB and can be used to pass control
and status information between both sides of a device.”h]”hX  Each host has its own register space allocated in the memory of NTB endpoint
controller. They are both readable and writable from both sides of the bridge.
They are used by applications built over NTB and can be used to pass control
and status information between both sides of a device.”…””}”(hj]  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h KÌhjY  ubhŒdefinition_list”“”)”}”(hhh]”hŒdefinition_list_item”“”)”}”(hŒScratchpad registers has 2 parts
1) Self Scratchpad: Host's own register space
2) Peer Scratchpad: Remote host's register space.
”h]”(hŒterm”“”)”}”(hŒ Scratchpad registers has 2 parts”h]”hŒ Scratchpad registers has 2 parts”…””}”(hjx  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jv  hŸh³h KÓhjr  ubhŒ
definition”“”)”}”(hhh]”jx  )”}”(hhh]”(j}  )”}”(hŒ*Self Scratchpad: Host's own register space”h]”hê)”}”(hj  h]”hŒ,Self Scratchpad: Hostâ€™s own register space”…””}”(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‹  ubj}  )”}”(hŒ/Peer Scratchpad: Remote host's register space.
”h]”hê)”}”(hŒ.Peer Scratchpad: Remote host's register space.”h]”hŒ0Peer Scratchpad: Remote hostâ€™s register space.”…””}”(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&]”jø  jù  jú  hjû  jü  uh1jw  hjˆ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j†  hjr  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jp  hŸh³h KÓhjm  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jk  hjY  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jq  hŸh³h KÌhjH  hžhubeh}”(h]”Œscratchpad-registers”ah ]”h"]”Œscratchpad registers:”ah$]”h&]”uh1h´hj`  hžhhŸh³h KÊubhµ)”}”(hhh]”(hº)”}”(hŒDoorbell Registers:”h]”hŒDoorbell Registers:”…””}”(hjæ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjã  hžhhŸh³h KÖubjr  )”}”(hŒBDoorbell Registers are used by the hosts to interrupt each other.
”h]”hê)”}”(hŒADoorbell Registers are used by the hosts to interrupt each other.”h]”hŒADoorbell Registers are used by the hosts to interrupt each other.”…””}”(hjø  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h KØhjô  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jq  hŸh³h KØhjã  hžhubeh}”(h]”Œdoorbell-registers”ah ]”h"]”Œdoorbell registers:”ah$]”h&]”uh1h´hj`  hžhhŸh³h KÖubhµ)”}”(hhh]”(hº)”}”(hŒMemory Window:”h]”hŒMemory Window:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj  hžhhŸh³h KÛubjr  )”}”(hŒSActual transfer of data between the two hosts will happen using the
memory window.
”h]”hê)”}”(hŒRActual transfer of data between the two hosts will happen using the
memory window.”h]”hŒRActual transfer of data between the two hosts will happen using the
memory window.”…””}”(hj)  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h KÝhj%  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jq  hŸh³h KÝhj  hžhubeh}”(h]”Œmemory-window”ah ]”h"]”Œmemory window:”ah$]”h&]”uh1h´hj`  hžhhŸh³h KÛubeh}”(h]”Œ$constructs-used-for-implementing-ntb”ah ]”h"]”Œ$constructs used for implementing ntb”ah$]”h&]”uh1h´hh¶hžhhŸh³h K1ubhµ)”}”(hhh]”(hº)”}”(hŒModeling Constructs:”h]”hŒModeling Constructs:”…””}”(hjP  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjM  hžhhŸh³h Káubhê)”}”(hX8  There are 5 or more distinct regions (config, self scratchpad, peer
scratchpad, doorbell, one or more memory windows) to be modeled to achieve
NTB functionality. At least one memory window is required while more than
one is permitted. All these regions should be mapped to BARs for hosts to
access these regions.”h]”hX8  There are 5 or more distinct regions (config, self scratchpad, peer
scratchpad, doorbell, one or more memory windows) to be modeled to achieve
NTB functionality. At least one memory window is required while more than
one is permitted. All these regions should be mapped to BARs for hosts to
access these regions.”…””}”(hj^  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h KãhjM  hžhubhê)”}”(hŒZIf one 32-bit BAR is allocated for each of these regions, the scheme would
look like this:”h]”hŒZIf one 32-bit BAR is allocated for each of these regions, the scheme would
look like this:”…””}”(hjl  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h KéhjM  hžhubhŒtable”“”)”}”(hhh]”hŒtgroup”“”)”}”(hhh]”(hŒcolspec”“”)”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j„  hj  ubj…  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j„  hj  ubhŒthead”“”)”}”(hhh]”hŒrow”“”)”}”(hhh]”(hŒentry”“”)”}”(hhh]”hê)”}”(hŒBAR NO”h]”hŒBAR NO”…””}”(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¡  ubj¥  )”}”(hhh]”hê)”}”(hŒCONSTRUCTS USED”h]”hŒCONSTRUCTS USED”…””}”(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jœ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jš  hj  ubhŒtbody”“”)”}”(hhh]”(j   )”}”(hhh]”(j¥  )”}”(hhh]”hê)”}”(hŒBAR0”h]”hŒBAR0”…””}”(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å  ubj¥  )”}”(hhh]”hê)”}”(hŒConfig Region”h]”hŒConfig Region”…””}”(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jâ  ubj   )”}”(hhh]”(j¥  )”}”(hhh]”hê)”}”(hŒBAR1”h]”hŒBAR1”…””}”(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  ubj¥  )”}”(hhh]”hê)”}”(hŒSelf Scratchpad”h]”hŒSelf Scratchpad”…””}”(hj9  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Kðhj6  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŸ  hjâ  ubj   )”}”(hhh]”(j¥  )”}”(hhh]”hê)”}”(hŒBAR2”h]”hŒBAR2”…””}”(hjY  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h KñhjV  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hjS  ubj¥  )”}”(hhh]”hê)”}”(hŒPeer Scratchpad”h]”hŒPeer Scratchpad”…””}”(hjp  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Kñhjm  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hjS  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŸ  hjâ  ubj   )”}”(hhh]”(j¥  )”}”(hhh]”hê)”}”(hŒBAR3”h]”hŒBAR3”…””}”(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Š  ubj¥  )”}”(hhh]”hê)”}”(hŒDoorbell”h]”hŒDoorbell”…””}”(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jâ  ubj   )”}”(hhh]”(j¥  )”}”(hhh]”hê)”}”(hŒBAR4”h]”hŒBAR4”…””}”(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Á  ubj¥  )”}”(hhh]”hê)”}”(hŒMemory Window 1”h]”hŒMemory Window 1”…””}”(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jâ  ubj   )”}”(hhh]”(j¥  )”}”(hhh]”hê)”}”(hŒBAR5”h]”hŒBAR5”…””}”(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ø  ubj¥  )”}”(hhh]”hê)”}”(hŒMemory Window 2”h]”hŒMemory Window 2”…””}”(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jâ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jà  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1j  hj|  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jz  hjM  hžhhŸh³h Nubhê)”}”(hŒŸHowever if we allocate a separate BAR for each of the regions, there would not
be enough BARs for all the regions in a platform that supports only 64-bit
BARs.”h]”hŒŸHowever if we allocate a separate BAR for each of the regions, there would not
be enough BARs for all the regions in a platform that supports only 64-bit
BARs.”…””}”(hjB  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h K÷hjM  hžhubhê)”}”(hŒÞIn order to be supported by most of the platforms, the regions should be
packed and mapped to BARs in a way that provides NTB functionality and
also makes sure the host doesn't access any region that it is not supposed
to.”h]”hŒàIn order to be supported by most of the platforms, the regions should be
packed and mapped to BARs in a way that provides NTB functionality and
also makes sure the host doesnâ€™t access any region that it is not supposed
to.”…””}”(hjP  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h KûhjM  hžhubhê)”}”(hŒ1The following scheme is used in EPF NTB Function:”h]”hŒ1The following scheme is used in EPF NTB Function:”…””}”(hj^  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h M hjM  hžhubj{  )”}”(hhh]”j€  )”}”(hhh]”(j…  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j„  hjo  ubj…  )”}”(hhh]”h}”(h]”h ]”h"]”h$]”h&]”Œcolwidth”Kuh1j„  hjo  ubj›  )”}”(hhh]”j   )”}”(hhh]”(j¥  )”}”(hhh]”hê)”}”(hŒBAR NO”h]”hŒBAR NO”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h MhjŒ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj‰  ubj¥  )”}”(hhh]”hê)”}”(hŒCONSTRUCTS USED”h]”hŒCONSTRUCTS USED”…””}”(hj¦  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Mhj£  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj‰  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŸ  hj†  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jš  hjo  ubjá  )”}”(hhh]”(j   )”}”(hhh]”(j¥  )”}”(hhh]”hê)”}”(hŒBAR0”h]”hŒBAR0”…””}”(hjÏ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h MhjÌ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hjÉ  ubj¥  )”}”(hhh]”hê)”}”(hŒConfig Region + Self Scratchpad”h]”hŒConfig Region + Self Scratchpad”…””}”(hjæ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Mhjã  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hjÉ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŸ  hjÆ  ubj   )”}”(hhh]”(j¥  )”}”(hhh]”hê)”}”(hŒBAR1”h]”hŒBAR1”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Mhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj   ubj¥  )”}”(hhh]”hê)”}”(hŒPeer Scratchpad”h]”hŒPeer Scratchpad”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Mhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj   ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŸ  hjÆ  ubj   )”}”(hhh]”(j¥  )”}”(hhh]”hê)”}”(hŒBAR2”h]”hŒBAR2”…””}”(hj=  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Mhj:  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj7  ubj¥  )”}”(hhh]”hê)”}”(hŒDoorbell + Memory Window 1”h]”hŒDoorbell + Memory Window 1”…””}”(hjT  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h MhjQ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj7  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŸ  hjÆ  ubj   )”}”(hhh]”(j¥  )”}”(hhh]”hê)”}”(hŒBAR3”h]”hŒBAR3”…””}”(hjt  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Mhjq  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hjn  ubj¥  )”}”(hhh]”hê)”}”(hŒMemory Window 2”h]”hŒMemory Window 2”…””}”(hj‹  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h Mhjˆ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hjn  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŸ  hjÆ  ubj   )”}”(hhh]”(j¥  )”}”(hhh]”hê)”}”(hŒBAR4”h]”hŒBAR4”…””}”(hj«  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h M	hj¨  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj¥  ubj¥  )”}”(hhh]”hê)”}”(hŒMemory Window 3”h]”hŒMemory Window 3”…””}”(hjÂ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h M	hj¿  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hj¥  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŸ  hjÆ  ubj   )”}”(hhh]”(j¥  )”}”(hhh]”hê)”}”(hŒBAR5”h]”hŒBAR5”…””}”(hjâ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h M
hjß  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hjÜ  ubj¥  )”}”(hhh]”hê)”}”(hŒMemory Window 4”h]”hŒMemory Window 4”…””}”(hjù  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h M
hjö  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j¤  hjÜ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŸ  hjÆ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jà  hjo  ubeh}”(h]”h ]”h"]”h$]”h&]”Œcols”Kuh1j  hjl  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jz  hjM  hžhhŸh³h Nubhê)”}”(hŒNWith this scheme, for the basic NTB functionality 3 BARs should be sufficient.”h]”hŒNWith this scheme, for the basic NTB functionality 3 BARs should be sufficient.”…””}”(hj&  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h MhjM  hžhubhµ)”}”(hhh]”(hº)”}”(hŒ"Modeling Config/Scratchpad Region:”h]”hŒ"Modeling Config/Scratchpad Region:”…””}”(hj7  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj4  hžhhŸh³h MubjL  )”}”(hX  +-----------------+------->+------------------+        +-----------------+
|       BAR0      |        |  CONFIG REGION   |        |       BAR0      |
+-----------------+----+   +------------------+<-------+-----------------+
|       BAR1      |    |   |SCRATCHPAD REGION |        |       BAR1      |
+-----------------+    +-->+------------------+<-------+-----------------+
|       BAR2      |            Local Memory            |       BAR2      |
+-----------------+                                    +-----------------+
|       BAR3      |                                    |       BAR3      |
+-----------------+                                    +-----------------+
|       BAR4      |                                    |       BAR4      |
+-----------------+                                    +-----------------+
|       BAR5      |                                    |       BAR5      |
+-----------------+                                    +-----------------+
  EP CONTROLLER 1                                        EP CONTROLLER 2”h]”hX  +-----------------+------->+------------------+        +-----------------+
|       BAR0      |        |  CONFIG REGION   |        |       BAR0      |
+-----------------+----+   +------------------+<-------+-----------------+
|       BAR1      |    |   |SCRATCHPAD REGION |        |       BAR1      |
+-----------------+    +-->+------------------+<-------+-----------------+
|       BAR2      |            Local Memory            |       BAR2      |
+-----------------+                                    +-----------------+
|       BAR3      |                                    |       BAR3      |
+-----------------+                                    +-----------------+
|       BAR4      |                                    |       BAR4      |
+-----------------+                                    +-----------------+
|       BAR5      |                                    |       BAR5      |
+-----------------+                                    +-----------------+
  EP CONTROLLER 1                                        EP CONTROLLER 2”…””}”hjE  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²j[  ‰j\  Œtext”j^  }”uh1jK  hŸh³h Mhj4  hžhubhê)”}”(hXü  Above diagram shows Config region + Scratchpad region for HOST1 (connected to
EP controller 1) allocated in local memory. The HOST1 can access the config
region and scratchpad region (self scratchpad) using BAR0 of EP controller 1.
The peer host (HOST2 connected to EP controller 2) can also access this
scratchpad region (peer scratchpad) using BAR1 of EP controller 2. This
diagram shows the case where Config region and Scratchpad regions are allocated
for HOST1, however the same is applicable for HOST2.”h]”hXü  Above diagram shows Config region + Scratchpad region for HOST1 (connected to
EP controller 1) allocated in local memory. The HOST1 can access the config
region and scratchpad region (self scratchpad) using BAR0 of EP controller 1.
The peer host (HOST2 connected to EP controller 2) can also access this
scratchpad region (peer scratchpad) using BAR1 of EP controller 2. This
diagram shows the case where Config region and Scratchpad regions are allocated
for HOST1, however the same is applicable for HOST2.”…””}”(hjU  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h M#hj4  hžhubeh}”(h]”Œ!modeling-config-scratchpad-region”ah ]”h"]”Œ"modeling config/scratchpad region:”ah$]”h&]”uh1h´hjM  hžhhŸh³h Mubhµ)”}”(hhh]”(hº)”}”(hŒ"Modeling Doorbell/Memory Window 1:”h]”hŒ"Modeling Doorbell/Memory Window 1:”…””}”(hjn  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjk  hžhhŸh³h M,ubjL  )”}”(hX@	  +-----------------+    +----->+----------------+-----------+-----------------+
|       BAR0      |    |      |   Doorbell 1   +-----------> MSI-X ADDRESS 1 |
+-----------------+    |      +----------------+           +-----------------+
|       BAR1      |    |      |   Doorbell 2   +---------+ |                 |
+-----------------+----+      +----------------+         | |                 |
|       BAR2      |           |   Doorbell 3   +-------+ | +-----------------+
+-----------------+----+      +----------------+       | +-> MSI-X ADDRESS 2 |
|       BAR3      |    |      |   Doorbell 4   +-----+ |   +-----------------+
+-----------------+    |      |----------------+     | |   |                 |
|       BAR4      |    |      |                |     | |   +-----------------+
+-----------------+    |      |      MW1       +---+ | +-->+ MSI-X ADDRESS 3||
|       BAR5      |    |      |                |   | |     +-----------------+
+-----------------+    +----->-----------------+   | |     |                 |
  EP CONTROLLER 1             |                |   | |     +-----------------+
                              |                |   | +---->+ MSI-X ADDRESS 4 |
                              +----------------+   |       +-----------------+
                               EP CONTROLLER 2     |       |                 |
                                 (OB SPACE)        |       |                 |
                                                   +------->      MW1        |
                                                           |                 |
                                                           |                 |
                                                           +-----------------+
                                                           |                 |
                                                           |                 |
                                                           |                 |
                                                           |                 |
                                                           |                 |
                                                           +-----------------+
                                                            PCI Address Space
                                                            (Managed by HOST2)”h]”hX@	  +-----------------+    +----->+----------------+-----------+-----------------+
|       BAR0      |    |      |   Doorbell 1   +-----------> MSI-X ADDRESS 1 |
+-----------------+    |      +----------------+           +-----------------+
|       BAR1      |    |      |   Doorbell 2   +---------+ |                 |
+-----------------+----+      +----------------+         | |                 |
|       BAR2      |           |   Doorbell 3   +-------+ | +-----------------+
+-----------------+----+      +----------------+       | +-> MSI-X ADDRESS 2 |
|       BAR3      |    |      |   Doorbell 4   +-----+ |   +-----------------+
+-----------------+    |      |----------------+     | |   |                 |
|       BAR4      |    |      |                |     | |   +-----------------+
+-----------------+    |      |      MW1       +---+ | +-->+ MSI-X ADDRESS 3||
|       BAR5      |    |      |                |   | |     +-----------------+
+-----------------+    +----->-----------------+   | |     |                 |
  EP CONTROLLER 1             |                |   | |     +-----------------+
                              |                |   | +---->+ MSI-X ADDRESS 4 |
                              +----------------+   |       +-----------------+
                               EP CONTROLLER 2     |       |                 |
                                 (OB SPACE)        |       |                 |
                                                   +------->      MW1        |
                                                           |                 |
                                                           |                 |
                                                           +-----------------+
                                                           |                 |
                                                           |                 |
                                                           |                 |
                                                           |                 |
                                                           |                 |
                                                           +-----------------+
                                                            PCI Address Space
                                                            (Managed by HOST2)”…””}”hj|  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²j[  ‰j\  Œtext”j^  }”uh1jK  hŸh³h M.hjk  hžhubhê)”}”(hX7  Above diagram shows how the doorbell and memory window 1 is mapped so that
HOST1 can raise doorbell interrupt on HOST2 and also how HOST1 can access
buffers exposed by HOST2 using memory window1 (MW1). Here doorbell and
memory window 1 regions are allocated in EP controller 2 outbound (OB) address
space. Allocating and configuring BARs for doorbell and memory window1
is done during the initialization phase of NTB endpoint function driver.
Mapping from EP controller 2 OB space to PCI address space is done when HOST2
sends CMD_CONFIGURE_MW/CMD_CONFIGURE_DOORBELL.”h]”hX7  Above diagram shows how the doorbell and memory window 1 is mapped so that
HOST1 can raise doorbell interrupt on HOST2 and also how HOST1 can access
buffers exposed by HOST2 using memory window1 (MW1). Here doorbell and
memory window 1 regions are allocated in EP controller 2 outbound (OB) address
space. Allocating and configuring BARs for doorbell and memory window1
is done during the initialization phase of NTB endpoint function driver.
Mapping from EP controller 2 OB space to PCI address space is done when HOST2
sends CMD_CONFIGURE_MW/CMD_CONFIGURE_DOORBELL.”…””}”(hjŒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h MOhjk  hžhubeh}”(h]”Œ!modeling-doorbell-memory-window-1”ah ]”h"]”Œ"modeling doorbell/memory window 1:”ah$]”h&]”uh1h´hjM  hžhhŸh³h M,ubhµ)”}”(hhh]”(hº)”}”(hŒ!Modeling Optional Memory Windows:”h]”hŒ!Modeling Optional Memory Windows:”…””}”(hj¥  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj¢  hžhhŸh³h MYubhê)”}”(hŒiThis is modeled the same was as MW1 but each of the additional memory windows
is mapped to separate BARs.”h]”hŒiThis is modeled the same was as MW1 but each of the additional memory windows
is mapped to separate BARs.”…””}”(hj³  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1héhŸh³h M[hj¢  hžhubeh}”(h]”Œ modeling-optional-memory-windows”ah ]”h"]”Œ!modeling optional memory windows:”ah$]”h&]”uh1h´hjM  hžhhŸh³h MYubeh}”(h]”Œmodeling-constructs”ah ]”h"]”Œmodeling constructs:”ah$]”h&]”uh1h´hh¶hžhhŸh³h Káubeh}”(h]”Œpci-ntb-function”ah ]”h"]”Œpci ntb function”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”j¤  Œ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Ó  jJ  jG  jE  jB  jà  jÝ  j  j  jB  j?  jÎ  jË  jh  je  jŸ  jœ  jÆ  jÃ  uŒ	nametypes”}”(jÖ  ‰jJ  ‰jE  ‰jà  ‰j  ‰jB  ‰jÎ  ‰jh  ‰jŸ  ‰jÆ  ‰uh}”(jÓ  h¶jG  j`  jB  j  jÝ  jH  j  jã  j?  j  jË  jM  je  j4  jœ  jk  jÃ  j¢  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.