[deliverable/linux.git] / arch / arm / plat-omap / include / plat / clockdomain.h

/*
 * arch/arm/plat-omap/include/mach/clockdomain.h
 *
 * OMAP2/3 clockdomain framework functions
 *
 * Copyright (C) 2008 Texas Instruments, Inc.
 * Copyright (C) 2008-2009 Nokia Corporation
 *
 * Written by Paul Walmsley
 *
 * 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 __ASM_ARM_ARCH_OMAP_CLOCKDOMAIN_H
#define __ASM_ARM_ARCH_OMAP_CLOCKDOMAIN_H

#include <plat/powerdomain.h>
#include <plat/clock.h>
#include <plat/cpu.h>

/* Clockdomain capability flags */
#define CLKDM_CAN_FORCE_SLEEP			(1 << 0)
#define CLKDM_CAN_FORCE_WAKEUP			(1 << 1)
#define CLKDM_CAN_ENABLE_AUTO			(1 << 2)
#define CLKDM_CAN_DISABLE_AUTO			(1 << 3)

#define CLKDM_CAN_HWSUP		(CLKDM_CAN_ENABLE_AUTO | CLKDM_CAN_DISABLE_AUTO)
#define CLKDM_CAN_SWSUP		(CLKDM_CAN_FORCE_SLEEP | CLKDM_CAN_FORCE_WAKEUP)
#define CLKDM_CAN_HWSUP_SWSUP	(CLKDM_CAN_SWSUP | CLKDM_CAN_HWSUP)

/* OMAP24XX CM_CLKSTCTRL_*.AUTOSTATE_* register bit values */
#define OMAP24XX_CLKSTCTRL_DISABLE_AUTO		0x0
#define OMAP24XX_CLKSTCTRL_ENABLE_AUTO		0x1

/* OMAP3XXX CM_CLKSTCTRL_*.CLKTRCTRL_* register bit values */
#define OMAP34XX_CLKSTCTRL_DISABLE_AUTO		0x0
#define OMAP34XX_CLKSTCTRL_FORCE_SLEEP		0x1
#define OMAP34XX_CLKSTCTRL_FORCE_WAKEUP		0x2
#define OMAP34XX_CLKSTCTRL_ENABLE_AUTO		0x3

/*
 * struct clkdm_autodep - a clockdomain that should have wkdeps
 * and sleepdeps added when a clockdomain should stay active in hwsup mode;
 * and conversely, removed when the clockdomain should be allowed to go
 * inactive in hwsup mode.
 */
struct clkdm_autodep {

	union {
		/* Name of the clockdomain to add a wkdep/sleepdep on */
		const char *name;

		/* Clockdomain pointer (looked up at clkdm_init() time) */
		struct clockdomain *ptr;
	} clkdm;

	/* OMAP chip types that this clockdomain dep is valid on */
	const struct omap_chip_id omap_chip;

};

/* Encodes dependencies between clockdomains - statically defined */
struct clkdm_dep {

	/* Clockdomain name */
	const char *clkdm_name;

	/* Clockdomain pointer - resolved by the clockdomain code */
	struct clockdomain *clkdm;

	/* Flags to mark OMAP chip restrictions, etc. */
	const struct omap_chip_id omap_chip;

};

struct clockdomain {

	/* Clockdomain name */
	const char *name;

	union {
		/* Powerdomain enclosing this clockdomain */
		const char *name;

		/* Powerdomain pointer assigned at clkdm_register() */
		struct powerdomain *ptr;
	} pwrdm;

	/* CLKSTCTRL reg for the given clock domain*/
	void __iomem *clkstctrl_reg;

	/* CLKTRCTRL/AUTOSTATE field mask in CM_CLKSTCTRL reg */
	const u16 clktrctrl_mask;

	/* Clockdomain capability flags */
	const u8 flags;

	/* Bit shift of this clockdomain's PM_WKDEP/CM_SLEEPDEP bit */
	const u8 dep_bit;

	/* Clockdomains that can be told to wake this powerdomain up */
	struct clkdm_dep *wkdep_srcs;

	/* Clockdomains that can be told to keep this clkdm from inactivity */
	struct clkdm_dep *sleepdep_srcs;

