2008-08-19 08:08:43 +00:00
|
|
|
/*
|
2009-02-03 09:10:03 +00:00
|
|
|
* arch/arm/plat-omap/include/mach/clockdomain.h
|
2008-08-19 08:08:43 +00:00
|
|
|
*
|
|
|
|
|
* OMAP2/3 clockdomain framework functions
|
|
|
|
|
*
|
|
|
|
|
* Copyright (C) 2008 Texas Instruments, Inc.
|
2011-03-10 10:50:09 +00:00
|
|
|
* Copyright (C) 2008-2011 Nokia Corporation
|
2008-08-19 08:08:43 +00:00
|
|
|
*
|
2010-12-22 03:01:20 +00:00
|
|
|
* Paul Walmsley
|
2008-08-19 08:08:43 +00:00
|
|
|
*
|
|
|
|
|
* 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.
|
|
|
|
|
*/
|
|
|
|
|
|
2010-12-22 04:05:15 +00:00
|
|
|
#ifndef __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H
|
|
|
|
|
#define __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H
|
2008-08-19 08:08:43 +00:00
|
|
|
|
2010-12-22 03:01:20 +00:00
|
|
|
#include <linux/init.h>
|
|
|
|
|
|
2010-12-22 04:05:16 +00:00
|
|
|
#include "powerdomain.h"
|
2009-10-20 16:40:47 +00:00
|
|
|
#include <plat/clock.h>
|
|
|
|
|
#include <plat/cpu.h>
|
2008-08-19 08:08:43 +00:00
|
|
|
|
2011-03-10 10:50:09 +00:00
|
|
|
/*
|
|
|
|
|
* Clockdomain flags
|
|
|
|
|
*
|
|
|
|
|
* XXX Document CLKDM_CAN_* flags
|
|
|
|
|
*
|
|
|
|
|
* CLKDM_NO_AUTODEPS: Prevent "autodeps" from being added/removed from this
|
|
|
|
|
* clockdomain. (Currently, this applies to OMAP3 clockdomains only.)
|
|
|
|
|
*/
|
2008-08-19 08:08:43 +00:00
|
|
|
#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)
|
2011-03-10 10:50:09 +00:00
|
|
|
#define CLKDM_NO_AUTODEPS (1 << 4)
|
2008-08-19 08:08:43 +00:00
|
|
|
|
|
|
|
|
#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)
|
|
|
|
|
|
2010-01-27 03:13:02 +00:00
|
|
|
/**
|
|
|
|
|
* struct clkdm_autodep - clkdm deps to add when entering/exiting hwsup mode
|
|
|
|
|
* @clkdm: clockdomain to add wkdep+sleepdep on - set name member only
|
|
|
|
|
* @omap_chip: OMAP chip types that this autodep is valid on
|
|
|
|
|
*
|
|
|
|
|
* 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.
|
|
|
|
|
*
|
|
|
|
|
* Autodeps are deprecated and should be removed after
|
|
|
|
|
* omap_hwmod-based fine-grained module idle control is added.
|
2008-08-19 08:08:43 +00:00
|
|
|
*/
|
2010-01-27 03:12:59 +00:00
|
|
|
struct clkdm_autodep {
|
2009-02-03 09:10:03 +00:00
|
|
|
union {
|
|
|
|
|
const char *name;
|
2010-01-27 03:12:59 +00:00
|
|
|
struct clockdomain *ptr;
|
|
|
|
|
} clkdm;
|
2008-08-19 08:08:43 +00:00
|
|
|
const struct omap_chip_id omap_chip;
|
|
|
|
|
};
|
|
|
|
|
|
2010-01-27 03:13:02 +00:00
|
|
|
/**
|
|
|
|
|
* struct clkdm_dep - encode dependencies between clockdomains
|
|
|
|
|
* @clkdm_name: clockdomain name
|
|
|
|
|
* @clkdm: pointer to the struct clockdomain of @clkdm_name
|
|
|
|
|
* @omap_chip: OMAP chip types that this dependency is valid on
|
|
|
|
|
* @wkdep_usecount: Number of wakeup dependencies causing this clkdm to wake
|
|
|
|
|
* @sleepdep_usecount: Number of sleep deps that could prevent clkdm from idle
|
|
|
|
|
*
|
|
|
|
|
* Statically defined. @clkdm is resolved from @clkdm_name at runtime and
|
|
|
|
|
* should not be pre-initialized.
|
|
|
|
|
*
|
|
|
|
|
* XXX Should also include hardware (fixed) dependencies.
|
|
|
|
|
*/
|
2010-01-27 03:12:59 +00:00
|
|
|
struct clkdm_dep {
|
|
|
|
|
const char *clkdm_name;
|
|
|
|
|
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 03:13:01 +00:00
|
|
|
atomic_t wkdep_usecount;
|
|
|
|
|
atomic_t sleepdep_usecount;
|
2010-01-27 03:12:59 +00:00
|
|
|
const struct omap_chip_id omap_chip;
|
|
|
|
|
};
|
|
|
|
|
|
2010-01-27 03:13:02 +00:00
|
|
|
/**
|
|
|
|
|
* struct clockdomain - OMAP clockdomain
|
|
|
|
|
* @name: clockdomain name
|
|
|
|
|
* @pwrdm: powerdomain containing this clockdomain
|
|
|
|
|
* @clktrctrl_reg: CLKSTCTRL reg for the given clock domain
|
|
|
|
|
* @clktrctrl_mask: CLKTRCTRL/AUTOSTATE field mask in CM_CLKSTCTRL reg
|
|
|
|
|
* @flags: Clockdomain capability flags
|
|
|
|
|
* @dep_bit: Bit shift of this clockdomain's PM_WKDEP/CM_SLEEPDEP bit
|
2010-12-22 04:05:15 +00:00
|
|
|
* @prcm_partition: (OMAP4 only) PRCM partition ID for this clkdm's registers
|
|
|
|
|
* @cm_inst: (OMAP4 only) CM instance register offset
|
|
|
|
|
* @clkdm_offs: (OMAP4 only) CM clockdomain register offset
|
2010-01-27 03:13:02 +00:00
|
|
|
* @wkdep_srcs: Clockdomains that can be told to wake this powerdomain up
|
|
|
|
|
* @sleepdep_srcs: Clockdomains that can be told to keep this clkdm from inact
|
|
|
|
|
* @omap_chip: OMAP chip types that this clockdomain is valid on
|
|
|
|
|
* @usecount: Usecount tracking
|
|
|
|
|
* @node: list_head to link all clockdomains together
|
2010-12-22 04:05:15 +00:00
|
|
|
*
|
|
|
|
|
* @prcm_partition should be a macro from mach-omap2/prcm44xx.h (OMAP4 only)
|
|
|
|
|
* @cm_inst should be a macro ending in _INST from the OMAP4 CM instance
|
|
|
|
|
* definitions (OMAP4 only)
|
|
|
|
|
* @clkdm_offs should be a macro ending in _CDOFFS from the OMAP4 CM instance
|
|
|
|
|
* definitions (OMAP4 only)
|
2010-01-27 03:13:02 +00:00
|
|
|
*/
|
2008-08-19 08:08:43 +00:00
|
|
|
struct clockdomain {
|
|
|
|
|
const char *name;
|
2009-02-03 09:10:03 +00:00
|
|
|
union {
|
|
|
|
|
const char *name;
|
|
|
|
|
struct powerdomain *ptr;
|
|
|
|
|
} pwrdm;
|
2008-08-19 08:08:43 +00:00
|
|
|
const u16 clktrctrl_mask;
|
|
|
|
|
const u8 flags;
|
2010-01-27 03:12:59 +00:00
|
|
|
const u8 dep_bit;
|
2010-12-22 04:05:15 +00:00
|
|
|
const u8 prcm_partition;
|
|
|
|
|
const s16 cm_inst;
|
|
|
|
|
const u16 clkdm_offs;
|
2010-01-27 03:12:59 +00:00
|
|
|
struct clkdm_dep *wkdep_srcs;
|
|
|
|
|
struct clkdm_dep *sleepdep_srcs;
|
2008-08-19 08:08:43 +00:00
|
|
|
const struct omap_chip_id omap_chip;
|
|
|
|
|
atomic_t usecount;
|
|
|
|
|
struct list_head node;
|
|
|
|
|
};
|
|
|
|
|
|
2011-02-25 23:06:47 +00:00
|
|
|
/**
|
2011-03-31 01:57:33 +00:00
|
|
|
* struct clkdm_ops - Arch specific function implementations
|
2011-02-25 23:06:47 +00:00
|
|
|
* @clkdm_add_wkdep: Add a wakeup dependency between clk domains
|
|
|
|
|
* @clkdm_del_wkdep: Delete a wakeup dependency between clk domains
|
|
|
|
|
* @clkdm_read_wkdep: Read wakeup dependency state between clk domains
|
|
|
|
|
* @clkdm_clear_all_wkdeps: Remove all wakeup dependencies from the clk domain
|
|
|
|
|
* @clkdm_add_sleepdep: Add a sleep dependency between clk domains
|
|
|
|
|
* @clkdm_del_sleepdep: Delete a sleep dependency between clk domains
|
|
|
|
|
* @clkdm_read_sleepdep: Read sleep dependency state between clk domains
|
|
|
|
|
* @clkdm_clear_all_sleepdeps: Remove all sleep dependencies from the clk domain
|
|
|
|
|
* @clkdm_sleep: Force a clockdomain to sleep
|
|
|
|
|
* @clkdm_wakeup: Force a clockdomain to wakeup
|
|
|
|
|
* @clkdm_allow_idle: Enable hw supervised idle transitions for clock domain
|
|
|
|
|
* @clkdm_deny_idle: Disable hw supervised idle transitions for clock domain
|
|
|
|
|
* @clkdm_clk_enable: Put the clkdm in right state for a clock enable
|
|
|
|
|
* @clkdm_clk_disable: Put the clkdm in right state for a clock disable
|
|
|
|
|
*/
|
|
|
|
|
struct clkdm_ops {
|
|
|
|
|
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_clear_all_wkdeps)(struct clockdomain *clkdm);
|
|
|
|
|
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);
|
|
|
|
|
int (*clkdm_clear_all_sleepdeps)(struct clockdomain *clkdm);
|
|
|
|
|
int (*clkdm_sleep)(struct clockdomain *clkdm);
|
|
|
|
|
int (*clkdm_wakeup)(struct clockdomain *clkdm);
|
|
|
|
|
void (*clkdm_allow_idle)(struct clockdomain *clkdm);
|
|
|
|
|
void (*clkdm_deny_idle)(struct clockdomain *clkdm);
|
|
|
|
|
int (*clkdm_clk_enable)(struct clockdomain *clkdm);
|
|
|
|
|
int (*clkdm_clk_disable)(struct clockdomain *clkdm);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
void clkdm_init(struct clockdomain **clkdms, struct clkdm_autodep *autodeps,
|
|
|
|
|
struct clkdm_ops *custom_funcs);
|
2008-08-19 08:08:43 +00:00
|
|
|
struct clockdomain *clkdm_lookup(const char *name);
|
|
|
|
|
|
2008-10-15 15:13:47 +00:00
|
|
|
int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user),
|
|
|
|
|
void *user);
|
2008-08-19 08:08:43 +00:00
|
|
|
struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm);
|
|
|
|
|
|
2010-01-27 03:12:59 +00: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 03:13:01 +00:00
|
|
|
int clkdm_clear_all_wkdeps(struct clockdomain *clkdm);
|
2010-01-27 03:12:59 +00: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 03:13:01 +00:00
|
|
|
int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm);
|
2010-01-27 03:12:59 +00:00
|
|
|
|
2011-02-25 23:06:48 +00:00
|
|
|
void clkdm_allow_idle(struct clockdomain *clkdm);
|
|
|
|
|
void clkdm_deny_idle(struct clockdomain *clkdm);
|
2008-08-19 08:08:43 +00:00
|
|
|
|
2011-02-25 23:06:47 +00:00
|
|
|
int clkdm_wakeup(struct clockdomain *clkdm);
|
|
|
|
|
int clkdm_sleep(struct clockdomain *clkdm);
|
2008-08-19 08:08:43 +00:00
|
|
|
|
2011-02-25 23:06:48 +00:00
|
|
|
int clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk);
|
|
|
|
|
int clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk);
|
2008-08-19 08:08:43 +00:00
|
|
|
|
2011-02-25 23:06:47 +00:00
|
|
|
extern void __init omap2xxx_clockdomains_init(void);
|
|
|
|
|
extern void __init omap3xxx_clockdomains_init(void);
|
2010-12-22 03:01:20 +00:00
|
|
|
extern void __init omap44xx_clockdomains_init(void);
|
2011-02-25 23:06:48 +00:00
|
|
|
extern void _clkdm_add_autodeps(struct clockdomain *clkdm);
|
|
|
|
|
extern void _clkdm_del_autodeps(struct clockdomain *clkdm);
|
2010-12-22 03:01:20 +00:00
|
|
|
|
2011-02-25 23:06:47 +00:00
|
|
|
extern struct clkdm_ops omap2_clkdm_operations;
|
|
|
|
|
extern struct clkdm_ops omap3_clkdm_operations;
|
2011-02-25 23:06:47 +00:00
|
|
|
extern struct clkdm_ops omap4_clkdm_operations;
|
2010-12-22 03:01:20 +00:00
|
|
|
|
2008-08-19 08:08:43 +00:00
|
|
|
#endif
|
