blob: 91c8d75bf2ead7759b7d19d3eb7a569c8e89422f [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
Paul Walmsleyc0718df2011-03-10 22:17:45 -070028 * @bypass_val_reg: Offset of PRM_VC_BYPASS_VAL reg from PRM start
29 * @data_shift: DATA field shift in PRM_VC_BYPASS_VAL register
30 * @slaveaddr_shift: SLAVEADDR field shift in PRM_VC_BYPASS_VAL register
31 * @regaddr_shift: REGADDR field shift in PRM_VC_BYPASS_VAL register
32 * @cmd_on_shift: ON field shift in PRM_VC_CMD_VAL_* register
33 * @cmd_onlp_shift: ONLP field shift in PRM_VC_CMD_VAL_* register
34 * @cmd_ret_shift: RET field shift in PRM_VC_CMD_VAL_* register
35 * @cmd_off_shift: OFF field shift in PRM_VC_CMD_VAL_* register
Kevin Hilmanf5395482011-03-30 16:36:30 -070036 * @i2c_cfg_reg: I2C configuration register offset
37 * @i2c_cfg_hsen_mask: high-speed mode bit field mask in I2C config register
38 * @i2c_mcode_mask: MCODE field mask for I2C config register
Paul Walmsleyc0718df2011-03-10 22:17:45 -070039 *
40 * XXX One of cmd_on_mask and cmd_on_shift are not needed
41 * XXX VALID should probably be a shift, not a mask
42 */
Kevin Hilmand84adcf2011-03-22 16:14:57 -070043struct omap_vc_common {
Paul Walmsleyc0718df2011-03-10 22:17:45 -070044 u32 cmd_on_mask;
45 u32 valid;
Paul Walmsleyc0718df2011-03-10 22:17:45 -070046 u8 bypass_val_reg;
47 u8 data_shift;
48 u8 slaveaddr_shift;
49 u8 regaddr_shift;
50 u8 cmd_on_shift;
51 u8 cmd_onlp_shift;
52 u8 cmd_ret_shift;
53 u8 cmd_off_shift;
Kevin Hilmanf5395482011-03-30 16:36:30 -070054 u8 i2c_cfg_reg;
55 u8 i2c_cfg_hsen_mask;
56 u8 i2c_mcode_mask;
Paul Walmsleyc0718df2011-03-10 22:17:45 -070057};
58
Kevin Hilman24d31942011-03-29 15:57:16 -070059/* omap_vc_channel.flags values */
60#define OMAP_VC_CHANNEL_DEFAULT BIT(0)
Kevin Hilman8abc0b52011-06-02 17:28:13 -070061#define OMAP_VC_CHANNEL_CFG_MUTANT BIT(1)
Kevin Hilman24d31942011-03-29 15:57:16 -070062
Paul Walmsleyc0718df2011-03-10 22:17:45 -070063/**
Kevin Hilmand84adcf2011-03-22 16:14:57 -070064 * struct omap_vc_channel - VC per-instance data
Kevin Hilmanba112a42011-03-29 14:02:36 -070065 * @i2c_slave_addr: I2C slave address of PMIC for this VC channel
Kevin Hilmane4e021c2011-06-09 11:01:55 -070066 * @volt_reg_addr: voltage configuration register address
67 * @cmd_reg_addr: command configuration register address
Kevin Hilman5892bb12011-03-29 14:36:04 -070068 * @setup_time: setup time (in sys_clk cycles) of regulator for this channel
Kevin Hilmance8ebe02011-03-30 11:01:10 -070069 * @cfg_channel: current value of VC channel configuration register
Kevin Hilmanf5395482011-03-30 16:36:30 -070070 * @i2c_high_speed: whether or not to use I2C high-speed mode
Kevin Hilmance8ebe02011-03-30 11:01:10 -070071 *
Kevin Hilmand84adcf2011-03-22 16:14:57 -070072 * @common: pointer to VC common data for this platform
Kevin Hilmanba112a42011-03-29 14:02:36 -070073 * @smps_sa_mask: i2c slave address bitmask in the PRM_VC_SMPS_SA register
Paul Walmsleyc0718df2011-03-10 22:17:45 -070074 * @smps_volra_mask: VOLRA* bitmask in the PRM_VC_VOL_RA register
Kevin Hilmane4e021c2011-06-09 11:01:55 -070075 * @smps_cmdra_mask: CMDRA* bitmask in the PRM_VC_CMD_RA register
76 * @cmdval_reg: register for on/ret/off voltage level values for this channel
Kevin Hilman5876c942011-07-20 16:35:46 -070077 * @smps_sa_reg: Offset of PRM_VC_SMPS_SA reg from PRM start
78 * @smps_volra_reg: Offset of PRM_VC_SMPS_VOL_RA reg from PRM start
79 * @smps_cmdra_reg: Offset of PRM_VC_SMPS_CMD_RA reg from PRM start
80 * @cfg_channel_reg: VC channel configuration register
Kevin Hilmance8ebe02011-03-30 11:01:10 -070081 * @cfg_channel_sa_shift: bit shift for slave address cfg_channel register
Kevin Hilman24d31942011-03-29 15:57:16 -070082 * @flags: VC channel-specific flags (optional)
Paul Walmsleyc0718df2011-03-10 22:17:45 -070083 */
Kevin Hilmand84adcf2011-03-22 16:14:57 -070084struct omap_vc_channel {
Kevin Hilmanba112a42011-03-29 14:02:36 -070085 /* channel state */
86 u16 i2c_slave_addr;
Kevin Hilmane4e021c2011-06-09 11:01:55 -070087 u16 volt_reg_addr;
88 u16 cmd_reg_addr;
Kevin Hilman24d31942011-03-29 15:57:16 -070089 u8 cfg_channel;
Kevin Hilmanf5395482011-03-30 16:36:30 -070090 bool i2c_high_speed;
Kevin Hilmanba112a42011-03-29 14:02:36 -070091
92 /* register access data */
Kevin Hilmand84adcf2011-03-22 16:14:57 -070093 const struct omap_vc_common *common;
Paul Walmsleyc0718df2011-03-10 22:17:45 -070094 u32 smps_sa_mask;
95 u32 smps_volra_mask;
Kevin Hilmane4e021c2011-06-09 11:01:55 -070096 u32 smps_cmdra_mask;
Paul Walmsleyc0718df2011-03-10 22:17:45 -070097 u8 cmdval_reg;
Kevin Hilman5876c942011-07-20 16:35:46 -070098 u8 smps_sa_reg;
99 u8 smps_volra_reg;
100 u8 smps_cmdra_reg;
101 u8 cfg_channel_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
Tero Kristo8b5d8c02012-09-25 19:33:35 +0300113extern struct omap_vc_param omap3_mpu_vc_data;
114extern struct omap_vc_param omap3_core_vc_data;
115
116extern struct omap_vc_param omap4_mpu_vc_data;
117extern struct omap_vc_param omap4_iva_vc_data;
118extern struct omap_vc_param omap4_core_vc_data;
119
Kevin Hilmanccd5ca72011-03-21 14:08:55 -0700120void omap_vc_init_channel(struct voltagedomain *voltdm);
121int omap_vc_pre_scale(struct voltagedomain *voltdm,
122 unsigned long target_volt,
123 u8 *target_vsel, u8 *current_vsel);
124void omap_vc_post_scale(struct voltagedomain *voltdm,
125 unsigned long target_volt,
126 u8 target_vsel, u8 current_vsel);
Kevin Hilmand84adcf2011-03-22 16:14:57 -0700127int omap_vc_bypass_scale(struct voltagedomain *voltdm,
128 unsigned long target_volt);
Kevin Hilmanccd5ca72011-03-21 14:08:55 -0700129
Paul Walmsleyc0718df2011-03-10 22:17:45 -0700130#endif
131