	/* OMAP chip types that this clockdomain is valid on */
	const struct omap_chip_id omap_chip;

	/* Usecount tracking */
	atomic_t usecount;

	struct list_head node;

};

void clkdm_init(struct clockdomain **clkdms, struct clkdm_autodep *autodeps);
struct clockdomain *clkdm_lookup(const char *name);

int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user),
			void *user);
struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm);

int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);

void omap2_clkdm_allow_idle(struct clockdomain *clkdm);
void omap2_clkdm_deny_idle(struct clockdomain *clkdm);

int omap2_clkdm_wakeup(struct clockdomain *clkdm);
int omap2_clkdm_sleep(struct clockdomain *clkdm);

int omap2_clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk);
int omap2_clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk);

#endif
Commit	Line	Data
d459bfe0	1	/*
5b74c676	2	* arch/arm/plat-omap/include/mach/clockdomain.h
d459bfe0 PW	3	*
	4	* OMAP2/3 clockdomain framework functions
	5	*
	6	* Copyright (C) 2008 Texas Instruments, Inc.
55ed9694	7	* Copyright (C) 2008-2009 Nokia Corporation
d459bfe0 PW	8	*
	9	* Written by Paul Walmsley
	10	*
	11	* This program is free software; you can redistribute it and/or modify
	12	* it under the terms of the GNU General Public License version 2 as
	13	* published by the Free Software Foundation.
	14	*/
	15
	16	#ifndef __ASM_ARM_ARCH_OMAP_CLOCKDOMAIN_H
	17	#define __ASM_ARM_ARCH_OMAP_CLOCKDOMAIN_H
	18
ce491cf8 TL	19	#include <plat/powerdomain.h>
	20	#include <plat/clock.h>
	21	#include <plat/cpu.h>
d459bfe0 PW	22
	23	/* Clockdomain capability flags */
	24	#define CLKDM_CAN_FORCE_SLEEP (1 << 0)
	25	#define CLKDM_CAN_FORCE_WAKEUP (1 << 1)
	26	#define CLKDM_CAN_ENABLE_AUTO (1 << 2)
	27	#define CLKDM_CAN_DISABLE_AUTO (1 << 3)
	28
	29	#define CLKDM_CAN_HWSUP (CLKDM_CAN_ENABLE_AUTO \| CLKDM_CAN_DISABLE_AUTO)
	30	#define CLKDM_CAN_SWSUP (CLKDM_CAN_FORCE_SLEEP \| CLKDM_CAN_FORCE_WAKEUP)
	31	#define CLKDM_CAN_HWSUP_SWSUP (CLKDM_CAN_SWSUP \| CLKDM_CAN_HWSUP)
	32
	33	/* OMAP24XX CM_CLKSTCTRL_.AUTOSTATE_ register bit values */
	34	#define OMAP24XX_CLKSTCTRL_DISABLE_AUTO 0x0
	35	#define OMAP24XX_CLKSTCTRL_ENABLE_AUTO 0x1
	36
	37	/* OMAP3XXX CM_CLKSTCTRL_.CLKTRCTRL_ register bit values */
	38	#define OMAP34XX_CLKSTCTRL_DISABLE_AUTO 0x0
	39	#define OMAP34XX_CLKSTCTRL_FORCE_SLEEP 0x1
	40	#define OMAP34XX_CLKSTCTRL_FORCE_WAKEUP 0x2
	41	#define OMAP34XX_CLKSTCTRL_ENABLE_AUTO 0x3
	42
	43	/*
55ed9694 PW	44	* struct clkdm_autodep - a clockdomain that should have wkdeps
	45	* and sleepdeps added when a clockdomain should stay active in hwsup mode;
	46	* and conversely, removed when the clockdomain should be allowed to go
d459bfe0 PW	47	* inactive in hwsup mode.
d459bfe0 PW	48	*/
55ed9694	49	struct clkdm_autodep {
d459bfe0	50
5b74c676	51	union {
55ed9694	52	/* Name of the clockdomain to add a wkdep/sleepdep on */
5b74c676	53	const char *name;
d459bfe0	54
55ed9694 PW	55	/* Clockdomain pointer (looked up at clkdm_init() time) */
	56	struct clockdomain *ptr;
	57	} clkdm;
d459bfe0 PW	58
	59	/* OMAP chip types that this clockdomain dep is valid on */
	60	const struct omap_chip_id omap_chip;
	61
	62	};
	63
