f0271d65f9
This patch only affects documentation; no functional changes are included. Clean up comments in the current clockdomain, powerdomain code and header files. This mostly involves conversion to kerneldoc format, although some clarifications are also included. Signed-off-by: Paul Walmsley <paul@pwsan.com>
142 lines
4.9 KiB
C
142 lines
4.9 KiB
C
/*
|
|
* 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 - 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.
|
|
*/
|
|
struct clkdm_autodep {
|
|
union {
|
|
const char *name;
|
|
struct clockdomain *ptr;
|
|
} clkdm;
|
|
const struct omap_chip_id omap_chip;
|
|
};
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
struct clkdm_dep {
|
|
const char *clkdm_name;
|
|
struct clockdomain *clkdm;
|
|
atomic_t wkdep_usecount;
|
|
atomic_t sleepdep_usecount;
|
|
const struct omap_chip_id omap_chip;
|
|
};
|
|
|
|
/**
|
|
* 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
|
|
* @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
|
|
*/
|
|
struct clockdomain {
|
|
const char *name;
|
|
union {
|
|
const char *name;
|
|
struct powerdomain *ptr;
|
|
} pwrdm;
|
|
void __iomem *clkstctrl_reg;
|
|
const u16 clktrctrl_mask;
|
|
const u8 flags;
|
|
const u8 dep_bit;
|
|
struct clkdm_dep *wkdep_srcs;
|
|
struct clkdm_dep *sleepdep_srcs;
|
|
const struct omap_chip_id omap_chip;
|
|
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_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);
|
|
|
|
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
|