2 * linux/include/linux/clk-private.h
4 * Copyright (c) 2010-2011 Jeremy Kerr <jeremy.kerr@canonical.com>
5 * Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 #ifndef __LINUX_CLK_PRIVATE_H
12 #define __LINUX_CLK_PRIVATE_H
14 #include <linux/clk-provider.h>
15 #include <linux/kref.h>
16 #include <linux/list.h>
19 * WARNING: Do not include clk-private.h from any file that implements struct
20 * clk_ops. Doing so is a layering violation!
22 * This header exists only to allow for statically initialized clock data. Any
23 * static clock data must be defined in a separate file from the logic that
24 * implements the clock operations for that same data.
27 #ifdef CONFIG_COMMON_CLK
33 const struct clk_ops *ops;
37 const char **parent_names;
42 unsigned long new_rate;
43 struct clk *new_parent;
44 struct clk *new_child;
46 unsigned int enable_count;
47 unsigned int prepare_count;
48 unsigned long accuracy;
50 struct hlist_head children;
51 struct hlist_node child_node;
52 struct hlist_node debug_node;
53 unsigned int notifier_count;
54 #ifdef CONFIG_DEBUG_FS
55 struct dentry *dentry;
61 * DOC: Basic clock implementations common to many platforms
63 * Each basic clock hardware type is comprised of a structure describing the
64 * clock hardware, implementations of the relevant callbacks in struct clk_ops,
65 * unique flags for that hardware type, a registration function and an
66 * alternative macro for static initialization
69 #define DEFINE_CLK(_name, _ops, _flags, _parent_names, \
71 static struct clk _name = { \
74 .hw = &_name##_hw.hw, \
75 .parent_names = _parent_names, \
76 .num_parents = ARRAY_SIZE(_parent_names), \
77 .parents = _parents, \
78 .flags = _flags | CLK_IS_BASIC, \
81 #define DEFINE_CLK_FIXED_RATE(_name, _flags, _rate, \
83 static struct clk _name; \
84 static const char *_name##_parent_names[] = {}; \
85 static struct clk_fixed_rate _name##_hw = { \
89 .fixed_rate = _rate, \
90 .flags = _fixed_rate_flags, \
92 DEFINE_CLK(_name, clk_fixed_rate_ops, _flags, \
93 _name##_parent_names, NULL);
95 #define DEFINE_CLK_GATE(_name, _parent_name, _parent_ptr, \
96 _flags, _reg, _bit_idx, \
98 static struct clk _name; \
99 static const char *_name##_parent_names[] = { \
102 static struct clk *_name##_parents[] = { \
105 static struct clk_gate _name##_hw = { \
110 .bit_idx = _bit_idx, \
111 .flags = _gate_flags, \
114 DEFINE_CLK(_name, clk_gate_ops, _flags, \
115 _name##_parent_names, _name##_parents);
117 #define _DEFINE_CLK_DIVIDER(_name, _parent_name, _parent_ptr, \
118 _flags, _reg, _shift, _width, \
119 _divider_flags, _table, _lock) \
120 static struct clk _name; \
121 static const char *_name##_parent_names[] = { \
124 static struct clk *_name##_parents[] = { \
127 static struct clk_divider _name##_hw = { \
134 .flags = _divider_flags, \
138 DEFINE_CLK(_name, clk_divider_ops, _flags, \
139 _name##_parent_names, _name##_parents);
141 #define DEFINE_CLK_DIVIDER(_name, _parent_name, _parent_ptr, \
142 _flags, _reg, _shift, _width, \
143 _divider_flags, _lock) \
144 _DEFINE_CLK_DIVIDER(_name, _parent_name, _parent_ptr, \
145 _flags, _reg, _shift, _width, \
146 _divider_flags, NULL, _lock)
148 #define DEFINE_CLK_DIVIDER_TABLE(_name, _parent_name, \
149 _parent_ptr, _flags, _reg, \
150 _shift, _width, _divider_flags, \
152 _DEFINE_CLK_DIVIDER(_name, _parent_name, _parent_ptr, \
153 _flags, _reg, _shift, _width, \
154 _divider_flags, _table, _lock) \
156 #define DEFINE_CLK_MUX(_name, _parent_names, _parents, _flags, \
157 _reg, _shift, _width, \
159 static struct clk _name; \
160 static struct clk_mux _name##_hw = { \
166 .mask = BIT(_width) - 1, \
167 .flags = _mux_flags, \
170 DEFINE_CLK(_name, clk_mux_ops, _flags, _parent_names, \
173 #define DEFINE_CLK_FIXED_FACTOR(_name, _parent_name, \
174 _parent_ptr, _flags, \
176 static struct clk _name; \
177 static const char *_name##_parent_names[] = { \
180 static struct clk *_name##_parents[] = { \
183 static struct clk_fixed_factor _name##_hw = { \
190 DEFINE_CLK(_name, clk_fixed_factor_ops, _flags, \
191 _name##_parent_names, _name##_parents);
194 * __clk_init - initialize the data structures in a struct clk
195 * @dev: device initializing this clk, placeholder for now
196 * @clk: clk being initialized
198 * Initializes the lists in struct clk, queries the hardware for the
199 * parent and rate and sets them both.
201 * Any struct clk passed into __clk_init must have the following members
210 * It is not necessary to call clk_register if __clk_init is used directly with
211 * statically initialized clock data.
213 * Returns 0 on success, otherwise an error code.
215 int __clk_init(struct device *dev, struct clk *clk);
217 struct clk *__clk_register(struct device *dev, struct clk_hw *hw);
219 #endif /* CONFIG_COMMON_CLK */
220 #endif /* CLK_PRIVATE_H */