55ed9694 PW	64	/* Encodes dependencies between clockdomains - statically defined */
	65	struct clkdm_dep {
	66
	67	/* Clockdomain name */
	68	const char *clkdm_name;
	69
	70	/* Clockdomain pointer - resolved by the clockdomain code */
	71	struct clockdomain *clkdm;
	72
	73	/* Flags to mark OMAP chip restrictions, etc. */
	74	const struct omap_chip_id omap_chip;
	75
	76	};
	77
d459bfe0 PW	78	struct clockdomain {
	79
	80	/* Clockdomain name */
	81	const char *name;
	82
5b74c676 PW	83	union {
	84	/* Powerdomain enclosing this clockdomain */
	85	const char *name;
	86
	87	/* Powerdomain pointer assigned at clkdm_register() */
	88	struct powerdomain *ptr;
	89	} pwrdm;
d459bfe0	90
84c0c39a AP	91	/* CLKSTCTRL reg for the given clock domain*/
	92	void __iomem *clkstctrl_reg;
	93
d459bfe0 PW	94	/* CLKTRCTRL/AUTOSTATE field mask in CM_CLKSTCTRL reg */
	95	const u16 clktrctrl_mask;
	96
	97	/* Clockdomain capability flags */
	98	const u8 flags;
	99
55ed9694 PW	100	/* Bit shift of this clockdomain's PM_WKDEP/CM_SLEEPDEP bit */
	101	const u8 dep_bit;
	102
	103	/* Clockdomains that can be told to wake this powerdomain up */
	104	struct clkdm_dep *wkdep_srcs;
	105
	106	/* Clockdomains that can be told to keep this clkdm from inactivity */
	107	struct clkdm_dep *sleepdep_srcs;
	108
d459bfe0 PW	109	/* OMAP chip types that this clockdomain is valid on */
	110	const struct omap_chip_id omap_chip;
	111
	112	/* Usecount tracking */
	113	atomic_t usecount;
	114
d459bfe0 PW	115	struct list_head node;
	116
	117	};
	118
55ed9694	119	void clkdm_init(struct clockdomain *clkdms, struct clkdm_autodep autodeps);
d459bfe0 PW	120	struct clockdomain clkdm_lookup(const char name);
d459bfe0 PW	121
a23456e9 PDS	122	int clkdm_for_each(int (fn)(struct clockdomain clkdm, void *user),
a23456e9 PDS	123	void *user);
d459bfe0 PW	124	struct powerdomain clkdm_get_pwrdm(struct clockdomain clkdm);
d459bfe0 PW	125
55ed9694 PW	126	int clkdm_add_wkdep(struct clockdomain clkdm1, struct clockdomain clkdm2);
	127	int clkdm_del_wkdep(struct clockdomain clkdm1, struct clockdomain clkdm2);
	128	int clkdm_read_wkdep(struct clockdomain clkdm1, struct clockdomain clkdm2);
	129	int clkdm_add_sleepdep(struct clockdomain clkdm1, struct clockdomain clkdm2);
	130	int clkdm_del_sleepdep(struct clockdomain clkdm1, struct clockdomain clkdm2);
	131	int clkdm_read_sleepdep(struct clockdomain clkdm1, struct clockdomain clkdm2);
	132
d459bfe0 PW	133	void omap2_clkdm_allow_idle(struct clockdomain *clkdm);
	134	void omap2_clkdm_deny_idle(struct clockdomain *clkdm);
	135
	136	int omap2_clkdm_wakeup(struct clockdomain *clkdm);
	137	int omap2_clkdm_sleep(struct clockdomain *clkdm);
	138
	139	int omap2_clkdm_clk_enable(struct clockdomain clkdm, struct clk clk);
	140	int omap2_clkdm_clk_disable(struct clockdomain clkdm, struct clk clk);
	141
	142	#endif