Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 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 | |
Santosh Shilimkar | faacebc | 2011-01-05 16:27:04 +0530 | [diff] [blame] | 17 | #include <linux/err.h> |
| 18 | |
Paul Walmsley | c0718df | 2011-03-10 22:17:45 -0700 | [diff] [blame] | 19 | #include "vc.h" |
| 20 | #include "vp.h" |
| 21 | |
Kevin Hilman | e69c22b | 2011-03-16 16:13:15 -0700 | [diff] [blame] | 22 | struct powerdomain; |
| 23 | |
Paul Walmsley | c0718df | 2011-03-10 22:17:45 -0700 | [diff] [blame] | 24 | /* XXX document */ |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 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 | |
Paul Walmsley | c0718df | 2011-03-10 22:17:45 -0700 | [diff] [blame] | 36 | /** |
Kevin Hilman | 5892bb1 | 2011-03-29 14:36:04 -0700 | [diff] [blame] | 37 | * struct omap_vfsm_instance - per-voltage manager FSM register/bitfield |
Paul Walmsley | c0718df | 2011-03-10 22:17:45 -0700 | [diff] [blame] | 38 | * data |
| 39 | * @voltsetup_mask: SETUP_TIME* bitmask in the PRM_VOLTSETUP* register |
| 40 | * @voltsetup_reg: register offset of PRM_VOLTSETUP from PRM base |
Paul Walmsley | c0718df | 2011-03-10 22:17:45 -0700 | [diff] [blame] | 41 | * |
| 42 | * XXX What about VOLTOFFSET/VOLTCTRL? |
Paul Walmsley | c0718df | 2011-03-10 22:17:45 -0700 | [diff] [blame] | 43 | */ |
Kevin Hilman | 5892bb1 | 2011-03-29 14:36:04 -0700 | [diff] [blame] | 44 | struct omap_vfsm_instance { |
Paul Walmsley | c0718df | 2011-03-10 22:17:45 -0700 | [diff] [blame] | 45 | u32 voltsetup_mask; |
| 46 | u8 voltsetup_reg; |
Paul Walmsley | c0718df | 2011-03-10 22:17:45 -0700 | [diff] [blame] | 47 | }; |
Thara Gopinath | bd38107 | 2010-12-10 23:15:23 +0530 | [diff] [blame] | 48 | |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 49 | /** |
| 50 | * struct voltagedomain - omap voltage domain global structure. |
Kevin Hilman | 81a6048 | 2011-03-16 14:25:45 -0700 | [diff] [blame] | 51 | * @name: Name of the voltage domain which can be used as a unique identifier. |
Kevin Hilman | 37efca7 | 2011-03-23 17:00:21 -0700 | [diff] [blame] | 52 | * @scalable: Whether or not this voltage domain is scalable |
Kevin Hilman | 81a6048 | 2011-03-16 14:25:45 -0700 | [diff] [blame] | 53 | * @node: list_head linking all voltage domains |
Kevin Hilman | e69c22b | 2011-03-16 16:13:15 -0700 | [diff] [blame] | 54 | * @pwrdm_list: list_head linking all powerdomains in this voltagedomain |
Kevin Hilman | d84adcf | 2011-03-22 16:14:57 -0700 | [diff] [blame] | 55 | * @vc: pointer to VC channel associated with this voltagedomain |
Kevin Hilman | b7ea803 | 2011-04-04 15:25:07 -0700 | [diff] [blame] | 56 | * @vp: pointer to VP associated with this voltagedomain |
Kevin Hilman | 4bcc475 | 2011-03-28 10:40:15 -0700 | [diff] [blame] | 57 | * @read: read a VC/VP register |
| 58 | * @write: write a VC/VP register |
| 59 | * @read: read-modify-write a VC/VP register |
Kevin Hilman | 0e2f3d9 | 2011-04-04 17:22:28 -0700 | [diff] [blame] | 60 | * @sys_clk: system clock name/frequency, used for various timing calculations |
Kevin Hilman | 0f01565 | 2011-07-14 11:12:32 -0700 | [diff] [blame] | 61 | * @scale: function used to scale the voltage of the voltagedomain |
Kevin Hilman | 7590f60 | 2011-04-05 16:55:22 -0700 | [diff] [blame] | 62 | * @nominal_volt: current nominal voltage for this voltage domain |
Kevin Hilman | e327788 | 2011-07-14 11:29:06 -0700 | [diff] [blame] | 63 | * @volt_data: voltage table having the distinct voltages supported |
| 64 | * by the domain and other associated per voltage data. |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 65 | */ |
| 66 | struct voltagedomain { |
| 67 | char *name; |
Kevin Hilman | 37efca7 | 2011-03-23 17:00:21 -0700 | [diff] [blame] | 68 | bool scalable; |
Kevin Hilman | 81a6048 | 2011-03-16 14:25:45 -0700 | [diff] [blame] | 69 | struct list_head node; |
Kevin Hilman | e69c22b | 2011-03-16 16:13:15 -0700 | [diff] [blame] | 70 | struct list_head pwrdm_list; |
Kevin Hilman | d84adcf | 2011-03-22 16:14:57 -0700 | [diff] [blame] | 71 | struct omap_vc_channel *vc; |
Kevin Hilman | 5892bb1 | 2011-03-29 14:36:04 -0700 | [diff] [blame] | 72 | const struct omap_vfsm_instance *vfsm; |
Kevin Hilman | b7ea803 | 2011-04-04 15:25:07 -0700 | [diff] [blame] | 73 | struct omap_vp_instance *vp; |
Kevin Hilman | ce8ebe0 | 2011-03-30 11:01:10 -0700 | [diff] [blame] | 74 | struct omap_voltdm_pmic *pmic; |
Kevin Hilman | d84adcf | 2011-03-22 16:14:57 -0700 | [diff] [blame] | 75 | |
Kevin Hilman | 4bcc475 | 2011-03-28 10:40:15 -0700 | [diff] [blame] | 76 | /* VC/VP register access functions: SoC specific */ |
| 77 | u32 (*read) (u8 offset); |
| 78 | void (*write) (u32 val, u8 offset); |
| 79 | u32 (*rmw)(u32 mask, u32 bits, u8 offset); |
| 80 | |
Kevin Hilman | 0e2f3d9 | 2011-04-04 17:22:28 -0700 | [diff] [blame] | 81 | union { |
| 82 | const char *name; |
| 83 | u32 rate; |
| 84 | } sys_clk; |
| 85 | |
Kevin Hilman | 0f01565 | 2011-07-14 11:12:32 -0700 | [diff] [blame] | 86 | int (*scale) (struct voltagedomain *voltdm, |
| 87 | unsigned long target_volt); |
| 88 | |
Kevin Hilman | e327788 | 2011-07-14 11:29:06 -0700 | [diff] [blame] | 89 | u32 nominal_volt; |
| 90 | struct omap_volt_data *volt_data; |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 91 | }; |
| 92 | |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 93 | /** |
| 94 | * struct omap_volt_data - Omap voltage specific data. |
| 95 | * @voltage_nominal: The possible voltage value in uV |
| 96 | * @sr_efuse_offs: The offset of the efuse register(from system |
| 97 | * control module base address) from where to read |
| 98 | * the n-target value for the smartreflex module. |
| 99 | * @sr_errminlimit: Error min limit value for smartreflex. This value |
| 100 | * differs at differnet opp and thus is linked |
| 101 | * with voltage. |
| 102 | * @vp_errorgain: Error gain value for the voltage processor. This |
| 103 | * field also differs according to the voltage/opp. |
| 104 | */ |
| 105 | struct omap_volt_data { |
| 106 | u32 volt_nominal; |
| 107 | u32 sr_efuse_offs; |
| 108 | u8 sr_errminlimit; |
| 109 | u8 vp_errgain; |
| 110 | }; |
| 111 | |
| 112 | /** |
Kevin Hilman | ce8ebe0 | 2011-03-30 11:01:10 -0700 | [diff] [blame] | 113 | * struct omap_voltdm_pmic - PMIC specific data required by voltage driver. |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 114 | * @slew_rate: PMIC slew rate (in uv/us) |
| 115 | * @step_size: PMIC voltage step size (in uv) |
Kevin Hilman | ba112a4 | 2011-03-29 14:02:36 -0700 | [diff] [blame] | 116 | * @i2c_slave_addr: I2C slave address of PMIC |
Kevin Hilman | e74e440 | 2011-03-22 14:12:37 -0700 | [diff] [blame] | 117 | * @volt_reg_addr: voltage configuration register address |
| 118 | * @cmd_reg_addr: command (on, on-LP, ret, off) configuration register address |
Kevin Hilman | f539548 | 2011-03-30 16:36:30 -0700 | [diff] [blame] | 119 | * @i2c_high_speed: whether VC uses I2C high-speed mode to PMIC |
| 120 | * @i2c_mcode: master code value for I2C high-speed preamble transmission |
Kevin Hilman | e4e021c | 2011-06-09 11:01:55 -0700 | [diff] [blame] | 121 | * @vsel_to_uv: PMIC API to convert vsel value to actual voltage in uV. |
| 122 | * @uv_to_vsel: PMIC API to convert voltage in uV to vsel value. |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 123 | */ |
Kevin Hilman | ce8ebe0 | 2011-03-30 11:01:10 -0700 | [diff] [blame] | 124 | struct omap_voltdm_pmic { |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 125 | int slew_rate; |
| 126 | int step_size; |
| 127 | u32 on_volt; |
| 128 | u32 onlp_volt; |
| 129 | u32 ret_volt; |
| 130 | u32 off_volt; |
| 131 | u16 volt_setup_time; |
Kevin Hilman | ba112a4 | 2011-03-29 14:02:36 -0700 | [diff] [blame] | 132 | u16 i2c_slave_addr; |
Kevin Hilman | e4e021c | 2011-06-09 11:01:55 -0700 | [diff] [blame] | 133 | u16 volt_reg_addr; |
| 134 | u16 cmd_reg_addr; |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 135 | u8 vp_erroroffset; |
| 136 | u8 vp_vstepmin; |
| 137 | u8 vp_vstepmax; |
| 138 | u8 vp_vddmin; |
| 139 | u8 vp_vddmax; |
| 140 | u8 vp_timeout_us; |
Kevin Hilman | f539548 | 2011-03-30 16:36:30 -0700 | [diff] [blame] | 141 | bool i2c_high_speed; |
| 142 | u8 i2c_mcode; |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 143 | unsigned long (*vsel_to_uv) (const u8 vsel); |
| 144 | u8 (*uv_to_vsel) (unsigned long uV); |
| 145 | }; |
| 146 | |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 147 | void omap_voltage_get_volttable(struct voltagedomain *voltdm, |
| 148 | struct omap_volt_data **volt_data); |
| 149 | struct omap_volt_data *omap_voltage_get_voltdata(struct voltagedomain *voltdm, |
| 150 | unsigned long volt); |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 151 | int omap_voltage_register_pmic(struct voltagedomain *voltdm, |
Kevin Hilman | ce8ebe0 | 2011-03-30 11:01:10 -0700 | [diff] [blame] | 152 | struct omap_voltdm_pmic *pmic); |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 153 | void omap_change_voltscale_method(struct voltagedomain *voltdm, |
| 154 | int voltscale_method); |
| 155 | int omap_voltage_late_init(void); |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 156 | |
Kevin Hilman | aae030f | 2011-03-23 16:09:41 -0700 | [diff] [blame] | 157 | extern void omap2xxx_voltagedomains_init(void); |
Kevin Hilman | 81a6048 | 2011-03-16 14:25:45 -0700 | [diff] [blame] | 158 | extern void omap3xxx_voltagedomains_init(void); |
| 159 | extern void omap44xx_voltagedomains_init(void); |
| 160 | |
| 161 | struct voltagedomain *voltdm_lookup(const char *name); |
| 162 | void voltdm_init(struct voltagedomain **voltdm_list); |
Kevin Hilman | 048a703 | 2011-03-16 15:52:47 -0700 | [diff] [blame] | 163 | int voltdm_add_pwrdm(struct voltagedomain *voltdm, struct powerdomain *pwrdm); |
Kevin Hilman | e69c22b | 2011-03-16 16:13:15 -0700 | [diff] [blame] | 164 | int voltdm_for_each(int (*fn)(struct voltagedomain *voltdm, void *user), |
| 165 | void *user); |
| 166 | int voltdm_for_each_pwrdm(struct voltagedomain *voltdm, |
| 167 | int (*fn)(struct voltagedomain *voltdm, |
| 168 | struct powerdomain *pwrdm)); |
Kevin Hilman | 5e5651b | 2011-04-05 16:27:21 -0700 | [diff] [blame] | 169 | int voltdm_scale(struct voltagedomain *voltdm, unsigned long target_volt); |
| 170 | void voltdm_reset(struct voltagedomain *voltdm); |
Kevin Hilman | d5c1282 | 2011-07-15 16:05:12 -0700 | [diff] [blame] | 171 | unsigned long voltdm_get_voltage(struct voltagedomain *voltdm); |
Thara Gopinath | 2f34ce8 | 2010-05-29 22:02:21 +0530 | [diff] [blame] | 172 | #endif |