Introduction¶

This framework is designed to provide a standard kernel interface to controlthe settings of the interconnects on an SoC. These settings can be throughput,latency and priority between multiple interconnected devices or functionalblocks. This can be controlled dynamically in order to save power or providemaximum performance.

The interconnect bus is hardware with configurable parameters, which can beset on a data path according to the requests received from various drivers.An example of interconnect buses are the interconnects between variouscomponents or functional blocks in chipsets. There can be multiple interconnectson an SoC that can be multi-tiered.

Below is a simplified diagram of a real-world SoC interconnect bus topology.

+----------------+    +----------------+| HW Accelerator |--->|      M NoC     |<---------------++----------------+    +----------------+                |                        |      |                    +------------+ +-----+  +-------------+      V       +------+     |            | | DDR |  |                +--------+  | PCIe |     |            | +-----+  |                | Slaves |  +------+     |            |   ^ ^    |                +--------+     |         |   C NoC    |   | |    V                               V         |            |+------------------+   +------------------------+   |            |   +-----+|                  |-->|                        |-->|            |-->| CPU ||                  |-->|                        |<--|            |   +-----+|     Mem NoC      |   |         S NoC          |   +------------+|                  |<--|                        |---------+    ||                  |<--|                        |<------+ |    |   +--------++------------------+   +------------------------+       | |    +-->| Slaves |  ^  ^    ^    ^          ^                             | |        +--------+  |  |    |    |          |                             | V+------+  |  +-----+   +-----+  +---------+   +----------------+   +--------+| CPUs |  |  | GPU |   | DSP |  | Masters |-->|       P NoC    |-->| Slaves |+------+  |  +-----+   +-----+  +---------+   +----------------+   +--------+          |      +-------+      | Modem |      +-------+

Terminology¶

Interconnect provider is the software definition of the interconnect hardware.The interconnect providers on the above diagram are M NoC, S NoC, C NoC, P NoCand Mem NoC.

Interconnect node is the software definition of the interconnect hardwareport. Each interconnect provider consists of multiple interconnect nodes,which are connected to other SoC components including other interconnectproviders. The point on the diagram where the CPUs connect to the memory iscalled an interconnect node, which belongs to the Mem NoC interconnect provider.

Interconnect endpoints are the first or the last element of the path. Everyendpoint is a node, but not every node is an endpoint.

Interconnect path is everything between two endpoints including all the nodesthat have to be traversed to reach from a source to destination node. It mayinclude multiple master-slave pairs across several interconnect providers.

Interconnect consumers are the entities which make use of the data paths exposedby the providers. The consumers send requests to providers requesting variousthroughput, latency and priority. Usually the consumers are device drivers, thatsend request based on their needs. An example for a consumer is a video decoderthat supports various formats and image sizes.

Interconnect providers¶

Interconnect provider is an entity that implements methods to initialize andconfigure interconnect bus hardware. The interconnect provider drivers shouldbe registered with the interconnect provider core.

structicc_node_data¶

icc node data

struct icc_node_data {    struct icc_node *node;    u32 tag;};

structicc_onecell_data¶

driver data for onecell interconnect providers

struct icc_onecell_data {    unsigned int num_nodes;    struct icc_node *nodes[] ;};

structicc_provider¶

interconnect provider (controller) entity that might provide multiple interconnect controls

struct icc_provider {    struct list_head        provider_list;    struct list_head        nodes;    int (*set)(struct icc_node *src, struct icc_node *dst);    int (*aggregate)(struct icc_node *node, u32 tag, u32 avg_bw, u32 peak_bw, u32 *agg_avg, u32 *agg_peak);    void (*pre_aggregate)(struct icc_node *node);    int (*get_bw)(struct icc_node *node, u32 *avg, u32 *peak);    struct icc_node* (*xlate)(const struct of_phandle_args *spec, void *data);    struct icc_node_data* (*xlate_extended)(const struct of_phandle_args *spec, void *data);    struct device           *dev;    int users;    bool inter_set;    void *data;};

structicc_node¶

entity that is part of the interconnect topology

struct icc_node {    int id;    const char              *name;    struct icc_node         **links;    size_t num_links;    struct icc_provider     *provider;    struct list_head        node_list;    struct list_head        search_list;    struct icc_node         *reverse;    u8 is_traversed:1;    struct hlist_head       req_list;    u32 avg_bw;    u32 peak_bw;    u32 init_avg;    u32 init_peak;    void *data;};

Interconnect consumers¶

Interconnect consumers are the clients which use the interconnect APIs toget paths between endpoints and set their bandwidth/latency/QoS requirementsfor these interconnect paths. These interfaces are not currentlydocumented.

Interconnect debugfs interfaces¶

Like several other subsystems interconnect will create some files for debuggingand introspection. Files in debugfs are not considered ABI so applicationsoftware shouldn’t rely on format details change between kernel versions.

/sys/kernel/debug/interconnect/interconnect_summary:

Show all interconnect nodes in the system with their aggregated bandwidthrequest. Indented under each node show bandwidth requests from each device.

/sys/kernel/debug/interconnect/interconnect_graph:

Show the interconnect graph in the graphviz dot format. It shows allinterconnect nodes and links in the system and groups together nodes from thesame provider as subgraphs. The format is human-readable and can also be pipedthrough dot to generate diagrams in many graphical formats:

$ cat /sys/kernel/debug/interconnect/interconnect_graph | \        dot -Tsvg > interconnect_graph.svg

Thetest-client directory provides interfaces for issuing BW requests toany arbitrary path. Note that for safety reasons, this feature is disabled bydefault without a Kconfig to enable it. Enabling it requires code changes to#defineINTERCONNECT_ALLOW_WRITE_DEBUGFS. Example usage:

cd /sys/kernel/debug/interconnect/test-client/# Configure node endpoints for the path from CPU to DDR on# qcom/sm8550.echo chm_apps > src_nodeecho ebi > dst_node# Get path between src_node and dst_node. This is only# necessary after updating the node endpoints.echo 1 > get# Set desired BW to 1GBps avg and 2GBps peak.echo 1000000 > avg_bwecho 2000000 > peak_bw# Vote for avg_bw and peak_bw on the latest path from "get".# Voting for multiple paths is possible by repeating this# process for different nodes endpoints.echo 1 > commit