interconnect-provider.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2/*
  3 * Copyright (c) 2018, Linaro Ltd.
  4 * Author: Georgi Djakov <georgi.djakov@linaro.org>
  5 */
  6
  7#ifndef __LINUX_INTERCONNECT_PROVIDER_H
  8#define __LINUX_INTERCONNECT_PROVIDER_H
  9
 10#include <linux/interconnect.h>
 11
 12#define icc_units_to_bps(bw)  ((bw) * 1000ULL)
 13
 14struct icc_node;
 15struct of_phandle_args;
 16
 17/**
 18 * struct icc_node_data - icc node data
 19 *
 20 * @node: icc node
 21 * @tag: tag
 22 */
 23struct icc_node_data {
 24	struct icc_node *node;
 25	u32 tag;
 26};
 27
 28/**
 29 * struct icc_onecell_data - driver data for onecell interconnect providers
 30 *
 31 * @num_nodes: number of nodes in this device
 32 * @nodes: array of pointers to the nodes in this device
 33 */
 34struct icc_onecell_data {
 35	unsigned int num_nodes;
 36	struct icc_node *nodes[] __counted_by(num_nodes);
 37};
 38
 39struct icc_node *of_icc_xlate_onecell(const struct of_phandle_args *spec,
 40				      void *data);
 41
 42/**
 43 * struct icc_provider - interconnect provider (controller) entity that might
 44 * provide multiple interconnect controls
 45 *
 46 * @provider_list: list of the registered interconnect providers
 47 * @nodes: internal list of the interconnect provider nodes
 48 * @set: pointer to device specific set operation function
 49 * @aggregate: pointer to device specific aggregate operation function
 50 * @pre_aggregate: pointer to device specific function that is called
 51 *		   before the aggregation begins (optional)
 52 * @get_bw: pointer to device specific function to get current bandwidth
 53 * @xlate: provider-specific callback for mapping nodes from phandle arguments
 54 * @xlate_extended: vendor-specific callback for mapping node data from phandle arguments
 55 * @dev: the device this interconnect provider belongs to
 56 * @users: count of active users
 57 * @inter_set: whether inter-provider pairs will be configured with @set
 58 * @data: pointer to private data
 59 */
 60struct icc_provider {
 61	struct list_head	provider_list;
 62	struct list_head	nodes;
 63	int (*set)(struct icc_node *src, struct icc_node *dst);
 64	int (*aggregate)(struct icc_node *node, u32 tag, u32 avg_bw,
 65			 u32 peak_bw, u32 *agg_avg, u32 *agg_peak);
 66	void (*pre_aggregate)(struct icc_node *node);
 67	int (*get_bw)(struct icc_node *node, u32 *avg, u32 *peak);
 68	struct icc_node* (*xlate)(const struct of_phandle_args *spec, void *data);
 69	struct icc_node_data* (*xlate_extended)(const struct of_phandle_args *spec,
 70						void *data);
 71	struct device		*dev;
 72	int			users;
 73	bool			inter_set;
 74	void			*data;
 75};
 76
 77/**
 78 * struct icc_node - entity that is part of the interconnect topology
 79 *
 80 * @id: platform specific node id
 81 * @name: node name used in debugfs
 82 * @links: a list of targets pointing to where we can go next when traversing
 83 * @num_links: number of links to other interconnect nodes
 84 * @provider: points to the interconnect provider of this node
 85 * @node_list: the list entry in the parent provider's "nodes" list
 86 * @search_list: list used when walking the nodes graph
 87 * @reverse: pointer to previous node when walking the nodes graph
 88 * @is_traversed: flag that is used when walking the nodes graph
 89 * @req_list: a list of QoS constraint requests associated with this node
 90 * @avg_bw: aggregated value of average bandwidth requests from all consumers
 91 * @peak_bw: aggregated value of peak bandwidth requests from all consumers
 92 * @init_avg: average bandwidth value that is read from the hardware during init
 93 * @init_peak: peak bandwidth value that is read from the hardware during init
 94 * @data: pointer to private data
 95 */
 96struct icc_node {
 97	int			id;
 98	const char              *name;
 99	struct icc_node		**links;
100	size_t			num_links;
101
102	struct icc_provider	*provider;
103	struct list_head	node_list;
104	struct list_head	search_list;
105	struct icc_node		*reverse;
106	u8			is_traversed:1;
107	struct hlist_head	req_list;
108	u32			avg_bw;
109	u32			peak_bw;
110	u32			init_avg;
111	u32			init_peak;
112	void			*data;
113};
114
115#if IS_ENABLED(CONFIG_INTERCONNECT)
116
117int icc_std_aggregate(struct icc_node *node, u32 tag, u32 avg_bw,
118		      u32 peak_bw, u32 *agg_avg, u32 *agg_peak);
119struct icc_node *icc_node_create_dyn(void);
120struct icc_node *icc_node_create(int id);
121void icc_node_destroy(int id);
122int icc_node_set_name(struct icc_node *node, const struct icc_provider *provider, const char *name);
123int icc_link_nodes(struct icc_node *src_node, struct icc_node **dst_node);
124int icc_link_create(struct icc_node *node, const int dst_id);
125void icc_node_add(struct icc_node *node, struct icc_provider *provider);
126void icc_node_del(struct icc_node *node);
127int icc_nodes_remove(struct icc_provider *provider);
128void icc_provider_init(struct icc_provider *provider);
129int icc_provider_register(struct icc_provider *provider);
130void icc_provider_deregister(struct icc_provider *provider);
131struct icc_node_data *of_icc_get_from_provider(const struct of_phandle_args *spec);
132void icc_sync_state(struct device *dev);
133
134#else
135
136static inline int icc_std_aggregate(struct icc_node *node, u32 tag, u32 avg_bw,
137				    u32 peak_bw, u32 *agg_avg, u32 *agg_peak)
138{
139	return -ENOTSUPP;
140}
141
142static inline struct icc_node *icc_node_create_dyn(void)
143{
144	return ERR_PTR(-EOPNOTSUPP);
145}
146
147static inline struct icc_node *icc_node_create(int id)
148{
149	return ERR_PTR(-ENOTSUPP);
150}
151
152static inline void icc_node_destroy(int id)
153{
154}
155
156static inline int icc_node_set_name(struct icc_node *node, const struct icc_provider *provider,
157				    const char *name)
158{
159	return -EOPNOTSUPP;
160}
161
162static inline int icc_link_nodes(struct icc_node *src_node, struct icc_node **dst_node)
163{
164	return -EOPNOTSUPP;
165}
166
167static inline int icc_link_create(struct icc_node *node, const int dst_id)
168{
169	return -ENOTSUPP;
170}
171
172static inline void icc_node_add(struct icc_node *node, struct icc_provider *provider)
173{
174}
175
176static inline void icc_node_del(struct icc_node *node)
177{
178}
179
180static inline int icc_nodes_remove(struct icc_provider *provider)
181{
182	return -ENOTSUPP;
183}
184
185static inline void icc_provider_init(struct icc_provider *provider) { }
186
187static inline int icc_provider_register(struct icc_provider *provider)
188{
189	return -ENOTSUPP;
190}
191
192static inline void icc_provider_deregister(struct icc_provider *provider) { }
193
194static inline struct icc_node_data *of_icc_get_from_provider(const struct of_phandle_args *spec)
195{
196	return ERR_PTR(-ENOTSUPP);
197}
198
199#endif /* CONFIG_INTERCONNECT */
200
201#endif /* __LINUX_INTERCONNECT_PROVIDER_H */