1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * V4L2 clock service
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright (C) 2012-2013, Guennadi Liakhovetski <g.liakhovetski@gmx.de>
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * ATTENTION: This is a temporary API and it shall be replaced by the generic
8*4882a593Smuzhiyun * clock API, when the latter becomes widely available.
9*4882a593Smuzhiyun */
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun #ifndef MEDIA_V4L2_CLK_H
12*4882a593Smuzhiyun #define MEDIA_V4L2_CLK_H
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun #include <linux/atomic.h>
15*4882a593Smuzhiyun #include <linux/export.h>
16*4882a593Smuzhiyun #include <linux/list.h>
17*4882a593Smuzhiyun #include <linux/mutex.h>
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun struct module;
20*4882a593Smuzhiyun struct device;
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun struct clk;
23*4882a593Smuzhiyun struct v4l2_clk {
24*4882a593Smuzhiyun struct list_head list;
25*4882a593Smuzhiyun const struct v4l2_clk_ops *ops;
26*4882a593Smuzhiyun const char *dev_id;
27*4882a593Smuzhiyun int enable;
28*4882a593Smuzhiyun struct mutex lock; /* Protect the enable count */
29*4882a593Smuzhiyun atomic_t use_count;
30*4882a593Smuzhiyun struct clk *clk;
31*4882a593Smuzhiyun void *priv;
32*4882a593Smuzhiyun };
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun struct v4l2_clk_ops {
35*4882a593Smuzhiyun struct module *owner;
36*4882a593Smuzhiyun int (*enable)(struct v4l2_clk *clk);
37*4882a593Smuzhiyun void (*disable)(struct v4l2_clk *clk);
38*4882a593Smuzhiyun unsigned long (*get_rate)(struct v4l2_clk *clk);
39*4882a593Smuzhiyun int (*set_rate)(struct v4l2_clk *clk, unsigned long);
40*4882a593Smuzhiyun };
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun struct v4l2_clk *v4l2_clk_register(const struct v4l2_clk_ops *ops,
43*4882a593Smuzhiyun const char *dev_name,
44*4882a593Smuzhiyun void *priv);
45*4882a593Smuzhiyun void v4l2_clk_unregister(struct v4l2_clk *clk);
46*4882a593Smuzhiyun struct v4l2_clk *v4l2_clk_get(struct device *dev, const char *id);
47*4882a593Smuzhiyun void v4l2_clk_put(struct v4l2_clk *clk);
48*4882a593Smuzhiyun int v4l2_clk_enable(struct v4l2_clk *clk);
49*4882a593Smuzhiyun void v4l2_clk_disable(struct v4l2_clk *clk);
50*4882a593Smuzhiyun unsigned long v4l2_clk_get_rate(struct v4l2_clk *clk);
51*4882a593Smuzhiyun int v4l2_clk_set_rate(struct v4l2_clk *clk, unsigned long rate);
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun struct module;
54*4882a593Smuzhiyun
55*4882a593Smuzhiyun struct v4l2_clk *__v4l2_clk_register_fixed(const char *dev_id,
56*4882a593Smuzhiyun unsigned long rate, struct module *owner);
57*4882a593Smuzhiyun void v4l2_clk_unregister_fixed(struct v4l2_clk *clk);
58*4882a593Smuzhiyun
v4l2_clk_register_fixed(const char * dev_id,unsigned long rate)59*4882a593Smuzhiyun static inline struct v4l2_clk *v4l2_clk_register_fixed(const char *dev_id,
60*4882a593Smuzhiyun unsigned long rate)
61*4882a593Smuzhiyun {
62*4882a593Smuzhiyun return __v4l2_clk_register_fixed(dev_id, rate, THIS_MODULE);
63*4882a593Smuzhiyun }
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun #define V4L2_CLK_NAME_SIZE 64
66*4882a593Smuzhiyun
67*4882a593Smuzhiyun #define v4l2_clk_name_i2c(name, size, adap, client) snprintf(name, size, \
68*4882a593Smuzhiyun "%d-%04x", adap, client)
69*4882a593Smuzhiyun
70*4882a593Smuzhiyun #define v4l2_clk_name_of(name, size, node) snprintf(name, size, \
71*4882a593Smuzhiyun "of-%pOF", node)
72*4882a593Smuzhiyun
73*4882a593Smuzhiyun #endif
74