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  *
  41  * XXX One of cmd_on_mask and cmd_on_shift are not needed
  42  * XXX VALID should probably be a shift, not a mask
  43  */
  44 struct omap_vc_common {
  45         u32 cmd_on_mask;
  46         u32 valid;
  47         u8 smps_sa_reg;
  48         u8 smps_volra_reg;
  49         u8 smps_cmdra_reg;
  50         u8 bypass_val_reg;
  51         u8 data_shift;
  52         u8 slaveaddr_shift;
  53         u8 regaddr_shift;
  54         u8 cmd_on_shift;
  55         u8 cmd_onlp_shift;
  56         u8 cmd_ret_shift;
  57         u8 cmd_off_shift;
  58         u8 cfg_channel_reg;
  59 };
  60
  61 /* omap_vc_channel.flags values */
  62 #define OMAP_VC_CHANNEL_DEFAULT BIT(0)
  63
  64 /**
  65  * struct omap_vc_channel - VC per-instance data
  66  * @i2c_slave_addr: I2C slave address of PMIC for this VC channel
  67  * @volt_reg_addr: voltage configuration register address
  68  * @cmd_reg_addr: command configuration register address
  69  * @setup_time: setup time (in sys_clk cycles) of regulator for this channel
  70  * @cfg_channel: current value of VC channel configuration register
  71  *
  72  * @common: pointer to VC common data for this platform
  73  * @smps_sa_mask: i2c slave address bitmask in the PRM_VC_SMPS_SA register
  74  * @smps_volra_mask: VOLRA* bitmask in the PRM_VC_VOL_RA register
  75  * @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
  77  * @cfg_channel_sa_shift: bit shift for slave address cfg_channel register
  78  * @flags: VC channel-specific flags (optional)
  79  */
  80 struct omap_vc_channel {
  81         /* channel state */
  82         u16 i2c_slave_addr;
  83         u16 volt_reg_addr;
  84         u16 cmd_reg_addr;
  85         u16 setup_time;
  86         u8 cfg_channel;
  87
  88         /* register access data */
  89         const struct omap_vc_common *common;
  90         u32 smps_sa_mask;
  91         u32 smps_volra_mask;
  92         u32 smps_cmdra_mask;
  93         u8 cmdval_reg;
  94         u8 cfg_channel_sa_shift;
  95         u8 flags;
  96 };
  97
  98 extern struct omap_vc_channel omap3_vc_mpu;
  99 extern struct omap_vc_channel omap3_vc_core;
 100
 101 extern struct omap_vc_channel omap4_vc_mpu;
 102 extern struct omap_vc_channel omap4_vc_iva;
 103 extern struct omap_vc_channel omap4_vc_core;
 104
 105 void omap_vc_init_channel(struct voltagedomain *voltdm);
 106 int omap_vc_pre_scale(struct voltagedomain *voltdm,
 107                       unsigned long target_volt,
 108                       u8 *target_vsel, u8 *current_vsel);
 109 void omap_vc_post_scale(struct voltagedomain *voltdm,
 110                         unsigned long target_volt,
 111                         u8 target_vsel, u8 current_vsel);
 112 int omap_vc_bypass_scale(struct voltagedomain *voltdm,
 113                          unsigned long target_volt);
 114
 115 #endif
 116