Documentation/interconnect/interconnect.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 :orphan:
   4
   5 =====================================
   6 GENERIC SYSTEM INTERCONNECT SUBSYSTEM
   7 =====================================
   8
   9 Introduction
  10 ------------
  11
  12 This framework is designed to provide a standard kernel interface to control
  13 the settings of the interconnects on an SoC. These settings can be throughput,
  14 latency and priority between multiple interconnected devices or functional
  15 blocks. This can be controlled dynamically in order to save power or provide
  16 maximum performance.
  17
  18 The interconnect bus is hardware with configurable parameters, which can be
  19 set on a data path according to the requests received from various drivers.
  20 An example of interconnect buses are the interconnects between various
  21 components or functional blocks in chipsets. There can be multiple interconnects
  22 on an SoC that can be multi-tiered.
  23
  24 Below is a simplified diagram of a real-world SoC interconnect bus topology.
  25
  26 ::
  27
  28  +----------------+    +----------------+
  29  | HW Accelerator |--->|      M NoC     |<---------------+
  30  +----------------+    +----------------+                |
  31                          |      |                    +------------+
  32   +-----+  +-------------+      V       +------+     |            |
  33   | DDR |  |                +--------+  | PCIe |     |            |
  34   +-----+  |                | Slaves |  +------+     |            |
  35     ^ ^    |                +--------+     |         |   C NoC    |
  36     | |    V                               V         |            |
  37  +------------------+   +------------------------+   |            |   +-----+
  38  |                  |-->|                        |-->|            |-->| CPU |
  39  |                  |-->|                        |<--|            |   +-----+
  40  |     Mem NoC      |   |         S NoC          |   +------------+
  41  |                  |<--|                        |---------+    |
  42  |                  |<--|                        |<------+ |    |   +--------+
  43  +------------------+   +------------------------+       | |    +-->| Slaves |
  44    ^  ^    ^    ^          ^                             | |        +--------+
  45    |  |    |    |          |                             | V
  46  +------+  |  +-----+   +-----+  +---------+   +----------------+   +--------+
  47  | CPUs |  |  | GPU |   | DSP |  | Masters |-->|       P NoC    |-->| Slaves |
  48  +------+  |  +-----+   +-----+  +---------+   +----------------+   +--------+
  49            |
  50        +-------+
  51        | Modem |
  52        +-------+
  53
  54 Terminology
  55 -----------
  56
  57 Interconnect provider is the software definition of the interconnect hardware.
  58 The interconnect providers on the above diagram are M NoC, S NoC, C NoC, P NoC
  59 and Mem NoC.
  60
  61 Interconnect node is the software definition of the interconnect hardware
  62 port. Each interconnect provider consists of multiple interconnect nodes,
  63 which are connected to other SoC components including other interconnect
  64 providers. The point on the diagram where the CPUs connect to the memory is
  65 called an interconnect node, which belongs to the Mem NoC interconnect provider.
  66
  67 Interconnect endpoints are the first or the last element of the path. Every
  68 endpoint is a node, but not every node is an endpoint.
  69
  70 Interconnect path is everything between two endpoints including all the nodes
  71 that have to be traversed to reach from a source to destination node. It may
  72 include multiple master-slave pairs across several interconnect providers.
  73
  74 Interconnect consumers are the entities which make use of the data paths exposed
  75 by the providers. The consumers send requests to providers requesting various
  76 throughput, latency and priority. Usually the consumers are device drivers, that
  77 send request based on their needs. An example for a consumer is a video decoder
  78 that supports various formats and image sizes.
  79
  80 Interconnect providers
  81 ----------------------
  82
  83 Interconnect provider is an entity that implements methods to initialize and
  84 configure interconnect bus hardware. The interconnect provider drivers should
  85 be registered with the interconnect provider core.
  86
  87 .. kernel-doc:: include/linux/interconnect-provider.h
  88
  89 Interconnect consumers
  90 ----------------------
  91
  92 Interconnect consumers are the clients which use the interconnect APIs to
  93 get paths between endpoints and set their bandwidth/latency/QoS requirements
  94 for these interconnect paths.  These interfaces are not currently
  95 documented.