arch/arm/mach-omap2/voltage.h

   1 /*
   2  * OMAP Voltage Management Routines
   3  *
   4  * Author: Thara Gopinath       <thara@ti.com>
   5  *
   6  * Copyright (C) 2009 Texas Instruments, Inc.
   7  * Thara Gopinath <thara@ti.com>
   8  *
   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.
  12  */
  13
  14 #ifndef __ARCH_ARM_MACH_OMAP2_VOLTAGE_H
  15 #define __ARCH_ARM_MACH_OMAP2_VOLTAGE_H
  16
  17 #include <linux/err.h>
  18
  19 #include "vc.h"
  20 #include "vp.h"
  21
  22 struct powerdomain;
  23
  24 /* XXX document */
  25 #define VOLTSCALE_VPFORCEUPDATE         1
  26 #define VOLTSCALE_VCBYPASS              2
  27
  28 /*
  29  * OMAP3 GENERIC setup times. Revisit to see if these needs to be
  30  * passed from board or PMIC file
  31  */
  32 #define OMAP3_CLKSETUP          0xff
  33 #define OMAP3_VOLTOFFSET        0xff
  34 #define OMAP3_VOLTSETUP2        0xff
  35
  36 struct omap_vdd_info;
  37
  38 /**
  39  * struct omap_vfsm_instance_data - per-voltage manager FSM register/bitfield
  40  * data
  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
  44  *
  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!
  48  */
  49 struct omap_vfsm_instance_data {
  50         u32 voltsetup_mask;
  51         u8 voltsetup_reg;
  52         u8 voltsetup_shift;
  53 };
  54
  55 /**
  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
  65  * @vdd: to be removed
  66  */
  67 struct voltagedomain {
  68         char *name;
  69         bool scalable;
  70         struct list_head node;
  71         struct list_head pwrdm_list;
  72         struct omap_vc_channel *vc;
  73
  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);
  78
  79         struct omap_vdd_info *vdd;
  80 };
  81
  82 /**
  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
  90  *                      with voltage.
  91  * @vp_errorgain:       Error gain value for the voltage processor. This
  92  *                      field also differs according to the voltage/opp.
  93  */
  94 struct omap_volt_data {
  95         u32     volt_nominal;
  96         u32     sr_efuse_offs;
  97         u8      sr_errminlimit;
  98         u8      vp_errgain;
  99 };
 100
 101 /**
 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  * @i2c_slave_addr: I2C slave address of PMIC
 106  * @volt_reg_addr: voltage configuration register address
 107  * @cmd_reg_addr: command (on, on-LP, ret, off) configuration register address
 108  * @vsel_to_uv: PMIC API to convert vsel value to actual voltage in uV.
 109  * @uv_to_vsel: PMIC API to convert voltage in uV to vsel value.
 110  */
 111 struct omap_volt_pmic_info {
 112         int slew_rate;
 113         int step_size;
 114         u32 on_volt;
 115         u32 onlp_volt;
 116         u32 ret_volt;
 117         u32 off_volt;
 118         u16 volt_setup_time;
 119         u16 i2c_slave_addr;
 120         u16 volt_reg_addr;
 121         u16 cmd_reg_addr;
 122         u8 vp_erroroffset;
 123         u8 vp_vstepmin;
 124         u8 vp_vstepmax;
 125         u8 vp_vddmin;
 126         u8 vp_vddmax;
 127         u8 vp_timeout_us;
 128         unsigned long (*vsel_to_uv) (const u8 vsel);
 129         u8 (*uv_to_vsel) (unsigned long uV);
 130 };
 131
 132 /**
 133  * omap_vdd_info - Per Voltage Domain info
 134  *
 135  * @volt_data           : voltage table having the distinct voltages supported
 136  *                        by the domain and other associated per voltage data.
 137  * @pmic_info           : pmic specific parameters which should be populted by
 138  *                        the pmic drivers.
 139  * @vp_data             : the register values, shifts, masks for various
 140  *                        vp registers
 141  * @vp_rt_data          : VP data derived at runtime, not predefined
 142  * @vfsm                : voltage manager FSM data
 143  * @debug_dir           : debug directory for this voltage domain.
 144  * @curr_volt           : current voltage for this vdd.
 145  * @vp_enabled          : flag to keep track of whether vp is enabled or not
 146  * @volt_scale          : API to scale the voltage of the vdd.
 147  */
 148 struct omap_vdd_info {
 149         struct omap_volt_data *volt_data;
 150         struct omap_volt_pmic_info *pmic_info;
 151         struct omap_vp_instance_data *vp_data;
 152         struct omap_vp_runtime_data vp_rt_data;
 153         const struct omap_vfsm_instance_data *vfsm;
 154         struct dentry *debug_dir;
 155         u32 curr_volt;
 156         bool vp_enabled;
 157
 158         int (*volt_scale) (struct voltagedomain *voltdm,
 159                 unsigned long target_volt);
 160 };
 161
 162 int omap_voltage_scale_vdd(struct voltagedomain *voltdm,
 163                 unsigned long target_volt);
 164 void omap_voltage_reset(struct voltagedomain *voltdm);
 165 void omap_voltage_get_volttable(struct voltagedomain *voltdm,
 166                 struct omap_volt_data **volt_data);
 167 struct omap_volt_data *omap_voltage_get_voltdata(struct voltagedomain *voltdm,
 168                 unsigned long volt);
 169 unsigned long omap_voltage_get_nom_volt(struct voltagedomain *voltdm);
 170 struct dentry *omap_voltage_get_dbgdir(struct voltagedomain *voltdm);
 171 #ifdef CONFIG_PM
 172 int omap_voltage_register_pmic(struct voltagedomain *voltdm,
 173                 struct omap_volt_pmic_info *pmic_info);
 174 void omap_change_voltscale_method(struct voltagedomain *voltdm,
 175                 int voltscale_method);
 176 int omap_voltage_late_init(void);
 177 #else
 178 static inline int omap_voltage_register_pmic(struct voltagedomain *voltdm,
 179                 struct omap_volt_pmic_info *pmic_info)
 180 {
 181         return -EINVAL;
 182 }
 183 static inline  void omap_change_voltscale_method(struct voltagedomain *voltdm,
 184                 int voltscale_method) {}
 185 static inline int omap_voltage_late_init(void)
 186 {
 187         return -EINVAL;
 188 }
 189 #endif
 190
 191 extern void omap2xxx_voltagedomains_init(void);
 192 extern void omap3xxx_voltagedomains_init(void);
 193 extern void omap44xx_voltagedomains_init(void);
 194
 195 struct voltagedomain *voltdm_lookup(const char *name);
 196 void voltdm_init(struct voltagedomain **voltdm_list);
 197 int voltdm_add_pwrdm(struct voltagedomain *voltdm, struct powerdomain *pwrdm);
 198 int voltdm_for_each(int (*fn)(struct voltagedomain *voltdm, void *user),
 199                     void *user);
 200 int voltdm_for_each_pwrdm(struct voltagedomain *voltdm,
 201                           int (*fn)(struct voltagedomain *voltdm,
 202                                     struct powerdomain *pwrdm));
 203 #endif