arch/arm/mach-omap2/smartreflex.h

   1 /*
   2  * OMAP Smartreflex Defines and Routines
   3  *
   4  * Author: Thara Gopinath       <thara@ti.com>
   5  *
   6  * Copyright (C) 2010 Texas Instruments, Inc.
   7  * Thara Gopinath <thara@ti.com>
   8  *
   9  * Copyright (C) 2008 Nokia Corporation
  10  * Kalle Jokiniemi
  11  *
  12  * Copyright (C) 2007 Texas Instruments, Inc.
  13  * Lesly A M <x0080970@ti.com>
  14  *
  15  * This program is free software; you can redistribute it and/or modify
  16  * it under the terms of the GNU General Public License version 2 as
  17  * published by the Free Software Foundation.
  18  */
  19
  20 #ifndef __ASM_ARM_OMAP_SMARTREFLEX_H
  21 #define __ASM_ARM_OMAP_SMARTREFLEX_H
  22
  23 #include <linux/platform_device.h>
  24
  25 #include "voltage.h"
  26
  27 /*
  28  * Different Smartreflex IPs version. The v1 is the 65nm version used in
  29  * OMAP3430. The v2 is the update for the 45nm version of the IP
  30  * used in OMAP3630 and OMAP4430
  31  */
  32 #define SR_TYPE_V1      1
  33 #define SR_TYPE_V2      2
  34
  35 /* SMART REFLEX REG ADDRESS OFFSET */
  36 #define SRCONFIG                0x00
  37 #define SRSTATUS                0x04
  38 #define SENVAL                  0x08
  39 #define SENMIN                  0x0C
  40 #define SENMAX                  0x10
  41 #define SENAVG                  0x14
  42 #define AVGWEIGHT               0x18
  43 #define NVALUERECIPROCAL        0x1c
  44 #define SENERROR_V1             0x20
  45 #define ERRCONFIG_V1            0x24
  46 #define IRQ_EOI                 0x20
  47 #define IRQSTATUS_RAW           0x24
  48 #define IRQSTATUS               0x28
  49 #define IRQENABLE_SET           0x2C
  50 #define IRQENABLE_CLR           0x30
  51 #define SENERROR_V2             0x34
  52 #define ERRCONFIG_V2            0x38
  53
  54 /* Bit/Shift Positions */
  55
  56 /* SRCONFIG */
  57 #define SRCONFIG_ACCUMDATA_SHIFT        22
  58 #define SRCONFIG_SRCLKLENGTH_SHIFT      12
  59 #define SRCONFIG_SENNENABLE_V1_SHIFT    5
  60 #define SRCONFIG_SENPENABLE_V1_SHIFT    3
  61 #define SRCONFIG_SENNENABLE_V2_SHIFT    1
  62 #define SRCONFIG_SENPENABLE_V2_SHIFT    0
  63 #define SRCONFIG_CLKCTRL_SHIFT          0
  64
  65 #define SRCONFIG_ACCUMDATA_MASK         (0x3ff << 22)
  66
  67 #define SRCONFIG_SRENABLE               BIT(11)
  68 #define SRCONFIG_SENENABLE              BIT(10)
  69 #define SRCONFIG_ERRGEN_EN              BIT(9)
  70 #define SRCONFIG_MINMAXAVG_EN           BIT(8)
  71 #define SRCONFIG_DELAYCTRL              BIT(2)
  72
  73 /* AVGWEIGHT */
  74 #define AVGWEIGHT_SENPAVGWEIGHT_SHIFT   2
  75 #define AVGWEIGHT_SENNAVGWEIGHT_SHIFT   0
  76
  77 /* NVALUERECIPROCAL */
  78 #define NVALUERECIPROCAL_SENPGAIN_SHIFT 20
  79 #define NVALUERECIPROCAL_SENNGAIN_SHIFT 16
  80 #define NVALUERECIPROCAL_RNSENP_SHIFT   8
  81 #define NVALUERECIPROCAL_RNSENN_SHIFT   0
  82
  83 /* ERRCONFIG */
  84 #define ERRCONFIG_ERRWEIGHT_SHIFT       16
  85 #define ERRCONFIG_ERRMAXLIMIT_SHIFT     8
  86 #define ERRCONFIG_ERRMINLIMIT_SHIFT     0
  87
  88 #define SR_ERRWEIGHT_MASK               (0x07 << 16)
  89 #define SR_ERRMAXLIMIT_MASK             (0xff << 8)
  90 #define SR_ERRMINLIMIT_MASK             (0xff << 0)
  91
  92 #define ERRCONFIG_VPBOUNDINTEN_V1       BIT(31)
  93 #define ERRCONFIG_VPBOUNDINTST_V1       BIT(30)
  94 #define ERRCONFIG_MCUACCUMINTEN         BIT(29)
  95 #define ERRCONFIG_MCUACCUMINTST         BIT(28)
  96 #define ERRCONFIG_MCUVALIDINTEN         BIT(27)
  97 #define ERRCONFIG_MCUVALIDINTST         BIT(26)
  98 #define ERRCONFIG_MCUBOUNDINTEN         BIT(25)
  99 #define ERRCONFIG_MCUBOUNDINTST         BIT(24)
 100 #define ERRCONFIG_MCUDISACKINTEN        BIT(23)
 101 #define ERRCONFIG_VPBOUNDINTST_V2       BIT(23)
 102 #define ERRCONFIG_MCUDISACKINTST        BIT(22)
 103 #define ERRCONFIG_VPBOUNDINTEN_V2       BIT(22)
 104
 105 #define ERRCONFIG_STATUS_V1_MASK        (ERRCONFIG_VPBOUNDINTST_V1 | \
 106                                         ERRCONFIG_MCUACCUMINTST | \
 107                                         ERRCONFIG_MCUVALIDINTST | \
 108                                         ERRCONFIG_MCUBOUNDINTST | \
 109                                         ERRCONFIG_MCUDISACKINTST)
 110 /* IRQSTATUS */
 111 #define IRQSTATUS_MCUACCUMINT           BIT(3)
 112 #define IRQSTATUS_MCVALIDINT            BIT(2)
 113 #define IRQSTATUS_MCBOUNDSINT           BIT(1)
 114 #define IRQSTATUS_MCUDISABLEACKINT      BIT(0)
 115
 116 /* IRQENABLE_SET and IRQENABLE_CLEAR */
 117 #define IRQENABLE_MCUACCUMINT           BIT(3)
 118 #define IRQENABLE_MCUVALIDINT           BIT(2)
 119 #define IRQENABLE_MCUBOUNDSINT          BIT(1)
 120 #define IRQENABLE_MCUDISABLEACKINT      BIT(0)
 121
 122 /* Common Bit values */
 123
 124 #define SRCLKLENGTH_12MHZ_SYSCLK        0x3c
 125 #define SRCLKLENGTH_13MHZ_SYSCLK        0x41
 126 #define SRCLKLENGTH_19MHZ_SYSCLK        0x60
 127 #define SRCLKLENGTH_26MHZ_SYSCLK        0x82
 128 #define SRCLKLENGTH_38MHZ_SYSCLK        0xC0
 129
 130 /*
 131  * 3430 specific values. Maybe these should be passed from board file or
 132  * pmic structures.
 133  */
 134 #define OMAP3430_SR_ACCUMDATA           0x1f4
 135
 136 #define OMAP3430_SR1_SENPAVGWEIGHT      0x03
 137 #define OMAP3430_SR1_SENNAVGWEIGHT      0x03
 138
 139 #define OMAP3430_SR2_SENPAVGWEIGHT      0x01
 140 #define OMAP3430_SR2_SENNAVGWEIGHT      0x01
 141
 142 #define OMAP3430_SR_ERRWEIGHT           0x04
 143 #define OMAP3430_SR_ERRMAXLIMIT         0x02
 144
 145 /* Smart reflex notifiers for class drivers to use */
 146 #define SR_NOTIFY_MCUDISACK             BIT(3)
 147 #define SR_NOTIFY_MCUBOUND              BIT(2)
 148 #define SR_NOTIFY_MCUVALID              BIT(1)
 149 #define SR_NOTIFY_MCUACCUM              BIT(0)
 150
 151 /**
 152  * struct omap_sr_pmic_data - Strucutre to be populated by pmic code to pass
 153  *                              pmic specific info to smartreflex driver
 154  *
 155  * @sr_pmic_init:       API to initialize smartreflex on the PMIC side.
 156  */
 157 struct omap_sr_pmic_data {
 158         void (*sr_pmic_init) (void);
 159 };
 160
 161 /**
 162  * struct omap_smartreflex_dev_attr - Smartreflex Device attribute.
 163  *
 164  * @sensor_voltdm_name:       Name of voltdomain of SR instance
 165  */
 166 struct omap_smartreflex_dev_attr {
 167         const char      *sensor_voltdm_name;
 168 };
 169
 170 #ifdef CONFIG_OMAP_SMARTREFLEX
 171 /*
 172  * The smart reflex driver supports CLASS1 CLASS2 and CLASS3 SR.
 173  * The smartreflex class driver should pass the class type.
 174  * Should be used to populate the class_type field of the
 175  * omap_smartreflex_class_data structure.
 176  */
 177 #define SR_CLASS1       0x1
 178 #define SR_CLASS2       0x2
 179 #define SR_CLASS3       0x3
 180 #define SR_CLASS1P5     0x4
 181
 182 /**
 183  * struct omap_sr_class_data - Smartreflex class driver info
 184  *
 185  * @enable:             API to enable a particular class smaartreflex.
 186  * @disable:            API to disable a particular class smartreflex.
 187  * @init:               API to do class specific initialization (optional)
 188  * @deinit:             API to do class specific deinitialization (optional)
 189  * @configure:          API to configure a particular class smartreflex.
 190  * @notify:             API to notify the class driver about an event in SR.
 191  *                      Not needed for class3.
 192  * @notify_flags:       specify the events to be notified to the class driver
 193  * @class_type:         specify which smartreflex class.
 194  *                      Can be used by the SR driver to take any class
 195  *                      based decisions.
 196  * @class_priv_data:    Class specific private data (optional)
 197  */
 198 struct omap_sr_class_data {
 199         int (*enable)(struct voltagedomain *voltdm, void *voltdm_cdata,
 200                         struct omap_volt_data *volt_data);
 201         int (*disable)(struct voltagedomain *voltdm, void *voltdm_cdata,
 202                         struct omap_volt_data *volt_data, int is_volt_reset);
 203         int (*init)(struct voltagedomain *voltdm, void **voltdm_cdata,
 204                         void *class_priv_data);
 205         int (*deinit)(struct voltagedomain *voltdm, void **voltdm_cdata,
 206                         void *class_priv_data);
 207         int (*configure)(struct voltagedomain *voltdm, void *voltdm_cdata);
 208         int (*notify)(struct voltagedomain *voltdm, void *voltdm_cdata,
 209                         u32 status);
 210         u8 notify_flags;
 211         u8 class_type;
 212         void *class_priv_data;
 213 };
 214
 215 /**
 216  * struct omap_sr_nvalue_table  - Smartreflex n-target value info
 217  *
 218  * @efuse_offs: The offset of the efuse where n-target values are stored.
 219  * @nvalue:     The n-target value.
 220  */
 221 struct omap_sr_nvalue_table {
 222         u32 efuse_offs;
 223         u32 nvalue;
 224 };
 225
 226 /**
 227  * struct omap_sr_data - Smartreflex platform data.
 228  *
 229  * @ip_type:            Smartreflex IP type.
 230  * @senp_mod:           SENPENABLE value for the sr
 231  * @senn_mod:           SENNENABLE value for sr
 232  * @nvalue_count:       Number of distinct nvalues in the nvalue table
 233  * @enable_on_init:     whether this sr module needs to enabled at
 234  *                      boot up or not.
 235  * @nvalue_table:       table containing the  efuse offsets and nvalues
 236  *                      corresponding to them.
 237  * @voltdm:             Pointer to the voltage domain associated with the SR
 238  */
 239 struct omap_sr_data {
 240         int                             ip_type;
 241         u32                             senp_mod;
 242         u32                             senn_mod;
 243         int                             nvalue_count;
 244         bool                            enable_on_init;
 245         struct omap_sr_nvalue_table     *nvalue_table;
 246         struct voltagedomain            *voltdm;
 247 };
 248
 249 /* Smartreflex module enable/disable interface */
 250 void omap_sr_enable(struct voltagedomain *voltdm,
 251                         struct omap_volt_data *volt_data);
 252 void omap_sr_disable(struct voltagedomain *voltdm);
 253 int omap_sr_disable_reset_volt(struct voltagedomain *voltdm);
 254
 255 /* API to register the pmic specific data with the smartreflex driver. */
 256 void omap_sr_register_pmic(struct omap_sr_pmic_data *pmic_data);
 257
 258 /* Smartreflex driver hooks to be called from Smartreflex class driver */
 259 int sr_enable(struct voltagedomain *voltdm, struct omap_volt_data *volt_data);
 260 void sr_disable(struct voltagedomain *voltdm);
 261 int sr_notifier_control(struct voltagedomain *voltdm, bool enable);
 262 int sr_configure_errgen(struct voltagedomain *voltdm);
 263 int sr_disable_errgen(struct voltagedomain *voltdm);
 264 int sr_configure_minmax(struct voltagedomain *voltdm);
 265
 266 /* API to register the smartreflex class driver with the smartreflex driver */
 267 int sr_register_class(struct omap_sr_class_data *class_data);
 268 bool is_sr_enabled(struct voltagedomain *voltdm);
 269 #else
 270 static inline void omap_sr_enable(struct voltagedomain *voltdm) {}
 271 static inline void omap_sr_disable(struct voltagedomain *voltdm) {}
 272
 273 static inline int sr_notifier_control(struct voltagedomain *voltdm,
 274                 bool enable)
 275 {
 276         return -EINVAL;
 277 }
 278
 279 static inline int omap_sr_disable_reset_volt(
 280                 struct voltagedomain *voltdm) { return 0; }
 281 static inline void omap_sr_register_pmic(
 282                 struct omap_sr_pmic_data *pmic_data) {}
 283 static inline bool is_sr_enabled(struct voltagedomain *voltdm)
 284 {
 285         return false;
 286 }
 287 #endif
 288
 289 #endif