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