2 * OMAP Voltage Management Routines
4 * Author: Thara Gopinath <thara@ti.com>
6 * Copyright (C) 2009 Texas Instruments, Inc.
7 * Thara Gopinath <thara@ti.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #ifndef __ARCH_ARM_MACH_OMAP2_VOLTAGE_H
15 #define __ARCH_ARM_MACH_OMAP2_VOLTAGE_H
17 #include <linux/err.h>
25 #define VOLTSCALE_VPFORCEUPDATE 1
26 #define VOLTSCALE_VCBYPASS 2
29 * OMAP3 GENERIC setup times. Revisit to see if these needs to be
30 * passed from board or PMIC file
32 #define OMAP3_CLKSETUP 0xff
33 #define OMAP3_VOLTOFFSET 0xff
34 #define OMAP3_VOLTSETUP2 0xff
39 * struct omap_vfsm_instance_data - per-voltage manager FSM register/bitfield
41 * @voltsetup_mask: SETUP_TIME* bitmask in the PRM_VOLTSETUP* register
42 * @voltsetup_reg: register offset of PRM_VOLTSETUP from PRM base
43 * @voltsetup_shift: SETUP_TIME* field shift in the PRM_VOLTSETUP* register
45 * XXX What about VOLTOFFSET/VOLTCTRL?
46 * XXX It is not necessary to have both a _mask and a _shift for the same
47 * bitfield - remove one!
49 struct omap_vfsm_instance_data {
56 * struct voltagedomain - omap voltage domain global structure.
57 * @name: Name of the voltage domain which can be used as a unique identifier.
58 * @scalable: Whether or not this voltage domain is scalable
59 * @node: list_head linking all voltage domains
60 * @pwrdm_list: list_head linking all powerdomains in this voltagedomain
61 * @vc: pointer to VC channel associated with this voltagedomain
64 struct voltagedomain {
67 struct list_head node;
68 struct list_head pwrdm_list;
69 struct omap_vc_channel *vc;
71 struct omap_vdd_info *vdd;
75 * struct omap_volt_data - Omap voltage specific data.
76 * @voltage_nominal: The possible voltage value in uV
77 * @sr_efuse_offs: The offset of the efuse register(from system
78 * control module base address) from where to read
79 * the n-target value for the smartreflex module.
80 * @sr_errminlimit: Error min limit value for smartreflex. This value
81 * differs at differnet opp and thus is linked
83 * @vp_errorgain: Error gain value for the voltage processor. This
84 * field also differs according to the voltage/opp.
86 struct omap_volt_data {
94 * struct omap_volt_pmic_info - PMIC specific data required by voltage driver.
95 * @slew_rate: PMIC slew rate (in uv/us)
96 * @step_size: PMIC voltage step size (in uv)
97 * @vsel_to_uv: PMIC API to convert vsel value to actual voltage in uV.
98 * @uv_to_vsel: PMIC API to convert voltage in uV to vsel value.
100 struct omap_volt_pmic_info {
116 unsigned long (*vsel_to_uv) (const u8 vsel);
117 u8 (*uv_to_vsel) (unsigned long uV);
121 * omap_vdd_info - Per Voltage Domain info
123 * @volt_data : voltage table having the distinct voltages supported
124 * by the domain and other associated per voltage data.
125 * @pmic_info : pmic specific parameters which should be populted by
127 * @vp_data : the register values, shifts, masks for various
129 * @vp_rt_data : VP data derived at runtime, not predefined
130 * @vfsm : voltage manager FSM data
131 * @debug_dir : debug directory for this voltage domain.
132 * @curr_volt : current voltage for this vdd.
133 * @prm_irqst_mod : PRM module id used for PRM IRQ status register access
134 * @vp_enabled : flag to keep track of whether vp is enabled or not
135 * @volt_scale : API to scale the voltage of the vdd.
137 struct omap_vdd_info {
138 struct omap_volt_data *volt_data;
139 struct omap_volt_pmic_info *pmic_info;
140 struct omap_vp_instance_data *vp_data;
141 struct omap_vp_runtime_data vp_rt_data;
142 const struct omap_vfsm_instance_data *vfsm;
143 struct dentry *debug_dir;
149 u32 (*read_reg) (u16 mod, u8 offset);
150 void (*write_reg) (u32 val, u16 mod, u8 offset);
151 int (*volt_scale) (struct voltagedomain *voltdm,
152 unsigned long target_volt);
155 unsigned long omap_vp_get_curr_volt(struct voltagedomain *voltdm);
156 void omap_vp_enable(struct voltagedomain *voltdm);
157 void omap_vp_disable(struct voltagedomain *voltdm);
158 int omap_voltage_scale_vdd(struct voltagedomain *voltdm,
159 unsigned long target_volt);
160 void omap_voltage_reset(struct voltagedomain *voltdm);
161 void omap_voltage_get_volttable(struct voltagedomain *voltdm,
162 struct omap_volt_data **volt_data);
163 struct omap_volt_data *omap_voltage_get_voltdata(struct voltagedomain *voltdm,
165 unsigned long omap_voltage_get_nom_volt(struct voltagedomain *voltdm);
166 struct dentry *omap_voltage_get_dbgdir(struct voltagedomain *voltdm);
168 int omap_voltage_register_pmic(struct voltagedomain *voltdm,
169 struct omap_volt_pmic_info *pmic_info);
170 void omap_change_voltscale_method(struct voltagedomain *voltdm,
171 int voltscale_method);
172 int omap_voltage_late_init(void);
174 static inline int omap_voltage_register_pmic(struct voltagedomain *voltdm,
175 struct omap_volt_pmic_info *pmic_info)
179 static inline void omap_change_voltscale_method(struct voltagedomain *voltdm,
180 int voltscale_method) {}
181 static inline int omap_voltage_late_init(void)
187 extern void omap2xxx_voltagedomains_init(void);
188 extern void omap3xxx_voltagedomains_init(void);
189 extern void omap44xx_voltagedomains_init(void);
191 struct voltagedomain *voltdm_lookup(const char *name);
192 void voltdm_init(struct voltagedomain **voltdm_list);
193 int voltdm_add_pwrdm(struct voltagedomain *voltdm, struct powerdomain *pwrdm);
194 int voltdm_for_each(int (*fn)(struct voltagedomain *voltdm, void *user),
196 int voltdm_for_each_pwrdm(struct voltagedomain *voltdm,
197 int (*fn)(struct voltagedomain *voltdm,
198 struct powerdomain *pwrdm));