xref: /linux/include/linux/interconnect.h (revision e7d759f31ca295d589f7420719c311870bb3166f)
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 *of_icc_get(struct device *dev, const char *name);
44 struct icc_path *devm_of_icc_get(struct device *dev, const char *name);
45 int devm_of_icc_bulk_get(struct device *dev, int num_paths, struct icc_bulk_data *paths);
46 struct icc_path *of_icc_get_by_index(struct device *dev, int idx);
47 void icc_put(struct icc_path *path);
48 int icc_enable(struct icc_path *path);
49 int icc_disable(struct icc_path *path);
50 int icc_set_bw(struct icc_path *path, u32 avg_bw, u32 peak_bw);
51 void icc_set_tag(struct icc_path *path, u32 tag);
52 const char *icc_get_name(struct icc_path *path);
53 int __must_check of_icc_bulk_get(struct device *dev, int num_paths,
54 				 struct icc_bulk_data *paths);
55 void icc_bulk_put(int num_paths, struct icc_bulk_data *paths);
56 int icc_bulk_set_bw(int num_paths, const struct icc_bulk_data *paths);
57 int icc_bulk_enable(int num_paths, const struct icc_bulk_data *paths);
58 void icc_bulk_disable(int num_paths, const struct icc_bulk_data *paths);
59 
60 #else
61 
62 static inline struct icc_path *of_icc_get(struct device *dev,
63 					  const char *name)
64 {
65 	return NULL;
66 }
67 
68 static inline struct icc_path *devm_of_icc_get(struct device *dev,
69 						const char *name)
70 {
71 	return NULL;
72 }
73 
74 static inline struct icc_path *of_icc_get_by_index(struct device *dev, int idx)
75 {
76 	return NULL;
77 }
78 
79 static inline void icc_put(struct icc_path *path)
80 {
81 }
82 
83 static inline int icc_enable(struct icc_path *path)
84 {
85 	return 0;
86 }
87 
88 static inline int icc_disable(struct icc_path *path)
89 {
90 	return 0;
91 }
92 
93 static inline int icc_set_bw(struct icc_path *path, u32 avg_bw, u32 peak_bw)
94 {
95 	return 0;
96 }
97 
98 static inline void icc_set_tag(struct icc_path *path, u32 tag)
99 {
100 }
101 
102 static inline const char *icc_get_name(struct icc_path *path)
103 {
104 	return NULL;
105 }
106 
107 static inline int of_icc_bulk_get(struct device *dev, int num_paths, struct icc_bulk_data *paths)
108 {
109 	return 0;
110 }
111 
112 static inline int devm_of_icc_bulk_get(struct device *dev, int num_paths,
113 				       struct icc_bulk_data *paths)
114 {
115 	return 0;
116 }
117 
118 static inline void icc_bulk_put(int num_paths, struct icc_bulk_data *paths)
119 {
120 }
121 
122 static inline int icc_bulk_set_bw(int num_paths, const struct icc_bulk_data *paths)
123 {
124 	return 0;
125 }
126 
127 static inline int icc_bulk_enable(int num_paths, const struct icc_bulk_data *paths)
128 {
129 	return 0;
130 }
131 
132 static inline void icc_bulk_disable(int num_paths, const struct icc_bulk_data *paths)
133 {
134 }
135 
136 #endif /* CONFIG_INTERCONNECT */
137 
138 #endif /* __LINUX_INTERCONNECT_H */
139