Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 1 | /* |
| 2 | * linux/include/linux/clk-private.h |
| 3 | * |
| 4 | * Copyright (c) 2010-2011 Jeremy Kerr <jeremy.kerr@canonical.com> |
| 5 | * Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org> |
| 6 | * |
| 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. |
| 10 | */ |
| 11 | #ifndef __LINUX_CLK_PRIVATE_H |
| 12 | #define __LINUX_CLK_PRIVATE_H |
| 13 | |
| 14 | #include <linux/clk-provider.h> |
Sylwester Nawrocki | fcb0ee6 | 2013-08-24 15:00:10 +0200 | [diff] [blame] | 15 | #include <linux/kref.h> |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 16 | #include <linux/list.h> |
| 17 | |
| 18 | /* |
| 19 | * WARNING: Do not include clk-private.h from any file that implements struct |
| 20 | * clk_ops. Doing so is a layering violation! |
| 21 | * |
| 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. |
| 25 | */ |
| 26 | |
| 27 | #ifdef CONFIG_COMMON_CLK |
| 28 | |
Sylwester Nawrocki | ac2df52 | 2013-08-24 20:10:41 +0200 | [diff] [blame] | 29 | struct module; |
| 30 | |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 31 | struct clk { |
| 32 | const char *name; |
| 33 | const struct clk_ops *ops; |
| 34 | struct clk_hw *hw; |
Sylwester Nawrocki | ac2df52 | 2013-08-24 20:10:41 +0200 | [diff] [blame] | 35 | struct module *owner; |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 36 | struct clk *parent; |
Mark Brown | d305fb7 | 2012-03-21 20:01:20 +0000 | [diff] [blame] | 37 | const char **parent_names; |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 38 | struct clk **parents; |
| 39 | u8 num_parents; |
James Hogan | 71472c0 | 2013-07-29 12:25:00 +0100 | [diff] [blame] | 40 | u8 new_parent_index; |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 41 | unsigned long rate; |
| 42 | unsigned long new_rate; |
James Hogan | 71472c0 | 2013-07-29 12:25:00 +0100 | [diff] [blame] | 43 | struct clk *new_parent; |
| 44 | struct clk *new_child; |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 45 | unsigned long flags; |
| 46 | unsigned int enable_count; |
| 47 | unsigned int prepare_count; |
Boris BREZILLON | 5279fc4 | 2013-12-21 10:34:47 +0100 | [diff] [blame] | 48 | unsigned long accuracy; |
Mike Turquette | e59c537 | 2014-02-18 21:21:25 -0800 | [diff] [blame] | 49 | int phase; |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 50 | struct hlist_head children; |
| 51 | struct hlist_node child_node; |
Stephen Boyd | 6314b67 | 2014-09-04 23:37:49 -0700 | [diff] [blame] | 52 | struct hlist_node debug_node; |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 53 | unsigned int notifier_count; |
Mike Turquette | ea72dc2 | 2013-12-18 21:38:52 -0800 | [diff] [blame] | 54 | #ifdef CONFIG_DEBUG_FS |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 55 | struct dentry *dentry; |
| 56 | #endif |
Sylwester Nawrocki | fcb0ee6 | 2013-08-24 15:00:10 +0200 | [diff] [blame] | 57 | struct kref ref; |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 58 | }; |
| 59 | |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 60 | /* |
| 61 | * DOC: Basic clock implementations common to many platforms |
| 62 | * |
| 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 |
| 67 | */ |
| 68 | |
Viresh Kumar | 182f9e8c | 2012-04-17 16:45:36 +0530 | [diff] [blame] | 69 | #define DEFINE_CLK(_name, _ops, _flags, _parent_names, \ |
| 70 | _parents) \ |
| 71 | static struct clk _name = { \ |
| 72 | .name = #_name, \ |
| 73 | .ops = &_ops, \ |
| 74 | .hw = &_name##_hw.hw, \ |
| 75 | .parent_names = _parent_names, \ |
| 76 | .num_parents = ARRAY_SIZE(_parent_names), \ |
| 77 | .parents = _parents, \ |
Rajendra Nayak | f7d8caa | 2012-06-01 14:02:47 +0530 | [diff] [blame] | 78 | .flags = _flags | CLK_IS_BASIC, \ |
Viresh Kumar | 182f9e8c | 2012-04-17 16:45:36 +0530 | [diff] [blame] | 79 | } |
| 80 | |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 81 | #define DEFINE_CLK_FIXED_RATE(_name, _flags, _rate, \ |
| 82 | _fixed_rate_flags) \ |
| 83 | static struct clk _name; \ |
Rajendra Nayak | e447c50 | 2012-04-27 17:58:13 +0530 | [diff] [blame] | 84 | static const char *_name##_parent_names[] = {}; \ |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 85 | static struct clk_fixed_rate _name##_hw = { \ |
| 86 | .hw = { \ |
| 87 | .clk = &_name, \ |
| 88 | }, \ |
| 89 | .fixed_rate = _rate, \ |
| 90 | .flags = _fixed_rate_flags, \ |
| 91 | }; \ |
Viresh Kumar | 182f9e8c | 2012-04-17 16:45:36 +0530 | [diff] [blame] | 92 | DEFINE_CLK(_name, clk_fixed_rate_ops, _flags, \ |
| 93 | _name##_parent_names, NULL); |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 94 | |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 95 | #define DEFINE_CLK_GATE(_name, _parent_name, _parent_ptr, \ |
| 96 | _flags, _reg, _bit_idx, \ |
| 97 | _gate_flags, _lock) \ |
| 98 | static struct clk _name; \ |
Rajendra Nayak | e447c50 | 2012-04-27 17:58:13 +0530 | [diff] [blame] | 99 | static const char *_name##_parent_names[] = { \ |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 100 | _parent_name, \ |
| 101 | }; \ |
| 102 | static struct clk *_name##_parents[] = { \ |
| 103 | _parent_ptr, \ |
| 104 | }; \ |
| 105 | static struct clk_gate _name##_hw = { \ |
| 106 | .hw = { \ |
| 107 | .clk = &_name, \ |
| 108 | }, \ |
| 109 | .reg = _reg, \ |
| 110 | .bit_idx = _bit_idx, \ |
| 111 | .flags = _gate_flags, \ |
| 112 | .lock = _lock, \ |
| 113 | }; \ |
Viresh Kumar | 182f9e8c | 2012-04-17 16:45:36 +0530 | [diff] [blame] | 114 | DEFINE_CLK(_name, clk_gate_ops, _flags, \ |
| 115 | _name##_parent_names, _name##_parents); |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 116 | |
Rajendra Nayak | 357c3f0 | 2012-06-29 19:06:32 +0530 | [diff] [blame] | 117 | #define _DEFINE_CLK_DIVIDER(_name, _parent_name, _parent_ptr, \ |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 118 | _flags, _reg, _shift, _width, \ |
Rajendra Nayak | 357c3f0 | 2012-06-29 19:06:32 +0530 | [diff] [blame] | 119 | _divider_flags, _table, _lock) \ |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 120 | static struct clk _name; \ |
Rajendra Nayak | e447c50 | 2012-04-27 17:58:13 +0530 | [diff] [blame] | 121 | static const char *_name##_parent_names[] = { \ |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 122 | _parent_name, \ |
| 123 | }; \ |
| 124 | static struct clk *_name##_parents[] = { \ |
| 125 | _parent_ptr, \ |
| 126 | }; \ |
| 127 | static struct clk_divider _name##_hw = { \ |
| 128 | .hw = { \ |
| 129 | .clk = &_name, \ |
| 130 | }, \ |
| 131 | .reg = _reg, \ |
| 132 | .shift = _shift, \ |
| 133 | .width = _width, \ |
| 134 | .flags = _divider_flags, \ |
Rajendra Nayak | 357c3f0 | 2012-06-29 19:06:32 +0530 | [diff] [blame] | 135 | .table = _table, \ |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 136 | .lock = _lock, \ |
| 137 | }; \ |
Viresh Kumar | 182f9e8c | 2012-04-17 16:45:36 +0530 | [diff] [blame] | 138 | DEFINE_CLK(_name, clk_divider_ops, _flags, \ |
| 139 | _name##_parent_names, _name##_parents); |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 140 | |
Rajendra Nayak | 357c3f0 | 2012-06-29 19:06:32 +0530 | [diff] [blame] | 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) |
| 147 | |
| 148 | #define DEFINE_CLK_DIVIDER_TABLE(_name, _parent_name, \ |
| 149 | _parent_ptr, _flags, _reg, \ |
| 150 | _shift, _width, _divider_flags, \ |
| 151 | _table, _lock) \ |
| 152 | _DEFINE_CLK_DIVIDER(_name, _parent_name, _parent_ptr, \ |
| 153 | _flags, _reg, _shift, _width, \ |
| 154 | _divider_flags, _table, _lock) \ |
| 155 | |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 156 | #define DEFINE_CLK_MUX(_name, _parent_names, _parents, _flags, \ |
| 157 | _reg, _shift, _width, \ |
| 158 | _mux_flags, _lock) \ |
| 159 | static struct clk _name; \ |
| 160 | static struct clk_mux _name##_hw = { \ |
| 161 | .hw = { \ |
| 162 | .clk = &_name, \ |
| 163 | }, \ |
| 164 | .reg = _reg, \ |
| 165 | .shift = _shift, \ |
Peter De Schrijver | ce4f331 | 2013-03-22 14:07:53 +0200 | [diff] [blame] | 166 | .mask = BIT(_width) - 1, \ |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 167 | .flags = _mux_flags, \ |
| 168 | .lock = _lock, \ |
| 169 | }; \ |
Viresh Kumar | 182f9e8c | 2012-04-17 16:45:36 +0530 | [diff] [blame] | 170 | DEFINE_CLK(_name, clk_mux_ops, _flags, _parent_names, \ |
| 171 | _parents); |
Mike Turquette | 9d9f78e | 2012-03-15 23:11:20 -0700 | [diff] [blame] | 172 | |
Sascha Hauer | f0948f5 | 2012-05-03 15:36:14 +0530 | [diff] [blame] | 173 | #define DEFINE_CLK_FIXED_FACTOR(_name, _parent_name, \ |
| 174 | _parent_ptr, _flags, \ |
| 175 | _mult, _div) \ |
| 176 | static struct clk _name; \ |
| 177 | static const char *_name##_parent_names[] = { \ |
| 178 | _parent_name, \ |
| 179 | }; \ |
| 180 | static struct clk *_name##_parents[] = { \ |
| 181 | _parent_ptr, \ |
| 182 | }; \ |
| 183 | static struct clk_fixed_factor _name##_hw = { \ |
| 184 | .hw = { \ |
| 185 | .clk = &_name, \ |
| 186 | }, \ |
| 187 | .mult = _mult, \ |
| 188 | .div = _div, \ |
| 189 | }; \ |
| 190 | DEFINE_CLK(_name, clk_fixed_factor_ops, _flags, \ |
| 191 | _name##_parent_names, _name##_parents); |
| 192 | |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 193 | /** |
| 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 |
| 197 | * |
| 198 | * Initializes the lists in struct clk, queries the hardware for the |
| 199 | * parent and rate and sets them both. |
| 200 | * |
| 201 | * Any struct clk passed into __clk_init must have the following members |
| 202 | * populated: |
| 203 | * .name |
| 204 | * .ops |
| 205 | * .hw |
| 206 | * .parent_names |
| 207 | * .num_parents |
| 208 | * .flags |
| 209 | * |
| 210 | * It is not necessary to call clk_register if __clk_init is used directly with |
| 211 | * statically initialized clock data. |
Mike Turquette | d1302a3 | 2012-03-29 14:30:40 -0700 | [diff] [blame] | 212 | * |
| 213 | * Returns 0 on success, otherwise an error code. |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 214 | */ |
Mike Turquette | d1302a3 | 2012-03-29 14:30:40 -0700 | [diff] [blame] | 215 | int __clk_init(struct device *dev, struct clk *clk); |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 216 | |
Saravana Kannan | 0197b3e | 2012-04-25 22:58:56 -0700 | [diff] [blame] | 217 | struct clk *__clk_register(struct device *dev, struct clk_hw *hw); |
| 218 | |
Mike Turquette | b2476490 | 2012-03-15 23:11:19 -0700 | [diff] [blame] | 219 | #endif /* CONFIG_COMMON_CLK */ |
| 220 | #endif /* CLK_PRIVATE_H */ |