OMAP2+: voltage: split voltage controller (VC) code into dedicated layer
[pandora-kernel.git] / 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_data - 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  * @prm_mod: PRM module id used for PRM register access
29  * @smps_sa_reg: Offset of PRM_VC_SMPS_SA reg from PRM start
30  * @smps_volra_reg: Offset of PRM_VC_SMPS_VOL_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  *
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  */
43 struct omap_vc_common_data {
44         u32 cmd_on_mask;
45         u32 valid;
46         s16 prm_mod;
47         u8 smps_sa_reg;
48         u8 smps_volra_reg;
49         u8 bypass_val_reg;
50         u8 data_shift;
51         u8 slaveaddr_shift;
52         u8 regaddr_shift;
53         u8 cmd_on_shift;
54         u8 cmd_onlp_shift;
55         u8 cmd_ret_shift;
56         u8 cmd_off_shift;
57 };
58
59 /**
60  * struct omap_vc_instance_data - VC per-instance data
61  * @vc_common: pointer to VC common data for this platform
62  * @smps_sa_mask: SA* bitmask in the PRM_VC_SMPS_SA register
63  * @smps_volra_mask: VOLRA* bitmask in the PRM_VC_VOL_RA register
64  * @smps_sa_shift: SA* field shift in the PRM_VC_SMPS_SA register
65  * @smps_volra_shift: VOLRA* field shift in the PRM_VC_VOL_RA register
66  *
67  * XXX It is not necessary to have both a *_mask and a *_shift -
68  *     remove one
69  */
70 struct omap_vc_instance_data {
71         const struct omap_vc_common_data *vc_common;
72         u32 smps_sa_mask;
73         u32 smps_volra_mask;
74         u8 cmdval_reg;
75         u8 smps_sa_shift;
76         u8 smps_volra_shift;
77 };
78
79 extern struct omap_vc_instance_data omap3_vc1_data;
80 extern struct omap_vc_instance_data omap3_vc2_data;
81
82 extern struct omap_vc_instance_data omap4_vc_mpu_data;
83 extern struct omap_vc_instance_data omap4_vc_iva_data;
84 extern struct omap_vc_instance_data omap4_vc_core_data;
85
86 void omap_vc_init_channel(struct voltagedomain *voltdm);
87 int omap_vc_pre_scale(struct voltagedomain *voltdm,
88                       unsigned long target_volt,
89                       u8 *target_vsel, u8 *current_vsel);
90 void omap_vc_post_scale(struct voltagedomain *voltdm,
91                         unsigned long target_volt,
92                         u8 target_vsel, u8 current_vsel);
93 int omap_vc_bypass_scale_voltage(struct voltagedomain *voltdm,
94                                  unsigned long target_volt);
95
96 #endif
97