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
62 * @read: read a VC/VP register
63 * @write: write a VC/VP register
64 * @read: read-modify-write a VC/VP register
67 struct voltagedomain {
70 struct list_head node;
71 struct list_head pwrdm_list;
72 struct omap_vc_channel *vc;
74 /* VC/VP register access functions: SoC specific */
75 u32 (*read) (u8 offset);
76 void (*write) (u32 val, u8 offset);
77 u32 (*rmw)(u32 mask, u32 bits, u8 offset);
79 struct omap_vdd_info *vdd;
83 * struct omap_volt_data - Omap voltage specific data.
84 * @voltage_nominal: The possible voltage value in uV
85 * @sr_efuse_offs: The offset of the efuse register(from system
86 * control module base address) from where to read
87 * the n-target value for the smartreflex module.
88 * @sr_errminlimit: Error min limit value for smartreflex. This value
89 * differs at differnet opp and thus is linked
91 * @vp_errorgain: Error gain value for the voltage processor. This
92 * field also differs according to the voltage/opp.
94 struct omap_volt_data {
102 * struct omap_volt_pmic_info - PMIC specific data required by voltage driver.
103 * @slew_rate: PMIC slew rate (in uv/us)
104 * @step_size: PMIC voltage step size (in uv)
105 * @vsel_to_uv: PMIC API to convert vsel value to actual voltage in uV.
106 * @uv_to_vsel: PMIC API to convert voltage in uV to vsel value.
107 * @volt_reg_addr: voltage configuration register address
108 * @cmd_reg_addr: command (on, on-LP, ret, off) configuration register address
110 struct omap_volt_pmic_info {
127 unsigned long (*vsel_to_uv) (const u8 vsel);
128 u8 (*uv_to_vsel) (unsigned long uV);
132 * omap_vdd_info - Per Voltage Domain info
134 * @volt_data : voltage table having the distinct voltages supported
135 * by the domain and other associated per voltage data.
136 * @pmic_info : pmic specific parameters which should be populted by
138 * @vp_data : the register values, shifts, masks for various
140 * @vp_rt_data : VP data derived at runtime, not predefined
141 * @vfsm : voltage manager FSM data
142 * @debug_dir : debug directory for this voltage domain.
143 * @curr_volt : current voltage for this vdd.
144 * @vp_enabled : flag to keep track of whether vp is enabled or not
145 * @volt_scale : API to scale the voltage of the vdd.
147 struct omap_vdd_info {
148 struct omap_volt_data *volt_data;
149 struct omap_volt_pmic_info *pmic_info;
150 struct omap_vp_instance_data *vp_data;
151 struct omap_vp_runtime_data vp_rt_data;
152 const struct omap_vfsm_instance_data *vfsm;
153 struct dentry *debug_dir;
157 int (*volt_scale) (struct voltagedomain *voltdm,
158 unsigned long target_volt);
161 int omap_voltage_scale_vdd(struct voltagedomain *voltdm,
162 unsigned long target_volt);
163 void omap_voltage_reset(struct voltagedomain *voltdm);
164 void omap_voltage_get_volttable(struct voltagedomain *voltdm,
165 struct omap_volt_data **volt_data);
166 struct omap_volt_data *omap_voltage_get_voltdata(struct voltagedomain *voltdm,
168 unsigned long omap_voltage_get_nom_volt(struct voltagedomain *voltdm);
169 struct dentry *omap_voltage_get_dbgdir(struct voltagedomain *voltdm);
171 int omap_voltage_register_pmic(struct voltagedomain *voltdm,
172 struct omap_volt_pmic_info *pmic_info);
173 void omap_change_voltscale_method(struct voltagedomain *voltdm,
174 int voltscale_method);
175 int omap_voltage_late_init(void);
177 static inline int omap_voltage_register_pmic(struct voltagedomain *voltdm,
178 struct omap_volt_pmic_info *pmic_info)
182 static inline void omap_change_voltscale_method(struct voltagedomain *voltdm,
183 int voltscale_method) {}
184 static inline int omap_voltage_late_init(void)
190 extern void omap2xxx_voltagedomains_init(void);
191 extern void omap3xxx_voltagedomains_init(void);
192 extern void omap44xx_voltagedomains_init(void);
194 struct voltagedomain *voltdm_lookup(const char *name);
195 void voltdm_init(struct voltagedomain **voltdm_list);
196 int voltdm_add_pwrdm(struct voltagedomain *voltdm, struct powerdomain *pwrdm);
197 int voltdm_for_each(int (*fn)(struct voltagedomain *voltdm, void *user),
199 int voltdm_for_each_pwrdm(struct voltagedomain *voltdm,
200 int (*fn)(struct voltagedomain *voltdm,
201 struct powerdomain *pwrdm));