mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-04 01:49:36 +00:00
![Sascha Hauer](/assets/img/avatar_default.png)
Having fixed factors/dividers in hardware is a common pattern, so add a basic clock type doing this. It basically describes a fixed factor clock using a nominator and a denominator. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de> Reviewed-by: Viresh Kumar <viresh.kumar@st.com> Tested-by: Shawn Guo <shawn.guo@linaro.org> [mturquette@linaro.org: constify parent_names in static init macro] [mturquette@linaro.org: copy/paste bug from mux in static init macro] [mturquette@linaro.org: fix error handling in clk_register_fixed_factor] [mturquette@linaro.org: improve division accuracy; thanks to Saravana] Signed-off-by: Mike Turquette <mturquette@linaro.org>
193 lines
5.3 KiB
C
193 lines
5.3 KiB
C
/*
|
|
* linux/include/linux/clk-private.h
|
|
*
|
|
* Copyright (c) 2010-2011 Jeremy Kerr <jeremy.kerr@canonical.com>
|
|
* Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License version 2 as
|
|
* published by the Free Software Foundation.
|
|
*/
|
|
#ifndef __LINUX_CLK_PRIVATE_H
|
|
#define __LINUX_CLK_PRIVATE_H
|
|
|
|
#include <linux/clk-provider.h>
|
|
#include <linux/list.h>
|
|
|
|
/*
|
|
* WARNING: Do not include clk-private.h from any file that implements struct
|
|
* clk_ops. Doing so is a layering violation!
|
|
*
|
|
* This header exists only to allow for statically initialized clock data. Any
|
|
* static clock data must be defined in a separate file from the logic that
|
|
* implements the clock operations for that same data.
|
|
*/
|
|
|
|
#ifdef CONFIG_COMMON_CLK
|
|
|
|
struct clk {
|
|
const char *name;
|
|
const struct clk_ops *ops;
|
|
struct clk_hw *hw;
|
|
struct clk *parent;
|
|
const char **parent_names;
|
|
struct clk **parents;
|
|
u8 num_parents;
|
|
unsigned long rate;
|
|
unsigned long new_rate;
|
|
unsigned long flags;
|
|
unsigned int enable_count;
|
|
unsigned int prepare_count;
|
|
struct hlist_head children;
|
|
struct hlist_node child_node;
|
|
unsigned int notifier_count;
|
|
#ifdef CONFIG_COMMON_CLK_DEBUG
|
|
struct dentry *dentry;
|
|
#endif
|
|
};
|
|
|
|
/*
|
|
* DOC: Basic clock implementations common to many platforms
|
|
*
|
|
* Each basic clock hardware type is comprised of a structure describing the
|
|
* clock hardware, implementations of the relevant callbacks in struct clk_ops,
|
|
* unique flags for that hardware type, a registration function and an
|
|
* alternative macro for static initialization
|
|
*/
|
|
|
|
#define DEFINE_CLK(_name, _ops, _flags, _parent_names, \
|
|
_parents) \
|
|
static struct clk _name = { \
|
|
.name = #_name, \
|
|
.ops = &_ops, \
|
|
.hw = &_name##_hw.hw, \
|
|
.parent_names = _parent_names, \
|
|
.num_parents = ARRAY_SIZE(_parent_names), \
|
|
.parents = _parents, \
|
|
.flags = _flags, \
|
|
}
|
|
|
|
#define DEFINE_CLK_FIXED_RATE(_name, _flags, _rate, \
|
|
_fixed_rate_flags) \
|
|
static struct clk _name; \
|
|
static const char *_name##_parent_names[] = {}; \
|
|
static struct clk_fixed_rate _name##_hw = { \
|
|
.hw = { \
|
|
.clk = &_name, \
|
|
}, \
|
|
.fixed_rate = _rate, \
|
|
.flags = _fixed_rate_flags, \
|
|
}; \
|
|
DEFINE_CLK(_name, clk_fixed_rate_ops, _flags, \
|
|
_name##_parent_names, NULL);
|
|
|
|
#define DEFINE_CLK_GATE(_name, _parent_name, _parent_ptr, \
|
|
_flags, _reg, _bit_idx, \
|
|
_gate_flags, _lock) \
|
|
static struct clk _name; \
|
|
static const char *_name##_parent_names[] = { \
|
|
_parent_name, \
|
|
}; \
|
|
static struct clk *_name##_parents[] = { \
|
|
_parent_ptr, \
|
|
}; \
|
|
static struct clk_gate _name##_hw = { \
|
|
.hw = { \
|
|
.clk = &_name, \
|
|
}, \
|
|
.reg = _reg, \
|
|
.bit_idx = _bit_idx, \
|
|
.flags = _gate_flags, \
|
|
.lock = _lock, \
|
|
}; \
|
|
DEFINE_CLK(_name, clk_gate_ops, _flags, \
|
|
_name##_parent_names, _name##_parents);
|
|
|
|
#define DEFINE_CLK_DIVIDER(_name, _parent_name, _parent_ptr, \
|
|
_flags, _reg, _shift, _width, \
|
|
_divider_flags, _lock) \
|
|
static struct clk _name; \
|
|
static const char *_name##_parent_names[] = { \
|
|
_parent_name, \
|
|
}; \
|
|
static struct clk *_name##_parents[] = { \
|
|
_parent_ptr, \
|
|
}; \
|
|
static struct clk_divider _name##_hw = { \
|
|
.hw = { \
|
|
.clk = &_name, \
|
|
}, \
|
|
.reg = _reg, \
|
|
.shift = _shift, \
|
|
.width = _width, \
|
|
.flags = _divider_flags, \
|
|
.lock = _lock, \
|
|
}; \
|
|
DEFINE_CLK(_name, clk_divider_ops, _flags, \
|
|
_name##_parent_names, _name##_parents);
|
|
|
|
#define DEFINE_CLK_MUX(_name, _parent_names, _parents, _flags, \
|
|
_reg, _shift, _width, \
|
|
_mux_flags, _lock) \
|
|
static struct clk _name; \
|
|
static struct clk_mux _name##_hw = { \
|
|
.hw = { \
|
|
.clk = &_name, \
|
|
}, \
|
|
.reg = _reg, \
|
|
.shift = _shift, \
|
|
.width = _width, \
|
|
.flags = _mux_flags, \
|
|
.lock = _lock, \
|
|
}; \
|
|
DEFINE_CLK(_name, clk_mux_ops, _flags, _parent_names, \
|
|
_parents);
|
|
|
|
#define DEFINE_CLK_FIXED_FACTOR(_name, _parent_name, \
|
|
_parent_ptr, _flags, \
|
|
_mult, _div) \
|
|
static struct clk _name; \
|
|
static const char *_name##_parent_names[] = { \
|
|
_parent_name, \
|
|
}; \
|
|
static struct clk *_name##_parents[] = { \
|
|
_parent_ptr, \
|
|
}; \
|
|
static struct clk_fixed_factor _name##_hw = { \
|
|
.hw = { \
|
|
.clk = &_name, \
|
|
}, \
|
|
.mult = _mult, \
|
|
.div = _div, \
|
|
}; \
|
|
DEFINE_CLK(_name, clk_fixed_factor_ops, _flags, \
|
|
_name##_parent_names, _name##_parents);
|
|
|
|
/**
|
|
* __clk_init - initialize the data structures in a struct clk
|
|
* @dev: device initializing this clk, placeholder for now
|
|
* @clk: clk being initialized
|
|
*
|
|
* Initializes the lists in struct clk, queries the hardware for the
|
|
* parent and rate and sets them both.
|
|
*
|
|
* Any struct clk passed into __clk_init must have the following members
|
|
* populated:
|
|
* .name
|
|
* .ops
|
|
* .hw
|
|
* .parent_names
|
|
* .num_parents
|
|
* .flags
|
|
*
|
|
* It is not necessary to call clk_register if __clk_init is used directly with
|
|
* statically initialized clock data.
|
|
*
|
|
* Returns 0 on success, otherwise an error code.
|
|
*/
|
|
int __clk_init(struct device *dev, struct clk *clk);
|
|
|
|
struct clk *__clk_register(struct device *dev, struct clk_hw *hw);
|
|
|
|
#endif /* CONFIG_COMMON_CLK */
|
|
#endif /* CLK_PRIVATE_H */
|