blob: c86301330b7577c1e1e5344daf36276dcfc87825 [file] [log] [blame]
Paul Walmsleyc0718df2011-03-10 22:17:45 -07001/*
2 * OMAP3/4 Voltage Controller (VC) structure and macro definitions
3 *
4 * Copyright (C) 2007, 2010 Texas Instruments, Inc.
5 * Rajendra Nayak <rnayak@ti.com>
6 * Lesly A M <x0080970@ti.com>
7 * Thara Gopinath <thara@ti.com>
8 *
9 * Copyright (C) 2008, 2011 Nokia Corporation
10 * Kalle Jokiniemi
11 * Paul Walmsley
12 *
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License version
15 * 2 as published by the Free Software Foundation.
16 */
17#ifndef __ARCH_ARM_MACH_OMAP2_VC_H
18#define __ARCH_ARM_MACH_OMAP2_VC_H
19
20#include <linux/kernel.h>
21
Kevin Hilmanccd5ca72011-03-21 14:08:55 -070022struct voltagedomain;
23
Paul Walmsleyc0718df2011-03-10 22:17:45 -070024/**
Kevin Hilmand84adcf2011-03-22 16:14:57 -070025 * struct omap_vc_common - per-VC register/bitfield data
Paul Walmsleyc0718df2011-03-10 22:17:45 -070026 * @cmd_on_mask: ON bitmask in PRM_VC_CMD_VAL* register
27 * @valid: VALID bitmask in PRM_VC_BYPASS_VAL register
28 * @smps_sa_reg: Offset of PRM_VC_SMPS_SA reg from PRM start
29 * @smps_volra_reg: Offset of PRM_VC_SMPS_VOL_RA reg from PRM start
Kevin Hilmane4e021c2011-06-09 11:01:55 -070030 * @smps_cmdra_reg: Offset of PRM_VC_SMPS_CMD_RA reg from PRM start
Paul Walmsleyc0718df2011-03-10 22:17:45 -070031 * @bypass_val_reg: Offset of PRM_VC_BYPASS_VAL reg from PRM start
32 * @data_shift: DATA field shift in PRM_VC_BYPASS_VAL register
33 * @slaveaddr_shift: SLAVEADDR field shift in PRM_VC_BYPASS_VAL register
34 * @regaddr_shift: REGADDR field shift in PRM_VC_BYPASS_VAL register
35 * @cmd_on_shift: ON field shift in PRM_VC_CMD_VAL_* register
36 * @cmd_onlp_shift: ONLP field shift in PRM_VC_CMD_VAL_* register
37 * @cmd_ret_shift: RET field shift in PRM_VC_CMD_VAL_* register
38 * @cmd_off_shift: OFF field shift in PRM_VC_CMD_VAL_* register
Kevin Hilmance8ebe02011-03-30 11:01:10 -070039 * @cfg_channel_reg: VC channel configuration register
Kevin Hilmanf5395482011-03-30 16:36:30 -070040 * @i2c_cfg_reg: I2C configuration register offset
41 * @i2c_cfg_hsen_mask: high-speed mode bit field mask in I2C config register
42 * @i2c_mcode_mask: MCODE field mask for I2C config register
Paul Walmsleyc0718df2011-03-10 22:17:45 -070043 *
44 * XXX One of cmd_on_mask and cmd_on_shift are not needed
45 * XXX VALID should probably be a shift, not a mask
46 */
Kevin Hilmand84adcf2011-03-22 16:14:57 -070047struct omap_vc_common {
Paul Walmsleyc0718df2011-03-10 22:17:45 -070048 u32 cmd_on_mask;
49 u32 valid;
Paul Walmsleyc0718df2011-03-10 22:17:45 -070050 u8 smps_sa_reg;
51 u8 smps_volra_reg;
Kevin Hilmane4e021c2011-06-09 11:01:55 -070052 u8 smps_cmdra_reg;
Paul Walmsleyc0718df2011-03-10 22:17:45 -070053 u8 bypass_val_reg;
54 u8 data_shift;
55 u8 slaveaddr_shift;
56 u8 regaddr_shift;
57 u8 cmd_on_shift;
58 u8 cmd_onlp_shift;
59 u8 cmd_ret_shift;
60 u8 cmd_off_shift;
Kevin Hilman24d31942011-03-29 15:57:16 -070061 u8 cfg_channel_reg;
Kevin Hilmanf5395482011-03-30 16:36:30 -070062 u8 i2c_cfg_reg;
63 u8 i2c_cfg_hsen_mask;
64 u8 i2c_mcode_mask;
Paul Walmsleyc0718df2011-03-10 22:17:45 -070065};
66
Kevin Hilman24d31942011-03-29 15:57:16 -070067/* omap_vc_channel.flags values */
68#define OMAP_VC_CHANNEL_DEFAULT BIT(0)
69
Paul Walmsleyc0718df2011-03-10 22:17:45 -070070/**
Kevin Hilmand84adcf2011-03-22 16:14:57 -070071 * struct omap_vc_channel - VC per-instance data
Kevin Hilmanba112a42011-03-29 14:02:36 -070072 * @i2c_slave_addr: I2C slave address of PMIC for this VC channel
Kevin Hilmane4e021c2011-06-09 11:01:55 -070073 * @volt_reg_addr: voltage configuration register address
74 * @cmd_reg_addr: command configuration register address
Kevin Hilman5892bb12011-03-29 14:36:04 -070075 * @setup_time: setup time (in sys_clk cycles) of regulator for this channel
Kevin Hilmance8ebe02011-03-30 11:01:10 -070076 * @cfg_channel: current value of VC channel configuration register
Kevin Hilmanf5395482011-03-30 16:36:30 -070077 * @i2c_high_speed: whether or not to use I2C high-speed mode
Kevin Hilmance8ebe02011-03-30 11:01:10 -070078 *
Kevin Hilmand84adcf2011-03-22 16:14:57 -070079 * @common: pointer to VC common data for this platform
Kevin Hilmanba112a42011-03-29 14:02:36 -070080 * @smps_sa_mask: i2c slave address bitmask in the PRM_VC_SMPS_SA register
Paul Walmsleyc0718df2011-03-10 22:17:45 -070081 * @smps_volra_mask: VOLRA* bitmask in the PRM_VC_VOL_RA register
Kevin Hilmane4e021c2011-06-09 11:01:55 -070082 * @smps_cmdra_mask: CMDRA* bitmask in the PRM_VC_CMD_RA register
83 * @cmdval_reg: register for on/ret/off voltage level values for this channel
Kevin Hilmance8ebe02011-03-30 11:01:10 -070084 * @cfg_channel_sa_shift: bit shift for slave address cfg_channel register
Kevin Hilman24d31942011-03-29 15:57:16 -070085 * @flags: VC channel-specific flags (optional)
Paul Walmsleyc0718df2011-03-10 22:17:45 -070086 */
Kevin Hilmand84adcf2011-03-22 16:14:57 -070087struct omap_vc_channel {
Kevin Hilmanba112a42011-03-29 14:02:36 -070088 /* channel state */
89 u16 i2c_slave_addr;
Kevin Hilmane4e021c2011-06-09 11:01:55 -070090 u16 volt_reg_addr;
91 u16 cmd_reg_addr;
Kevin Hilman5892bb12011-03-29 14:36:04 -070092 u16 setup_time;
Kevin Hilman24d31942011-03-29 15:57:16 -070093 u8 cfg_channel;
Kevin Hilmanf5395482011-03-30 16:36:30 -070094 bool i2c_high_speed;
Kevin Hilmanba112a42011-03-29 14:02:36 -070095
96 /* register access data */
Kevin Hilmand84adcf2011-03-22 16:14:57 -070097 const struct omap_vc_common *common;
Paul Walmsleyc0718df2011-03-10 22:17:45 -070098 u32 smps_sa_mask;
99 u32 smps_volra_mask;
Kevin Hilmane4e021c2011-06-09 11:01:55 -0700100 u32 smps_cmdra_mask;
Paul Walmsleyc0718df2011-03-10 22:17:45 -0700101 u8 cmdval_reg;
Kevin Hilman24d31942011-03-29 15:57:16 -0700102 u8 cfg_channel_sa_shift;
103 u8 flags;
Paul Walmsleyc0718df2011-03-10 22:17:45 -0700104};
105
Kevin Hilmand84adcf2011-03-22 16:14:57 -0700106extern struct omap_vc_channel omap3_vc_mpu;
107extern struct omap_vc_channel omap3_vc_core;
Paul Walmsleyc0718df2011-03-10 22:17:45 -0700108
Kevin Hilmand84adcf2011-03-22 16:14:57 -0700109extern struct omap_vc_channel omap4_vc_mpu;
110extern struct omap_vc_channel omap4_vc_iva;
111extern struct omap_vc_channel omap4_vc_core;
Paul Walmsleyc0718df2011-03-10 22:17:45 -0700112
Kevin Hilmanccd5ca72011-03-21 14:08:55 -0700113void omap_vc_init_channel(struct voltagedomain *voltdm);
114int omap_vc_pre_scale(struct voltagedomain *voltdm,
115 unsigned long target_volt,
116 u8 *target_vsel, u8 *current_vsel);
117void omap_vc_post_scale(struct voltagedomain *voltdm,
118 unsigned long target_volt,
119 u8 target_vsel, u8 current_vsel);
Kevin Hilmand84adcf2011-03-22 16:14:57 -0700120int omap_vc_bypass_scale(struct voltagedomain *voltdm,
121 unsigned long target_volt);
Kevin Hilmanccd5ca72011-03-21 14:08:55 -0700122
Paul Walmsleyc0718df2011-03-10 22:17:45 -0700123#endif
124