xref: /linux/include/linux/interconnect.h (revision c6fbb759)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (c) 2018-2019, Linaro Ltd.
4  * Author: Georgi Djakov <georgi.djakov@linaro.org>
5  */
6 
7 #ifndef __LINUX_INTERCONNECT_H
8 #define __LINUX_INTERCONNECT_H
9 
10 #include <linux/mutex.h>
11 #include <linux/types.h>
12 
13 /* macros for converting to icc units */
14 #define Bps_to_icc(x)	((x) / 1000)
15 #define kBps_to_icc(x)	(x)
16 #define MBps_to_icc(x)	((x) * 1000)
17 #define GBps_to_icc(x)	((x) * 1000 * 1000)
18 #define bps_to_icc(x)	(1)
19 #define kbps_to_icc(x)	((x) / 8 + ((x) % 8 ? 1 : 0))
20 #define Mbps_to_icc(x)	((x) * 1000 / 8)
21 #define Gbps_to_icc(x)	((x) * 1000 * 1000 / 8)
22 
23 struct icc_path;
24 struct device;
25 
26 /**
27  * struct icc_bulk_data - Data used for bulk icc operations.
28  *
29  * @path: reference to the interconnect path (internal use)
30  * @name: the name from the "interconnect-names" DT property
31  * @avg_bw: average bandwidth in icc units
32  * @peak_bw: peak bandwidth in icc units
33  */
34 struct icc_bulk_data {
35 	struct icc_path	*path;
36 	const char *name;
37 	u32 avg_bw;
38 	u32 peak_bw;
39 };
40 
41 #if IS_ENABLED(CONFIG_INTERCONNECT)
42 
43 struct icc_path *icc_get(struct device *dev, const int src_id,
44 			 const int dst_id);
45 struct icc_path *of_icc_get(struct device *dev, const char *name);
46 struct icc_path *devm_of_icc_get(struct device *dev, const char *name);
47 int devm_of_icc_bulk_get(struct device *dev, int num_paths, struct icc_bulk_data *paths);
48 struct icc_path *of_icc_get_by_index(struct device *dev, int idx);
49 void icc_put(struct icc_path *path);
50 int icc_enable(struct icc_path *path);
51 int icc_disable(struct icc_path *path);
52 int icc_set_bw(struct icc_path *path, u32 avg_bw, u32 peak_bw);
53 void icc_set_tag(struct icc_path *path, u32 tag);
54 const char *icc_get_name(struct icc_path *path);
55 int __must_check of_icc_bulk_get(struct device *dev, int num_paths,
56 				 struct icc_bulk_data *paths);
57 void icc_bulk_put(int num_paths, struct icc_bulk_data *paths);
58 int icc_bulk_set_bw(int num_paths, const struct icc_bulk_data *paths);
59 int icc_bulk_enable(int num_paths, const struct icc_bulk_data *paths);
60 void icc_bulk_disable(int num_paths, const struct icc_bulk_data *paths);
61 
62 #else
63 
64 static inline struct icc_path *icc_get(struct device *dev, const int src_id,
65 				       const int dst_id)
66 {
67 	return NULL;
68 }
69 
70 static inline struct icc_path *of_icc_get(struct device *dev,
71 					  const char *name)
72 {
73 	return NULL;
74 }
75 
76 static inline struct icc_path *devm_of_icc_get(struct device *dev,
77 						const char *name)
78 {
79 	return NULL;
80 }
81 
82 static inline struct icc_path *of_icc_get_by_index(struct device *dev, int idx)
83 {
84 	return NULL;
85 }
86 
87 static inline void icc_put(struct icc_path *path)
88 {
89 }
90 
91 static inline int icc_enable(struct icc_path *path)
92 {
93 	return 0;
94 }
95 
96 static inline int icc_disable(struct icc_path *path)
97 {
98 	return 0;
99 }
100 
101 static inline int icc_set_bw(struct icc_path *path, u32 avg_bw, u32 peak_bw)
102 {
103 	return 0;
104 }
105 
106 static inline void icc_set_tag(struct icc_path *path, u32 tag)
107 {
108 }
109 
110 static inline const char *icc_get_name(struct icc_path *path)
111 {
112 	return NULL;
113 }
114 
115 static inline int of_icc_bulk_get(struct device *dev, int num_paths, struct icc_bulk_data *paths)
116 {
117 	return 0;
118 }
119 
120 static inline int devm_of_icc_bulk_get(struct device *dev, int num_paths,
121 				       struct icc_bulk_data *paths)
122 {
123 	return 0;
124 }
125 
126 static inline void icc_bulk_put(int num_paths, struct icc_bulk_data *paths)
127 {
128 }
129 
130 static inline int icc_bulk_set_bw(int num_paths, const struct icc_bulk_data *paths)
131 {
132 	return 0;
133 }
134 
135 static inline int icc_bulk_enable(int num_paths, const struct icc_bulk_data *paths)
136 {
137 	return 0;
138 }
139 
140 static inline void icc_bulk_disable(int num_paths, const struct icc_bulk_data *paths)
141 {
142 }
143 
144 #endif /* CONFIG_INTERCONNECT */
145 
146 #endif /* __LINUX_INTERCONNECT_H */
147