2008-08-19 16:08:43 +08:00
|
|
|
/*
|
2009-02-03 17:10:03 +08:00
|
|
|
* arch/arm/plat-omap/include/mach/clockdomain.h
|
2008-08-19 16:08:43 +08:00
|
|
|
*
|
|
|
|
|
* OMAP2/3 clockdomain framework functions
|
|
|
|
|
*
|
|
|
|
|
* Copyright (C) 2008 Texas Instruments, Inc.
|
2010-01-27 11:12:59 +08:00
|
|
|
* Copyright (C) 2008-2009 Nokia Corporation
|
2008-08-19 16:08:43 +08:00
|
|
|
*
|
|
|
|
|
* 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
|
|
|
|
|
|
2009-10-21 00:40:47 +08:00
|
|
|
#include <plat/powerdomain.h>
|
|
|
|
|
#include <plat/clock.h>
|
|
|
|
|
#include <plat/cpu.h>
|
2008-08-19 16:08:43 +08:00
|
|
|
|
|
|
|
|
/* 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
|
|
|
|
|
|
|
|
|
|
/*
|
2010-01-27 11:12:59 +08:00
|
|
|
* 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
|
2008-08-19 16:08:43 +08:00
|
|
|
* inactive in hwsup mode.
|
|
|
|
|
*/
|
2010-01-27 11:12:59 +08:00
|
|
|
struct clkdm_autodep {
|
2008-08-19 16:08:43 +08:00
|
|
|
|
2009-02-03 17:10:03 +08:00
|
|
|
union {
|
2010-01-27 11:12:59 +08:00
|
|
|
/* Name of the clockdomain to add a wkdep/sleepdep on */
|
2009-02-03 17:10:03 +08:00
|
|
|
const char *name;
|
2008-08-19 16:08:43 +08:00
|
|
|
|
2010-01-27 11:12:59 +08:00
|
|
|
/* Clockdomain pointer (looked up at clkdm_init() time) */
|
|
|
|
|
struct clockdomain *ptr;
|
|
|
|
|
} clkdm;
|
2008-08-19 16:08:43 +08:00
|
|
|
|
|
|
|
|
/* OMAP chip types that this clockdomain dep is valid on */
|
|
|
|
|
const struct omap_chip_id omap_chip;
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
2010-01-27 11:12:59 +08:00
|
|
|
/* 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;
|
|
|
|
|
|
OMAP clockdomains: add usecounting for wakeup and sleep dependencies
Add usecounting for wakeup and sleep dependencies. In the current
situation, if several functions add dependencies on the same
clockdomains, when the first dependency removal function is called,
the dependency will be incorrectly removed from the hardware.
Add clkdm_clear_all_wkdeps() and clkdm_clear_all_sleepdeps(), which
provide a fast and usecounting-consistent way to clear all hardware
clockdomain dependencies, since accesses to these registers can be
quite slow. pm{2,3}4xx.c has been updated to use these new functions.
The original version of this patch did not touch these files, which
previously wrote directly to the wkdep registers, and thus confused
the usecounting code. This problem was found by Kevin Hilman
<khilman@deeprootsystems.com>.
N.B.: This patch introduces one significant functional difference over
the previous pm34xx.c code: sleepdeps are now cleared during
clockdomain initialization, whereas previously they were left
untouched. This has been tested by Kevin and confirmed to work.
The original version of this patch also did not take into
consideration that some clockdomains do not have sleep or wakeup
dependency sources, which caused NULL pointer dereferences. This
problem was debugged and fixed by Kevin Hilman
<khilman@deeprootsystems.com>.
Signed-off-by: Paul Walmsley <paul@pwsan.com>
Signed-off-by: Kevin Hilman <khilman@deeprootsystems.com>
Cc: Jouni Högander <jouni.hogander@nokia.com>
2010-01-27 11:13:01 +08:00
|
|
|
/* Number of wakeup dependencies causing this clkdm to wake */
|
|
|
|
|
atomic_t wkdep_usecount;
|
|
|
|
|
|
|
|
|
|
/* Number of sleep dependencies that could prevent clkdm from idle */
|
|
|
|
|
atomic_t sleepdep_usecount;
|
|
|
|
|
|
2010-01-27 11:12:59 +08:00
|
|
|
/* Flags to mark OMAP chip restrictions, etc. */
|
|
|
|
|
const struct omap_chip_id omap_chip;
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
2008-08-19 16:08:43 +08:00
|
|
|
struct clockdomain {
|
|
|
|
|
|
|
|
|
|
/* Clockdomain name */
|
|
|
|
|
const char *name;
|
|
|
|
|
|
2009-02-03 17:10:03 +08:00
|
|
|
union {
|
|
|
|
|
/* Powerdomain enclosing this clockdomain */
|
|
|
|
|
const char *name;
|
|
|
|
|
|
|
|
|
|
/* Powerdomain pointer assigned at clkdm_register() */
|
|
|
|
|
struct powerdomain *ptr;
|
|
|
|
|
} pwrdm;
|
2008-08-19 16:08:43 +08:00
|
|
|
|
2010-01-27 11:12:53 +08:00
|
|
|
/* CLKSTCTRL reg for the given clock domain*/
|
|
|
|
|
void __iomem *clkstctrl_reg;
|
|
|
|
|
|
2008-08-19 16:08:43 +08:00
|
|
|
/* CLKTRCTRL/AUTOSTATE field mask in CM_CLKSTCTRL reg */
|
|
|
|
|
const u16 clktrctrl_mask;
|
|
|
|
|
|
|
|
|
|
/* Clockdomain capability flags */
|
|
|
|
|
const u8 flags;
|
|
|
|
|
|
2010-01-27 11:12:59 +08:00
|
|
|
/* 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;
|
|
|
|
|
|
2008-08-19 16:08:43 +08:00
|
|
|
/* 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;
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
2010-01-27 11:12:59 +08:00
|
|
|
void clkdm_init(struct clockdomain **clkdms, struct clkdm_autodep *autodeps);
|
2008-08-19 16:08:43 +08:00
|
|
|
struct clockdomain *clkdm_lookup(const char *name);
|
|
|
|
|
|
2008-10-15 23:13:47 +08:00
|
|
|
int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user),
|
|
|
|
|
void *user);
|
2008-08-19 16:08:43 +08:00
|
|
|
struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm);
|
|
|
|
|
|
2010-01-27 11:12:59 +08:00
|
|
|
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);
|
OMAP clockdomains: add usecounting for wakeup and sleep dependencies
Add usecounting for wakeup and sleep dependencies. In the current
situation, if several functions add dependencies on the same
clockdomains, when the first dependency removal function is called,
the dependency will be incorrectly removed from the hardware.
Add clkdm_clear_all_wkdeps() and clkdm_clear_all_sleepdeps(), which
provide a fast and usecounting-consistent way to clear all hardware
clockdomain dependencies, since accesses to these registers can be
quite slow. pm{2,3}4xx.c has been updated to use these new functions.
The original version of this patch did not touch these files, which
previously wrote directly to the wkdep registers, and thus confused
the usecounting code. This problem was found by Kevin Hilman
<khilman@deeprootsystems.com>.
N.B.: This patch introduces one significant functional difference over
the previous pm34xx.c code: sleepdeps are now cleared during
clockdomain initialization, whereas previously they were left
untouched. This has been tested by Kevin and confirmed to work.
The original version of this patch also did not take into
consideration that some clockdomains do not have sleep or wakeup
dependency sources, which caused NULL pointer dereferences. This
problem was debugged and fixed by Kevin Hilman
<khilman@deeprootsystems.com>.
Signed-off-by: Paul Walmsley <paul@pwsan.com>
Signed-off-by: Kevin Hilman <khilman@deeprootsystems.com>
Cc: Jouni Högander <jouni.hogander@nokia.com>
2010-01-27 11:13:01 +08:00
|
|
|
int clkdm_clear_all_wkdeps(struct clockdomain *clkdm);
|
2010-01-27 11:12:59 +08:00
|
|
|
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);
|
OMAP clockdomains: add usecounting for wakeup and sleep dependencies
Add usecounting for wakeup and sleep dependencies. In the current
situation, if several functions add dependencies on the same
clockdomains, when the first dependency removal function is called,
the dependency will be incorrectly removed from the hardware.
Add clkdm_clear_all_wkdeps() and clkdm_clear_all_sleepdeps(), which
provide a fast and usecounting-consistent way to clear all hardware
clockdomain dependencies, since accesses to these registers can be
quite slow. pm{2,3}4xx.c has been updated to use these new functions.
The original version of this patch did not touch these files, which
previously wrote directly to the wkdep registers, and thus confused
the usecounting code. This problem was found by Kevin Hilman
<khilman@deeprootsystems.com>.
N.B.: This patch introduces one significant functional difference over
the previous pm34xx.c code: sleepdeps are now cleared during
clockdomain initialization, whereas previously they were left
untouched. This has been tested by Kevin and confirmed to work.
The original version of this patch also did not take into
consideration that some clockdomains do not have sleep or wakeup
dependency sources, which caused NULL pointer dereferences. This
problem was debugged and fixed by Kevin Hilman
<khilman@deeprootsystems.com>.
Signed-off-by: Paul Walmsley <paul@pwsan.com>
Signed-off-by: Kevin Hilman <khilman@deeprootsystems.com>
Cc: Jouni Högander <jouni.hogander@nokia.com>
2010-01-27 11:13:01 +08:00
|
|
|
int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm);
|
2010-01-27 11:12:59 +08:00
|
|
|
|
2008-08-19 16:08:43 +08:00
|
|
|
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
|