xref: /linux/include/linux/interconnect.h (revision c26f4fbd58375bd6ef74f95eb73d61762ad97c59)
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 /* macro to indicate dynamic id allocation */
24 #define ICC_ALLOC_DYN_ID	-1
25 
26 struct icc_path;
27 struct device;
28 
29 /**
30  * struct icc_bulk_data - Data used for bulk icc operations.
31  *
32  * @path: reference to the interconnect path (internal use)
33  * @name: the name from the "interconnect-names" DT property
34  * @avg_bw: average bandwidth in icc units
35  * @peak_bw: peak bandwidth in icc units
36  */
37 struct icc_bulk_data {
38 	struct icc_path	*path;
39 	const char *name;
40 	u32 avg_bw;
41 	u32 peak_bw;
42 };
43 
44 #if IS_ENABLED(CONFIG_INTERCONNECT)
45 
46 struct icc_path *of_icc_get(struct device *dev, const char *name);
47 struct icc_path *devm_of_icc_get(struct device *dev, const char *name);
48 int devm_of_icc_bulk_get(struct device *dev, int num_paths, struct icc_bulk_data *paths);
49 struct icc_path *of_icc_get_by_index(struct device *dev, int idx);
50 void icc_put(struct icc_path *path);
51 int icc_enable(struct icc_path *path);
52 int icc_disable(struct icc_path *path);
53 int icc_set_bw(struct icc_path *path, u32 avg_bw, u32 peak_bw);
54 void icc_set_tag(struct icc_path *path, u32 tag);
55 const char *icc_get_name(struct icc_path *path);
56 int __must_check of_icc_bulk_get(struct device *dev, int num_paths,
57 				 struct icc_bulk_data *paths);
58 void icc_bulk_put(int num_paths, struct icc_bulk_data *paths);
59 int icc_bulk_set_bw(int num_paths, const struct icc_bulk_data *paths);
60 int icc_bulk_enable(int num_paths, const struct icc_bulk_data *paths);
61 void icc_bulk_disable(int num_paths, const struct icc_bulk_data *paths);
62 
63 #else
64 
of_icc_get(struct device * dev,const char * name)65 static inline struct icc_path *of_icc_get(struct device *dev,
66 					  const char *name)
67 {
68 	return NULL;
69 }
70 
devm_of_icc_get(struct device * dev,const char * name)71 static inline struct icc_path *devm_of_icc_get(struct device *dev,
72 						const char *name)
73 {
74 	return NULL;
75 }
76 
of_icc_get_by_index(struct device * dev,int idx)77 static inline struct icc_path *of_icc_get_by_index(struct device *dev, int idx)
78 {
79 	return NULL;
80 }
81 
icc_put(struct icc_path * path)82 static inline void icc_put(struct icc_path *path)
83 {
84 }
85 
icc_enable(struct icc_path * path)86 static inline int icc_enable(struct icc_path *path)
87 {
88 	return 0;
89 }
90 
icc_disable(struct icc_path * path)91 static inline int icc_disable(struct icc_path *path)
92 {
93 	return 0;
94 }
95 
icc_set_bw(struct icc_path * path,u32 avg_bw,u32 peak_bw)96 static inline int icc_set_bw(struct icc_path *path, u32 avg_bw, u32 peak_bw)
97 {
98 	return 0;
99 }
100 
icc_set_tag(struct icc_path * path,u32 tag)101 static inline void icc_set_tag(struct icc_path *path, u32 tag)
102 {
103 }
104 
icc_get_name(struct icc_path * path)105 static inline const char *icc_get_name(struct icc_path *path)
106 {
107 	return NULL;
108 }
109 
of_icc_bulk_get(struct device * dev,int num_paths,struct icc_bulk_data * paths)110 static inline int of_icc_bulk_get(struct device *dev, int num_paths, struct icc_bulk_data *paths)
111 {
112 	return 0;
113 }
114 
devm_of_icc_bulk_get(struct device * dev,int num_paths,struct icc_bulk_data * paths)115 static inline int devm_of_icc_bulk_get(struct device *dev, int num_paths,
116 				       struct icc_bulk_data *paths)
117 {
118 	return 0;
119 }
120 
icc_bulk_put(int num_paths,struct icc_bulk_data * paths)121 static inline void icc_bulk_put(int num_paths, struct icc_bulk_data *paths)
122 {
123 }
124 
icc_bulk_set_bw(int num_paths,const struct icc_bulk_data * paths)125 static inline int icc_bulk_set_bw(int num_paths, const struct icc_bulk_data *paths)
126 {
127 	return 0;
128 }
129 
icc_bulk_enable(int num_paths,const struct icc_bulk_data * paths)130 static inline int icc_bulk_enable(int num_paths, const struct icc_bulk_data *paths)
131 {
132 	return 0;
133 }
134 
icc_bulk_disable(int num_paths,const struct icc_bulk_data * paths)135 static inline void icc_bulk_disable(int num_paths, const struct icc_bulk_data *paths)
136 {
137 }
138 
139 #endif /* CONFIG_INTERCONNECT */
140 
141 #endif /* __LINUX_INTERCONNECT_H */
142