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/list.h>
18 * WARNING: Do not include clk-private.h from any file that implements struct
19 * clk_ops. Doing so is a layering violation!
21 * This header exists only to allow for statically initialized clock data. Any
22 * static clock data must be defined in a separate file from the logic that
23 * implements the clock operations for that same data.
26 #ifdef CONFIG_COMMON_CLK
30 const struct clk_ops *ops;
33 const char **parent_names;
38 unsigned long new_rate;
39 struct clk *new_parent;
40 struct clk *new_child;
42 unsigned int enable_count;
43 unsigned int prepare_count;
44 struct hlist_head children;
45 struct hlist_node child_node;
46 unsigned int notifier_count;
49 #ifdef CONFIG_COMMON_CLK_DEBUG
50 struct dentry *dentry;
55 * DOC: Basic clock implementations common to many platforms
57 * Each basic clock hardware type is comprised of a structure describing the
58 * clock hardware, implementations of the relevant callbacks in struct clk_ops,
59 * unique flags for that hardware type, a registration function and an
60 * alternative macro for static initialization
63 #define DEFINE_CLK(_name, _ops, _flags, _parent_names, \
65 static struct clk _name = { \
68 .hw = &_name##_hw.hw, \
69 .parent_names = _parent_names, \
70 .num_parents = ARRAY_SIZE(_parent_names), \
71 .parents = _parents, \
72 .flags = _flags | CLK_IS_BASIC, \
75 #define DEFINE_CLK_FIXED_RATE(_name, _flags, _rate, \
77 static struct clk _name; \
78 static const char *_name##_parent_names[] = {}; \
79 static struct clk_fixed_rate _name##_hw = { \
83 .fixed_rate = _rate, \
84 .flags = _fixed_rate_flags, \
86 DEFINE_CLK(_name, clk_fixed_rate_ops, _flags, \
87 _name##_parent_names, NULL);
89 #define DEFINE_CLK_GATE(_name, _parent_name, _parent_ptr, \
90 _flags, _reg, _bit_idx, \
92 static struct clk _name; \
93 static const char *_name##_parent_names[] = { \
96 static struct clk *_name##_parents[] = { \
99 static struct clk_gate _name##_hw = { \
104 .bit_idx = _bit_idx, \
105 .flags = _gate_flags, \
108 DEFINE_CLK(_name, clk_gate_ops, _flags, \
109 _name##_parent_names, _name##_parents);
111 #define _DEFINE_CLK_DIVIDER(_name, _parent_name, _parent_ptr, \
112 _flags, _reg, _shift, _width, \
113 _divider_flags, _table, _lock) \
114 static struct clk _name; \
115 static const char *_name##_parent_names[] = { \
118 static struct clk *_name##_parents[] = { \
121 static struct clk_divider _name##_hw = { \
128 .flags = _divider_flags, \
132 DEFINE_CLK(_name, clk_divider_ops, _flags, \
133 _name##_parent_names, _name##_parents);
135 #define DEFINE_CLK_DIVIDER(_name, _parent_name, _parent_ptr, \
136 _flags, _reg, _shift, _width, \
137 _divider_flags, _lock) \
138 _DEFINE_CLK_DIVIDER(_name, _parent_name, _parent_ptr, \
139 _flags, _reg, _shift, _width, \
140 _divider_flags, NULL, _lock)
142 #define DEFINE_CLK_DIVIDER_TABLE(_name, _parent_name, \
143 _parent_ptr, _flags, _reg, \
144 _shift, _width, _divider_flags, \
146 _DEFINE_CLK_DIVIDER(_name, _parent_name, _parent_ptr, \
147 _flags, _reg, _shift, _width, \
148 _divider_flags, _table, _lock) \
150 #define DEFINE_CLK_MUX(_name, _parent_names, _parents, _flags, \
151 _reg, _shift, _width, \
153 static struct clk _name; \
154 static struct clk_mux _name##_hw = { \
160 .mask = BIT(_width) - 1, \
161 .flags = _mux_flags, \
164 DEFINE_CLK(_name, clk_mux_ops, _flags, _parent_names, \
167 #define DEFINE_CLK_FIXED_FACTOR(_name, _parent_name, \
168 _parent_ptr, _flags, \
170 static struct clk _name; \
171 static const char *_name##_parent_names[] = { \
174 static struct clk *_name##_parents[] = { \
177 static struct clk_fixed_factor _name##_hw = { \
184 DEFINE_CLK(_name, clk_fixed_factor_ops, _flags, \
185 _name##_parent_names, _name##_parents);
188 * __clk_init - initialize the data structures in a struct clk
189 * @dev: device initializing this clk, placeholder for now
190 * @clk: clk being initialized
192 * Initializes the lists in struct clk, queries the hardware for the
193 * parent and rate and sets them both.
195 * Any struct clk passed into __clk_init must have the following members
204 * It is not necessary to call clk_register if __clk_init is used directly with
205 * statically initialized clock data.
207 * Returns 0 on success, otherwise an error code.
209 int __clk_init(struct device *dev, struct clk *clk);
211 struct clk *__clk_register(struct device *dev, struct clk_hw *hw);
213 #endif /* CONFIG_COMMON_CLK */
214 #endif /* CLK_PRIVATE_H */