Pileus Git - ~andy/linux/blob - arch/arm/mach-omap2/vp.h

   1 /*
   2  * OMAP3/4 Voltage Processor (VP) 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_VP_H
  18 #define __ARCH_ARM_MACH_OMAP2_VP_H
  19
  20 #include <linux/kernel.h>
  21
  22 struct voltagedomain;
  23
  24 /*
  25  * Voltage Processor (VP) identifiers
  26  */
  27 #define OMAP3_VP_VDD_MPU_ID 0
  28 #define OMAP3_VP_VDD_CORE_ID 1
  29 #define OMAP4_VP_VDD_CORE_ID 0
  30 #define OMAP4_VP_VDD_IVA_ID 1
  31 #define OMAP4_VP_VDD_MPU_ID 2
  32
  33 /* XXX document */
  34 #define VP_IDLE_TIMEOUT         200
  35 #define VP_TRANXDONE_TIMEOUT    300
  36
  37 /**
  38  * struct omap_vp_ops - per-VP operations
  39  * @check_txdone: check for VP transaction done
  40  * @clear_txdone: clear VP transaction done status
  41  */
  42 struct omap_vp_ops {
  43         u32 (*check_txdone)(u8 vp_id);
  44         void (*clear_txdone)(u8 vp_id);
  45 };
  46
  47 /**
  48  * struct omap_vp_common - register data common to all VDDs
  49  * @vpconfig_erroroffset_mask: ERROROFFSET bitmask in the PRM_VP*_CONFIG reg
  50  * @vpconfig_errorgain_mask: ERRORGAIN bitmask in the PRM_VP*_CONFIG reg
  51  * @vpconfig_initvoltage_mask: INITVOLTAGE bitmask in the PRM_VP*_CONFIG reg
  52  * @vpconfig_timeouten: TIMEOUT bitmask in the PRM_VP*_CONFIG reg
  53  * @vpconfig_initvdd: INITVDD bitmask in the PRM_VP*_CONFIG reg
  54  * @vpconfig_forceupdate: FORCEUPDATE bitmask in the PRM_VP*_CONFIG reg
  55  * @vpconfig_vpenable: VPENABLE bitmask in the PRM_VP*_CONFIG reg
  56  * @vpconfig_erroroffset_shift: ERROROFFSET field shift in PRM_VP*_CONFIG reg
  57  * @vpconfig_errorgain_shift: ERRORGAIN field shift in PRM_VP*_CONFIG reg
  58  * @vpconfig_initvoltage_shift: INITVOLTAGE field shift in PRM_VP*_CONFIG reg
  59  * @vstepmin_stepmin_shift: VSTEPMIN field shift in the PRM_VP*_VSTEPMIN reg
  60  * @vstepmin_smpswaittimemin_shift: SMPSWAITTIMEMIN field shift in PRM_VP*_VSTEPMIN reg
  61  * @vstepmax_stepmax_shift: VSTEPMAX field shift in the PRM_VP*_VSTEPMAX reg
  62  * @vstepmax_smpswaittimemax_shift: SMPSWAITTIMEMAX field shift in PRM_VP*_VSTEPMAX reg
  63  * @vlimitto_vddmin_shift: VDDMIN field shift in PRM_VP*_VLIMITTO reg
  64  * @vlimitto_vddmax_shift: VDDMAX field shift in PRM_VP*_VLIMITTO reg
  65  * @vlimitto_timeout_shift: TIMEOUT field shift in PRM_VP*_VLIMITTO reg
  66  */
  67 struct omap_vp_common {
  68         u32 vpconfig_erroroffset_mask;
  69         u32 vpconfig_errorgain_mask;
  70         u32 vpconfig_initvoltage_mask;
  71         u8 vpconfig_timeouten;
  72         u8 vpconfig_initvdd;
  73         u8 vpconfig_forceupdate;
  74         u8 vpconfig_vpenable;
  75         u8 vstepmin_stepmin_shift;
  76         u8 vstepmin_smpswaittimemin_shift;
  77         u8 vstepmax_stepmax_shift;
  78         u8 vstepmax_smpswaittimemax_shift;
  79         u8 vlimitto_vddmin_shift;
  80         u8 vlimitto_vddmax_shift;
  81         u8 vlimitto_timeout_shift;
  82
  83         const struct omap_vp_ops *ops;
  84 };
  85
  86 /**
  87  * struct omap_vp_instance - VP register offsets (per-VDD)
  88  * @common: pointer to struct omap_vp_common * for this SoC
  89  * @vpconfig: PRM_VP*_CONFIG reg offset from PRM start
  90  * @vstepmin: PRM_VP*_VSTEPMIN reg offset from PRM start
  91  * @vlimitto: PRM_VP*_VLIMITTO reg offset from PRM start
  92  * @vstatus: PRM_VP*_VSTATUS reg offset from PRM start
  93  * @voltage: PRM_VP*_VOLTAGE reg offset from PRM start
  94  * @id: Unique identifier for VP instance.
  95  * @enabled: flag to keep track of whether vp is enabled or not
  96  *
  97  * XXX vp_common is probably not needed since it is per-SoC
  98  */
  99 struct omap_vp_instance {
 100         const struct omap_vp_common *common;
 101         u8 vpconfig;
 102         u8 vstepmin;
 103         u8 vstepmax;
 104         u8 vlimitto;
 105         u8 vstatus;
 106         u8 voltage;
 107         u8 id;
 108         bool enabled;
 109 };
 110
 111 /**
 112  * struct omap_vp_runtime_data - VP data populated at runtime by code
 113  * @vpconfig_erroroffset: value of ERROROFFSET bitfield in PRM_VP*_CONFIG
 114  * @vpconfig_errorgain: value of ERRORGAIN bitfield in PRM_VP*_CONFIG
 115  * @vstepmin_smpswaittimemin: value of SMPSWAITTIMEMIN bitfield in PRM_VP*_VSTEPMIN
 116  * @vstepmax_smpswaittimemax: value of SMPSWAITTIMEMAX bitfield in PRM_VP*_VSTEPMAX
 117  * @vlimitto_timeout: value of TIMEOUT bitfield in PRM_VP*_VLIMITTO
 118  * @vstepmin_stepmin: value of VSTEPMIN bitfield in PRM_VP*_VSTEPMIN
 119  * @vstepmax_stepmax: value of VSTEPMAX bitfield in PRM_VP*_VSTEPMAX
 120  * @vlimitto_vddmin: value of VDDMIN bitfield in PRM_VP*_VLIMITTO
 121  * @vlimitto_vddmax: value of VDDMAX bitfield in PRM_VP*_VLIMITTO
 122  *
 123  * XXX Is this structure really needed?  Why not just program the
 124  * device directly?  They are in PRM space, therefore in the WKUP
 125  * powerdomain, so register contents should not be lost in off-mode.
 126  */
 127 struct omap_vp_runtime_data {
 128         u32 vpconfig_erroroffset;
 129         u16 vpconfig_errorgain;
 130         u16 vstepmin_smpswaittimemin;
 131         u16 vstepmax_smpswaittimemax;
 132         u16 vlimitto_timeout;
 133         u8 vstepmin_stepmin;
 134         u8 vstepmax_stepmax;
 135         u8 vlimitto_vddmin;
 136         u8 vlimitto_vddmax;
 137 };
 138
 139 extern struct omap_vp_instance omap3_vp_mpu;
 140 extern struct omap_vp_instance omap3_vp_core;
 141
 142 extern struct omap_vp_instance omap4_vp_mpu;
 143 extern struct omap_vp_instance omap4_vp_iva;
 144 extern struct omap_vp_instance omap4_vp_core;
 145
 146 void omap_vp_init(struct voltagedomain *voltdm);
 147 void omap_vp_enable(struct voltagedomain *voltdm);
 148 void omap_vp_disable(struct voltagedomain *voltdm);
 149 unsigned long omap_vp_get_curr_volt(struct voltagedomain *voltdm);
 150 int omap_vp_forceupdate_scale(struct voltagedomain *voltdm,
 151                               unsigned long target_volt);
 152
 153 #endif