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 <plat/voltage.h>
  20
  21 #include "vc.h"
  22 #include "vp.h"
  23
  24 struct powerdomain;
  25
  26 /* XXX document */
  27 #define VOLTSCALE_VPFORCEUPDATE         1
  28 #define VOLTSCALE_VCBYPASS              2
  29
  30 /*
  31  * OMAP3 GENERIC setup times. Revisit to see if these needs to be
  32  * passed from board or PMIC file
  33  */
  34 #define OMAP3_CLKSETUP          0xff
  35 #define OMAP3_VOLTOFFSET        0xff
  36 #define OMAP3_VOLTSETUP2        0xff
  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  * @scale: function used to scale the voltage of the voltagedomain
  64  * @nominal_volt: current nominal voltage for this voltage domain
  65  * @volt_data: voltage table having the distinct voltages supported
  66  *             by the domain and other associated per voltage data.
  67  */
  68 struct voltagedomain {
  69         char *name;
  70         bool scalable;
  71         struct list_head node;
  72         struct list_head pwrdm_list;
  73         struct omap_vc_channel *vc;
  74         const struct omap_vfsm_instance *vfsm;
  75         struct omap_vp_instance *vp;
  76         struct omap_voltdm_pmic *pmic;
  77
  78         /* VC/VP register access functions: SoC specific */
  79         u32 (*read) (u8 offset);
  80         void (*write) (u32 val, u8 offset);
  81         u32 (*rmw)(u32 mask, u32 bits, u8 offset);
  82
  83         union {
  84                 const char *name;
  85                 u32 rate;
  86         } sys_clk;
  87
  88         int (*scale) (struct voltagedomain *voltdm,
  89                       unsigned long target_volt);
  90
  91         u32 nominal_volt;
  92         struct omap_volt_data *volt_data;
  93 };
  94
  95 /**
  96  * struct omap_voltdm_pmic - PMIC specific data required by voltage driver.
  97  * @slew_rate:  PMIC slew rate (in uv/us)
  98  * @step_size:  PMIC voltage step size (in uv)
  99  * @i2c_slave_addr: I2C slave address of PMIC
 100  * @volt_reg_addr: voltage configuration register address
 101  * @cmd_reg_addr: command (on, on-LP, ret, off) configuration register address
 102  * @i2c_high_speed: whether VC uses I2C high-speed mode to PMIC
 103  * @i2c_mcode: master code value for I2C high-speed preamble transmission
 104  * @vsel_to_uv: PMIC API to convert vsel value to actual voltage in uV.
 105  * @uv_to_vsel: PMIC API to convert voltage in uV to vsel value.
 106  */
 107 struct omap_voltdm_pmic {
 108         int slew_rate;
 109         int step_size;
 110         u32 on_volt;
 111         u32 onlp_volt;
 112         u32 ret_volt;
 113         u32 off_volt;
 114         u16 volt_setup_time;
 115         u16 i2c_slave_addr;
 116         u16 volt_reg_addr;
 117         u16 cmd_reg_addr;
 118         u8 vp_erroroffset;
 119         u8 vp_vstepmin;
 120         u8 vp_vstepmax;
 121         u8 vp_vddmin;
 122         u8 vp_vddmax;
 123         u8 vp_timeout_us;
 124         bool i2c_high_speed;
 125         u8 i2c_mcode;
 126         unsigned long (*vsel_to_uv) (const u8 vsel);
 127         u8 (*uv_to_vsel) (unsigned long uV);
 128 };
 129
 130 void omap_voltage_get_volttable(struct voltagedomain *voltdm,
 131                 struct omap_volt_data **volt_data);
 132 struct omap_volt_data *omap_voltage_get_voltdata(struct voltagedomain *voltdm,
 133                 unsigned long volt);
 134 int omap_voltage_register_pmic(struct voltagedomain *voltdm,
 135                                struct omap_voltdm_pmic *pmic);
 136 void omap_change_voltscale_method(struct voltagedomain *voltdm,
 137                 int voltscale_method);
 138 int omap_voltage_late_init(void);
 139
 140 extern void omap2xxx_voltagedomains_init(void);
 141 extern void omap3xxx_voltagedomains_init(void);
 142 extern void am33xx_voltagedomains_init(void);
 143 extern void omap44xx_voltagedomains_init(void);
 144
 145 struct voltagedomain *voltdm_lookup(const char *name);
 146 void voltdm_init(struct voltagedomain **voltdm_list);
 147 int voltdm_add_pwrdm(struct voltagedomain *voltdm, struct powerdomain *pwrdm);
 148 int voltdm_for_each(int (*fn)(struct voltagedomain *voltdm, void *user),
 149                     void *user);
 150 int voltdm_for_each_pwrdm(struct voltagedomain *voltdm,
 151                           int (*fn)(struct voltagedomain *voltdm,
 152                                     struct powerdomain *pwrdm));
 153 int voltdm_scale(struct voltagedomain *voltdm, unsigned long target_volt);
 154 void voltdm_reset(struct voltagedomain *voltdm);
 155 unsigned long voltdm_get_voltage(struct voltagedomain *voltdm);
 156 #endif