Documentation/ntb.txt

   1 # NTB Drivers
   2
   3 NTB (Non-Transparent Bridge) is a type of PCI-Express bridge chip that connects
   4 the separate memory systems of two computers to the same PCI-Express fabric.
   5 Existing NTB hardware supports a common feature set, including scratchpad
   6 registers, doorbell registers, and memory translation windows.  Scratchpad
   7 registers are read-and-writable registers that are accessible from either side
   8 of the device, so that peers can exchange a small amount of information at a
   9 fixed address.  Doorbell registers provide a way for peers to send interrupt
  10 events.  Memory windows allow translated read and write access to the peer
  11 memory.
  12
  13 ## NTB Core Driver (ntb)
  14
  15 The NTB core driver defines an api wrapping the common feature set, and allows
  16 clients interested in NTB features to discover NTB the devices supported by
  17 hardware drivers.  The term "client" is used here to mean an upper layer
  18 component making use of the NTB api.  The term "driver," or "hardware driver,"
  19 is used here to mean a driver for a specific vendor and model of NTB hardware.
  20
  21 ## NTB Client Drivers
  22
  23 NTB client drivers should register with the NTB core driver.  After
  24 registering, the client probe and remove functions will be called appropriately
  25 as ntb hardware, or hardware drivers, are inserted and removed.  The
  26 registration uses the Linux Device framework, so it should feel familiar to
  27 anyone who has written a pci driver.
  28
  29 ## NTB Hardware Drivers
  30
  31 NTB hardware drivers should register devices with the NTB core driver.  After
  32 registering, clients probe and remove functions will be called.