Commit | Line | Data |
---|---|---|
2f34ce81 TG |
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 | ||
faacebc5 SS |
17 | #include <linux/err.h> |
18 | ||
2203747c | 19 | #include <linux/platform_data/voltage-omap.h> |
fa60be6e | 20 | |
c0718df4 PW |
21 | #include "vc.h" |
22 | #include "vp.h" | |
23 | ||
e69c22b1 KH |
24 | struct powerdomain; |
25 | ||
c0718df4 | 26 | /* XXX document */ |
2f34ce81 TG |
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 | ||
c0718df4 | 38 | /** |
5892bb1f | 39 | * struct omap_vfsm_instance - per-voltage manager FSM register/bitfield |
c0718df4 PW |
40 | * data |
41 | * @voltsetup_mask: SETUP_TIME* bitmask in the PRM_VOLTSETUP* register | |
42 | * @voltsetup_reg: register offset of PRM_VOLTSETUP from PRM base | |
c0718df4 PW |
43 | * |
44 | * XXX What about VOLTOFFSET/VOLTCTRL? | |
c0718df4 | 45 | */ |
5892bb1f | 46 | struct omap_vfsm_instance { |
c0718df4 PW |
47 | u32 voltsetup_mask; |
48 | u8 voltsetup_reg; | |
c0718df4 | 49 | }; |
bd38107b | 50 | |
2f34ce81 TG |
51 | /** |
52 | * struct voltagedomain - omap voltage domain global structure. | |
81a60482 | 53 | * @name: Name of the voltage domain which can be used as a unique identifier. |
37efca7e | 54 | * @scalable: Whether or not this voltage domain is scalable |
81a60482 | 55 | * @node: list_head linking all voltage domains |
e69c22b1 | 56 | * @pwrdm_list: list_head linking all powerdomains in this voltagedomain |
d84adcf4 | 57 | * @vc: pointer to VC channel associated with this voltagedomain |
b7ea803e | 58 | * @vp: pointer to VP associated with this voltagedomain |
4bcc475e KH |
59 | * @read: read a VC/VP register |
60 | * @write: write a VC/VP register | |
61 | * @read: read-modify-write a VC/VP register | |
0e2f3d9c | 62 | * @sys_clk: system clock name/frequency, used for various timing calculations |
0f01565a | 63 | * @scale: function used to scale the voltage of the voltagedomain |
7590f608 | 64 | * @nominal_volt: current nominal voltage for this voltage domain |
e3277880 KH |
65 | * @volt_data: voltage table having the distinct voltages supported |
66 | * by the domain and other associated per voltage data. | |
2f34ce81 TG |
67 | */ |
68 | struct voltagedomain { | |
69 | char *name; | |
37efca7e | 70 | bool scalable; |
81a60482 | 71 | struct list_head node; |
e69c22b1 | 72 | struct list_head pwrdm_list; |
d84adcf4 | 73 | struct omap_vc_channel *vc; |
5892bb1f | 74 | const struct omap_vfsm_instance *vfsm; |
b7ea803e | 75 | struct omap_vp_instance *vp; |
ce8ebe0d | 76 | struct omap_voltdm_pmic *pmic; |
d84adcf4 | 77 | |
4bcc475e KH |
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 | ||
0e2f3d9c KH |
83 | union { |
84 | const char *name; | |
85 | u32 rate; | |
86 | } sys_clk; | |
87 | ||
0f01565a KH |
88 | int (*scale) (struct voltagedomain *voltdm, |
89 | unsigned long target_volt); | |
90 | ||
e3277880 KH |
91 | u32 nominal_volt; |
92 | struct omap_volt_data *volt_data; | |
2f34ce81 TG |
93 | }; |
94 | ||
2f34ce81 | 95 | /** |
ce8ebe0d | 96 | * struct omap_voltdm_pmic - PMIC specific data required by voltage driver. |
2f34ce81 TG |
97 | * @slew_rate: PMIC slew rate (in uv/us) |
98 | * @step_size: PMIC voltage step size (in uv) | |
ba112a4e | 99 | * @i2c_slave_addr: I2C slave address of PMIC |
e74e4405 KH |
100 | * @volt_reg_addr: voltage configuration register address |
101 | * @cmd_reg_addr: command (on, on-LP, ret, off) configuration register address | |
f5395480 KH |
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 | |
e4e021c5 KH |
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. | |
2f34ce81 | 106 | */ |
ce8ebe0d | 107 | struct omap_voltdm_pmic { |
2f34ce81 TG |
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; | |
ba112a4e | 115 | u16 i2c_slave_addr; |
e4e021c5 KH |
116 | u16 volt_reg_addr; |
117 | u16 cmd_reg_addr; | |
2f34ce81 TG |
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; | |
f5395480 KH |
124 | bool i2c_high_speed; |
125 | u8 i2c_mcode; | |
2f34ce81 TG |
126 | unsigned long (*vsel_to_uv) (const u8 vsel); |
127 | u8 (*uv_to_vsel) (unsigned long uV); | |
128 | }; | |
129 | ||
2f34ce81 TG |
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); | |
2f34ce81 | 134 | int omap_voltage_register_pmic(struct voltagedomain *voltdm, |
ce8ebe0d | 135 | struct omap_voltdm_pmic *pmic); |
2f34ce81 TG |
136 | void omap_change_voltscale_method(struct voltagedomain *voltdm, |
137 | int voltscale_method); | |
138 | int omap_voltage_late_init(void); | |
2f34ce81 | 139 | |
aae030fa | 140 | extern void omap2xxx_voltagedomains_init(void); |
81a60482 | 141 | extern void omap3xxx_voltagedomains_init(void); |
ce3fc89a | 142 | extern void am33xx_voltagedomains_init(void); |
81a60482 KH |
143 | extern void omap44xx_voltagedomains_init(void); |
144 | ||
145 | struct voltagedomain *voltdm_lookup(const char *name); | |
146 | void voltdm_init(struct voltagedomain **voltdm_list); | |
048a7034 | 147 | int voltdm_add_pwrdm(struct voltagedomain *voltdm, struct powerdomain *pwrdm); |
e69c22b1 KH |
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)); | |
5e5651be KH |
153 | int voltdm_scale(struct voltagedomain *voltdm, unsigned long target_volt); |
154 | void voltdm_reset(struct voltagedomain *voltdm); | |
d5c12828 | 155 | unsigned long voltdm_get_voltage(struct voltagedomain *voltdm); |
2f34ce81 | 156 | #endif |