[linux.git] / include / media / v4l2-clk.h

/*
 * V4L2 clock service
 *
 * Copyright (C) 2012-2013, Guennadi Liakhovetski <[email protected]>
 *
 * 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.
 *
 * ATTENTION: This is a temporary API and it shall be replaced by the generic
 * clock API, when the latter becomes widely available.
 */

#ifndef MEDIA_V4L2_CLK_H
#define MEDIA_V4L2_CLK_H

#include <linux/atomic.h>
#include <linux/export.h>
#include <linux/list.h>
#include <linux/mutex.h>

struct module;
struct device;

struct clk;
struct v4l2_clk {
	struct list_head list;
	const struct v4l2_clk_ops *ops;
	const char *dev_id;
	int enable;
	struct mutex lock; /* Protect the enable count */
	atomic_t use_count;
	struct clk *clk;
	void *priv;
};

struct v4l2_clk_ops {
	struct module	*owner;
	int		(*enable)(struct v4l2_clk *clk);
	void		(*disable)(struct v4l2_clk *clk);
	unsigned long	(*get_rate)(struct v4l2_clk *clk);
	int		(*set_rate)(struct v4l2_clk *clk, unsigned long);
};

struct v4l2_clk *v4l2_clk_register(const struct v4l2_clk_ops *ops,
				   const char *dev_name,
				   void *priv);
void v4l2_clk_unregister(struct v4l2_clk *clk);
struct v4l2_clk *v4l2_clk_get(struct device *dev, const char *id);
void v4l2_clk_put(struct v4l2_clk *clk);
int v4l2_clk_enable(struct v4l2_clk *clk);
void v4l2_clk_disable(struct v4l2_clk *clk);
unsigned long v4l2_clk_get_rate(struct v4l2_clk *clk);
int v4l2_clk_set_rate(struct v4l2_clk *clk, unsigned long rate);

struct module;

struct v4l2_clk *__v4l2_clk_register_fixed(const char *dev_id,
			unsigned long rate, struct module *owner);
void v4l2_clk_unregister_fixed(struct v4l2_clk *clk);

static inline struct v4l2_clk *v4l2_clk_register_fixed(const char *dev_id,
							unsigned long rate)
{
	return __v4l2_clk_register_fixed(dev_id, rate, THIS_MODULE);
}

#define V4L2_CLK_NAME_SIZE 64

#define v4l2_clk_name_i2c(name, size, adap, client) snprintf(name, size, \
			  "%d-%04x", adap, client)

#define v4l2_clk_name_of(name, size, node) snprintf(name, size, \
			  "of-%pOF", node)

#endif
Commit	Line	Data
ff5430de GL	1	/*
	2	* V4L2 clock service
	3	*
	4	* Copyright (C) 2012-2013, Guennadi Liakhovetski <[email protected]>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2 as
	8	* published by the Free Software Foundation.
	9	*
	10	* ATTENTION: This is a temporary API and it shall be replaced by the generic
	11	* clock API, when the latter becomes widely available.
	12	*/
	13
	14	#ifndef MEDIA_V4L2_CLK_H
	15	#define MEDIA_V4L2_CLK_H
	16
	17	#include <linux/atomic.h>
cf326dfe	18	#include <linux/export.h>
ff5430de GL	19	#include <linux/list.h>
	20	#include <linux/mutex.h>
	21
	22	struct module;
	23	struct device;
	24
4f528afc	25	struct clk;
ff5430de GL	26	struct v4l2_clk {
	27	struct list_head list;
	28	const struct v4l2_clk_ops *ops;
	29	const char *dev_id;
ff5430de GL	30	int enable;
	31	struct mutex lock; /* Protect the enable count */
	32	atomic_t use_count;
4f528afc	33	struct clk *clk;
ff5430de GL	34	void *priv;
	35	};
	36
	37	struct v4l2_clk_ops {
	38	struct module *owner;
	39	int (enable)(struct v4l2_clk clk);
	40	void (disable)(struct v4l2_clk clk);
	41	unsigned long (get_rate)(struct v4l2_clk clk);
	42	int (set_rate)(struct v4l2_clk clk, unsigned long);
	43	};
	44
	45	struct v4l2_clk v4l2_clk_register(const struct v4l2_clk_ops ops,
	46	const char *dev_name,
a37462b9	47	void *priv);
ff5430de GL	48	void v4l2_clk_unregister(struct v4l2_clk *clk);
	49	struct v4l2_clk v4l2_clk_get(struct device dev, const char *id);
	50	void v4l2_clk_put(struct v4l2_clk *clk);
	51	int v4l2_clk_enable(struct v4l2_clk *clk);
	52	void v4l2_clk_disable(struct v4l2_clk *clk);
	53	unsigned long v4l2_clk_get_rate(struct v4l2_clk *clk);
	54	int v4l2_clk_set_rate(struct v4l2_clk *clk, unsigned long rate);
	55
cf326dfe GL	56	struct module;
	57
	58	struct v4l2_clk __v4l2_clk_register_fixed(const char dev_id,
a37462b9	59	unsigned long rate, struct module *owner);
cf326dfe GL	60	void v4l2_clk_unregister_fixed(struct v4l2_clk *clk);
	61
	62	static inline struct v4l2_clk v4l2_clk_register_fixed(const char dev_id,
cf326dfe GL	63	unsigned long rate)
cf326dfe GL	64	{
a37462b9	65	return __v4l2_clk_register_fixed(dev_id, rate, THIS_MODULE);
cf326dfe GL	66	}
cf326dfe GL	67
3d83078a JW	68	#define V4L2_CLK_NAME_SIZE 64
3d83078a JW	69
774cc4c2 GL	70	#define v4l2_clk_name_i2c(name, size, adap, client) snprintf(name, size, \
	71	"%d-%04x", adap, client)
	72
68d9c47b RH	73	#define v4l2_clk_name_of(name, size, node) snprintf(name, size, \
68d9c47b RH	74	"of-%pOF", node)
ac2841f3	75
ff5430de	76	#endif