arch/arm/mach-omap2/vc.h

   1 /*
   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
  22 struct voltagedomain;
  23
  24 /**
  25  * struct omap_vc_common - per-VC register/bitfield data
  26  * @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
  30  * @smps_cmdra_reg: Offset of PRM_VC_SMPS_CMD_RA reg from PRM start
  31  * @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
  39  * @cfg_channel_reg: VC channel configuration register
  40  * @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
  43  *
  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  */
  47 struct omap_vc_common {
  48         u32 cmd_on_mask;
  49         u32 valid;
  50         u8 smps_sa_reg;
  51         u8 smps_volra_reg;
  52         u8 smps_cmdra_reg;
  53         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;
  61         u8 cfg_channel_reg;
  62         u8 i2c_cfg_reg;
  63         u8 i2c_cfg_hsen_mask;
  64         u8 i2c_mcode_mask;
  65 };
  66
  67 /* omap_vc_channel.flags values */
  68 #define OMAP_VC_CHANNEL_DEFAULT BIT(0)
  69 #define OMAP_VC_CHANNEL_CFG_MUTANT BIT(1)
  70
  71 /**
  72  * struct omap_vc_channel - VC per-instance data
  73  * @i2c_slave_addr: I2C slave address of PMIC for this VC channel
  74  * @volt_reg_addr: voltage configuration register address
  75  * @cmd_reg_addr: command configuration register address
  76  * @setup_time: setup time (in sys_clk cycles) of regulator for this channel
  77  * @cfg_channel: current value of VC channel configuration register
  78  * @i2c_high_speed: whether or not to use I2C high-speed mode
  79  *
  80  * @common: pointer to VC common data for this platform
  81  * @smps_sa_mask: i2c slave address bitmask in the PRM_VC_SMPS_SA register
  82  * @smps_volra_mask: VOLRA* bitmask in the PRM_VC_VOL_RA register
  83  * @smps_cmdra_mask: CMDRA* bitmask in the PRM_VC_CMD_RA register
  84  * @cmdval_reg: register for on/ret/off voltage level values for this channel
  85  * @cfg_channel_sa_shift: bit shift for slave address cfg_channel register
  86  * @flags: VC channel-specific flags (optional)
  87  */
  88 struct omap_vc_channel {
  89         /* channel state */
  90         u16 i2c_slave_addr;
  91         u16 volt_reg_addr;
  92         u16 cmd_reg_addr;
  93         u16 setup_time;
  94         u8 cfg_channel;
  95         bool i2c_high_speed;
  96
  97         /* register access data */
  98         const struct omap_vc_common *common;
  99         u32 smps_sa_mask;
 100         u32 smps_volra_mask;
 101         u32 smps_cmdra_mask;
 102         u8 cmdval_reg;
 103         u8 cfg_channel_sa_shift;
 104         u8 flags;
 105 };
 106
 107 extern struct omap_vc_channel omap3_vc_mpu;
 108 extern struct omap_vc_channel omap3_vc_core;
 109
 110 extern struct omap_vc_channel omap4_vc_mpu;
 111 extern struct omap_vc_channel omap4_vc_iva;
 112 extern struct omap_vc_channel omap4_vc_core;
 113
 114 void omap_vc_init_channel(struct voltagedomain *voltdm);
 115 int omap_vc_pre_scale(struct voltagedomain *voltdm,
 116                       unsigned long target_volt,
 117                       u8 *target_vsel, u8 *current_vsel);
 118 void omap_vc_post_scale(struct voltagedomain *voltdm,
 119                         unsigned long target_volt,
 120                         u8 target_vsel, u8 current_vsel);
 121 int omap_vc_bypass_scale(struct voltagedomain *voltdm,
 122                          unsigned long target_volt);
 123
 124 #endif
 125