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 - 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  *
  44  * XXX What about VOLTOFFSET/VOLTCTRL?
  45  */
  46 struct omap_vfsm_instance {
  47         u32 voltsetup_mask;
  48         u8 voltsetup_reg;
  49 };
  50
  51 /**
  52  * struct voltagedomain - omap voltage domain global structure.
  53  * @name: Name of the voltage domain which can be used as a unique identifier.
  54  * @scalable: Whether or not this voltage domain is scalable
  55  * @node: list_head linking all voltage domains
  56  * @pwrdm_list: list_head linking all powerdomains in this voltagedomain
  57  * @vc: pointer to VC channel associated with this voltagedomain
  58  * @vp: pointer to VP associated with this voltagedomain
  59  * @read: read a VC/VP register
  60  * @write: write a VC/VP register
  61  * @read: read-modify-write a VC/VP register
  62  * @sys_clk: system clock name/frequency, used for various timing calculations
  63  * @vdd: to be removed
  64  */
  65 struct voltagedomain {
  66         char *name;
  67         bool scalable;
  68         struct list_head node;
  69         struct list_head pwrdm_list;
  70         struct omap_vc_channel *vc;
  71         const struct omap_vfsm_instance *vfsm;
  72         struct omap_vp_instance *vp;
  73         struct omap_voltdm_pmic *pmic;
  74
  75         /* VC/VP register access functions: SoC specific */
  76         u32 (*read) (u8 offset);
  77         void (*write) (u32 val, u8 offset);
  78         u32 (*rmw)(u32 mask, u32 bits, u8 offset);
  79
  80         union {
  81                 const char *name;
  82                 u32 rate;
  83         } sys_clk;
  84
  85         struct omap_vdd_info *vdd;
  86 };
  87
  88 /**
  89  * struct omap_volt_data - Omap voltage specific data.
  90  * @voltage_nominal:    The possible voltage value in uV
  91  * @sr_efuse_offs:      The offset of the efuse register(from system
  92  *                      control module base address) from where to read
  93  *                      the n-target value for the smartreflex module.
  94  * @sr_errminlimit:     Error min limit value for smartreflex. This value
  95  *                      differs at differnet opp and thus is linked
  96  *                      with voltage.
  97  * @vp_errorgain:       Error gain value for the voltage processor. This
  98  *                      field also differs according to the voltage/opp.
  99  */
 100 struct omap_volt_data {
 101         u32     volt_nominal;
 102         u32     sr_efuse_offs;
 103         u8      sr_errminlimit;
 104         u8      vp_errgain;
 105 };
 106
 107 /**
 108  * struct omap_voltdm_pmic - PMIC specific data required by voltage driver.
 109  * @slew_rate:  PMIC slew rate (in uv/us)
 110  * @step_size:  PMIC voltage step size (in uv)
 111  * @i2c_slave_addr: I2C slave address of PMIC
 112  * @volt_reg_addr: voltage configuration register address
 113  * @cmd_reg_addr: command (on, on-LP, ret, off) configuration register address
 114  * @i2c_high_speed: whether VC uses I2C high-speed mode to PMIC
 115  * @i2c_mcode: master code value for I2C high-speed preamble transmission
 116  * @vsel_to_uv: PMIC API to convert vsel value to actual voltage in uV.
 117  * @uv_to_vsel: PMIC API to convert voltage in uV to vsel value.
 118  */
 119 struct omap_voltdm_pmic {
 120         int slew_rate;
 121         int step_size;
 122         u32 on_volt;
 123         u32 onlp_volt;
 124         u32 ret_volt;
 125         u32 off_volt;
 126         u16 volt_setup_time;
 127         u16 i2c_slave_addr;
 128         u16 volt_reg_addr;
 129         u16 cmd_reg_addr;
 130         u8 vp_erroroffset;
 131         u8 vp_vstepmin;
 132         u8 vp_vstepmax;
 133         u8 vp_vddmin;
 134         u8 vp_vddmax;
 135         u8 vp_timeout_us;
 136         bool i2c_high_speed;
 137         u8 i2c_mcode;
 138         unsigned long (*vsel_to_uv) (const u8 vsel);
 139         u8 (*uv_to_vsel) (unsigned long uV);
 140 };
 141
 142 /**
 143  * omap_vdd_info - Per Voltage Domain info
 144  *
 145  * @volt_data           : voltage table having the distinct voltages supported
 146  *                        by the domain and other associated per voltage data.
 147  * @vp_rt_data          : VP data derived at runtime, not predefined
 148  * @curr_volt           : current voltage for this vdd.
 149  * @volt_scale          : API to scale the voltage of the vdd.
 150  */
 151 struct omap_vdd_info {
 152         struct omap_volt_data *volt_data;
 153         struct omap_vp_runtime_data vp_rt_data;
 154         u32 curr_volt;
 155
 156         int (*volt_scale) (struct voltagedomain *voltdm,
 157                 unsigned long target_volt);
 158 };
 159
 160 int omap_voltage_scale_vdd(struct voltagedomain *voltdm,
 161                 unsigned long target_volt);
 162 void omap_voltage_reset(struct voltagedomain *voltdm);
 163 void omap_voltage_get_volttable(struct voltagedomain *voltdm,
 164                 struct omap_volt_data **volt_data);
 165 struct omap_volt_data *omap_voltage_get_voltdata(struct voltagedomain *voltdm,
 166                 unsigned long volt);
 167 unsigned long omap_voltage_get_nom_volt(struct voltagedomain *voltdm);
 168 #ifdef CONFIG_PM
 169 int omap_voltage_register_pmic(struct voltagedomain *voltdm,
 170                                struct omap_voltdm_pmic *pmic);
 171 void omap_change_voltscale_method(struct voltagedomain *voltdm,
 172                 int voltscale_method);
 173 int omap_voltage_late_init(void);
 174 #else
 175 static inline int omap_voltage_register_pmic(struct voltagedomain *voltdm,
 176                                              struct omap_voltdm_pmic *pmic)
 177 {
 178         return -EINVAL;
 179 }
 180 static inline  void omap_change_voltscale_method(struct voltagedomain *voltdm,
 181                 int voltscale_method) {}
 182 static inline int omap_voltage_late_init(void)
 183 {
 184         return -EINVAL;
 185 }
 186 #endif
 187
 188 extern void omap2xxx_voltagedomains_init(void);
 189 extern void omap3xxx_voltagedomains_init(void);
 190 extern void omap44xx_voltagedomains_init(void);
 191
 192 struct voltagedomain *voltdm_lookup(const char *name);
 193 void voltdm_init(struct voltagedomain **voltdm_list);
 194 int voltdm_add_pwrdm(struct voltagedomain *voltdm, struct powerdomain *pwrdm);
 195 int voltdm_for_each(int (*fn)(struct voltagedomain *voltdm, void *user),
 196                     void *user);
 197 int voltdm_for_each_pwrdm(struct voltagedomain *voltdm,
 198                           int (*fn)(struct voltagedomain *voltdm,
 199                                     struct powerdomain *pwrdm));
 200 #endif