mfd: twl4030-power: Add recommended idle configuration
[linux-2.6-block.git] / drivers / mfd / twl4030-power.c
CommitLineData
ebf0bd36
AK
1/*
2 * linux/drivers/i2c/chips/twl4030-power.c
3 *
4 * Handle TWL4030 Power initialization
5 *
6 * Copyright (C) 2008 Nokia Corporation
7 * Copyright (C) 2006 Texas Instruments, Inc
8 *
9 * Written by Kalle Jokiniemi
10 * Peter De Schrijver <peter.de-schrijver@nokia.com>
11 * Several fixes by Amit Kucheria <amit.kucheria@verdurent.com>
12 *
13 * This file is subject to the terms and conditions of the GNU General
14 * Public License. See the file "COPYING" in the main directory of this
15 * archive for more details.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 */
26
27#include <linux/module.h>
28#include <linux/pm.h>
b07682b6 29#include <linux/i2c/twl.h>
ebf0bd36 30#include <linux/platform_device.h>
b0fc1da4 31#include <linux/of.h>
e7cd1d1e 32#include <linux/of_device.h>
ebf0bd36
AK
33
34#include <asm/mach-types.h>
35
36static u8 twl4030_start_script_address = 0x2b;
37
32057281
TL
38/* Register bits for P1, P2 and P3_SW_EVENTS */
39#define PWR_STOPON_PRWON BIT(6)
40#define PWR_STOPON_SYSEN BIT(5)
41#define PWR_ENABLE_WARMRESET BIT(4)
42#define PWR_LVL_WAKEUP BIT(3)
43#define PWR_DEVACT BIT(2)
44#define PWR_DEVSLP BIT(1)
45#define PWR_DEVOFF BIT(0)
46
26cc3ab9 47#define SEQ_OFFSYNC (1 << 0)
ebf0bd36
AK
48
49#define PHY_TO_OFF_PM_MASTER(p) (p - 0x36)
50#define PHY_TO_OFF_PM_RECEIVER(p) (p - 0x5b)
51
52/* resource - hfclk */
53#define R_HFCLKOUT_DEV_GRP PHY_TO_OFF_PM_RECEIVER(0xe6)
54
55/* PM events */
56#define R_P1_SW_EVENTS PHY_TO_OFF_PM_MASTER(0x46)
57#define R_P2_SW_EVENTS PHY_TO_OFF_PM_MASTER(0x47)
58#define R_P3_SW_EVENTS PHY_TO_OFF_PM_MASTER(0x48)
59#define R_CFG_P1_TRANSITION PHY_TO_OFF_PM_MASTER(0x36)
60#define R_CFG_P2_TRANSITION PHY_TO_OFF_PM_MASTER(0x37)
61#define R_CFG_P3_TRANSITION PHY_TO_OFF_PM_MASTER(0x38)
62
ebf0bd36
AK
63#define END_OF_SCRIPT 0x3f
64
65#define R_SEQ_ADD_A2S PHY_TO_OFF_PM_MASTER(0x55)
66#define R_SEQ_ADD_S2A12 PHY_TO_OFF_PM_MASTER(0x56)
67#define R_SEQ_ADD_S2A3 PHY_TO_OFF_PM_MASTER(0x57)
68#define R_SEQ_ADD_WARM PHY_TO_OFF_PM_MASTER(0x58)
69#define R_MEMORY_ADDRESS PHY_TO_OFF_PM_MASTER(0x59)
70#define R_MEMORY_DATA PHY_TO_OFF_PM_MASTER(0x5a)
71
890463f0
AK
72/* resource configuration registers
73 <RESOURCE>_DEV_GRP at address 'n+0'
74 <RESOURCE>_TYPE at address 'n+1'
75 <RESOURCE>_REMAP at address 'n+2'
76 <RESOURCE>_DEDICATED at address 'n+3'
77*/
e97d1546 78#define DEV_GRP_OFFSET 0
ebf0bd36 79#define TYPE_OFFSET 1
b4ead61e
AK
80#define REMAP_OFFSET 2
81#define DEDICATED_OFFSET 3
ebf0bd36 82
e97d1546 83/* Bit positions in the registers */
890463f0
AK
84
85/* <RESOURCE>_DEV_GRP */
e97d1546
AK
86#define DEV_GRP_SHIFT 5
87#define DEV_GRP_MASK (7 << DEV_GRP_SHIFT)
890463f0
AK
88
89/* <RESOURCE>_TYPE */
ebf0bd36
AK
90#define TYPE_SHIFT 0
91#define TYPE_MASK (7 << TYPE_SHIFT)
92#define TYPE2_SHIFT 3
93#define TYPE2_MASK (3 << TYPE2_SHIFT)
94
b4ead61e
AK
95/* <RESOURCE>_REMAP */
96#define SLEEP_STATE_SHIFT 0
97#define SLEEP_STATE_MASK (0xf << SLEEP_STATE_SHIFT)
98#define OFF_STATE_SHIFT 4
99#define OFF_STATE_MASK (0xf << OFF_STATE_SHIFT)
100
ebf0bd36
AK
101static u8 res_config_addrs[] = {
102 [RES_VAUX1] = 0x17,
103 [RES_VAUX2] = 0x1b,
104 [RES_VAUX3] = 0x1f,
105 [RES_VAUX4] = 0x23,
106 [RES_VMMC1] = 0x27,
107 [RES_VMMC2] = 0x2b,
108 [RES_VPLL1] = 0x2f,
109 [RES_VPLL2] = 0x33,
110 [RES_VSIM] = 0x37,
111 [RES_VDAC] = 0x3b,
112 [RES_VINTANA1] = 0x3f,
113 [RES_VINTANA2] = 0x43,
114 [RES_VINTDIG] = 0x47,
115 [RES_VIO] = 0x4b,
116 [RES_VDD1] = 0x55,
117 [RES_VDD2] = 0x63,
118 [RES_VUSB_1V5] = 0x71,
119 [RES_VUSB_1V8] = 0x74,
120 [RES_VUSB_3V1] = 0x77,
121 [RES_VUSBCP] = 0x7a,
122 [RES_REGEN] = 0x7f,
123 [RES_NRES_PWRON] = 0x82,
124 [RES_CLKEN] = 0x85,
125 [RES_SYSEN] = 0x88,
126 [RES_HFCLKOUT] = 0x8b,
127 [RES_32KCLKOUT] = 0x8e,
128 [RES_RESET] = 0x91,
d7ac829f 129 [RES_MAIN_REF] = 0x94,
ebf0bd36
AK
130};
131
e7cd1d1e
TL
132/*
133 * Usable values for .remap_sleep and .remap_off
134 * Based on table "5.3.3 Resource Operating modes"
135 */
136enum {
137 TWL_REMAP_OFF = 0,
138 TWL_REMAP_SLEEP = 8,
139 TWL_REMAP_ACTIVE = 9,
140};
141
142/*
143 * Macros to configure the PM register states for various resources.
144 * Note that we can make MSG_SINGULAR etc private to this driver once
145 * omap3 has been made DT only.
146 */
147#define TWL_DFLT_DELAY 2 /* typically 2 32 KiHz cycles */
76714d2c 148#define TWL_DEV_GRP_P123 (DEV_GRP_P1 | DEV_GRP_P2 | DEV_GRP_P3)
e7cd1d1e
TL
149#define TWL_RESOURCE_SET(res, state) \
150 { MSG_SINGULAR(DEV_GRP_NULL, (res), (state)), TWL_DFLT_DELAY }
151#define TWL_RESOURCE_ON(res) TWL_RESOURCE_SET(res, RES_STATE_ACTIVE)
152#define TWL_RESOURCE_OFF(res) TWL_RESOURCE_SET(res, RES_STATE_OFF)
153#define TWL_RESOURCE_RESET(res) TWL_RESOURCE_SET(res, RES_STATE_WRST)
154/*
155 * It seems that type1 and type2 is just the resource init order
156 * number for the type1 and type2 group.
157 */
76714d2c
TL
158#define TWL_RESOURCE_SET_ACTIVE(res, state) \
159 { MSG_SINGULAR(DEV_GRP_NULL, (res), RES_STATE_ACTIVE), (state) }
e7cd1d1e
TL
160#define TWL_RESOURCE_GROUP_RESET(group, type1, type2) \
161 { MSG_BROADCAST(DEV_GRP_NULL, (group), (type1), (type2), \
162 RES_STATE_WRST), TWL_DFLT_DELAY }
76714d2c
TL
163#define TWL_RESOURCE_GROUP_SLEEP(group, type, type2) \
164 { MSG_BROADCAST(DEV_GRP_NULL, (group), (type), (type2), \
165 RES_STATE_SLEEP), TWL_DFLT_DELAY }
166#define TWL_RESOURCE_GROUP_ACTIVE(group, type, type2) \
167 { MSG_BROADCAST(DEV_GRP_NULL, (group), (type), (type2), \
168 RES_STATE_ACTIVE), TWL_DFLT_DELAY }
e7cd1d1e
TL
169#define TWL_REMAP_SLEEP(res, devgrp, typ, typ2) \
170 { .resource = (res), .devgroup = (devgrp), \
171 .type = (typ), .type2 = (typ2), \
172 .remap_off = TWL_REMAP_OFF, \
173 .remap_sleep = TWL_REMAP_SLEEP, }
76714d2c
TL
174#define TWL_REMAP_OFF(res, devgrp, typ, typ2) \
175 { .resource = (res), .devgroup = (devgrp), \
176 .type = (typ), .type2 = (typ2), \
177 .remap_off = TWL_REMAP_OFF, .remap_sleep = TWL_REMAP_OFF, }
e7cd1d1e 178
f791be49 179static int twl4030_write_script_byte(u8 address, u8 byte)
ebf0bd36
AK
180{
181 int err;
182
4850f124 183 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, address, R_MEMORY_ADDRESS);
ebf0bd36
AK
184 if (err)
185 goto out;
4850f124 186 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, byte, R_MEMORY_DATA);
ebf0bd36
AK
187out:
188 return err;
189}
190
f791be49 191static int twl4030_write_script_ins(u8 address, u16 pmb_message,
ebf0bd36
AK
192 u8 delay, u8 next)
193{
194 int err;
195
196 address *= 4;
197 err = twl4030_write_script_byte(address++, pmb_message >> 8);
198 if (err)
199 goto out;
200 err = twl4030_write_script_byte(address++, pmb_message & 0xff);
201 if (err)
202 goto out;
203 err = twl4030_write_script_byte(address++, delay);
204 if (err)
205 goto out;
206 err = twl4030_write_script_byte(address++, next);
207out:
208 return err;
209}
210
f791be49 211static int twl4030_write_script(u8 address, struct twl4030_ins *script,
ebf0bd36
AK
212 int len)
213{
f65e9eac 214 int err = -EINVAL;
ebf0bd36
AK
215
216 for (; len; len--, address++, script++) {
217 if (len == 1) {
218 err = twl4030_write_script_ins(address,
219 script->pmb_message,
220 script->delay,
221 END_OF_SCRIPT);
222 if (err)
223 break;
224 } else {
225 err = twl4030_write_script_ins(address,
226 script->pmb_message,
227 script->delay,
228 address + 1);
229 if (err)
230 break;
231 }
232 }
233 return err;
234}
235
f791be49 236static int twl4030_config_wakeup3_sequence(u8 address)
ebf0bd36
AK
237{
238 int err;
239 u8 data;
240
241 /* Set SLEEP to ACTIVE SEQ address for P3 */
4850f124 242 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, address, R_SEQ_ADD_S2A3);
ebf0bd36
AK
243 if (err)
244 goto out;
245
246 /* P3 LVL_WAKEUP should be on LEVEL */
4850f124 247 err = twl_i2c_read_u8(TWL_MODULE_PM_MASTER, &data, R_P3_SW_EVENTS);
ebf0bd36
AK
248 if (err)
249 goto out;
32057281 250 data |= PWR_LVL_WAKEUP;
4850f124 251 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, data, R_P3_SW_EVENTS);
ebf0bd36
AK
252out:
253 if (err)
254 pr_err("TWL4030 wakeup sequence for P3 config error\n");
255 return err;
256}
257
f791be49 258static int twl4030_config_wakeup12_sequence(u8 address)
ebf0bd36
AK
259{
260 int err = 0;
261 u8 data;
262
263 /* Set SLEEP to ACTIVE SEQ address for P1 and P2 */
4850f124 264 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, address, R_SEQ_ADD_S2A12);
ebf0bd36
AK
265 if (err)
266 goto out;
267
268 /* P1/P2 LVL_WAKEUP should be on LEVEL */
4850f124 269 err = twl_i2c_read_u8(TWL_MODULE_PM_MASTER, &data, R_P1_SW_EVENTS);
ebf0bd36
AK
270 if (err)
271 goto out;
272
32057281 273 data |= PWR_LVL_WAKEUP;
4850f124 274 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, data, R_P1_SW_EVENTS);
ebf0bd36
AK
275 if (err)
276 goto out;
277
4850f124 278 err = twl_i2c_read_u8(TWL_MODULE_PM_MASTER, &data, R_P2_SW_EVENTS);
ebf0bd36
AK
279 if (err)
280 goto out;
281
32057281 282 data |= PWR_LVL_WAKEUP;
4850f124 283 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, data, R_P2_SW_EVENTS);
ebf0bd36
AK
284 if (err)
285 goto out;
286
287 if (machine_is_omap_3430sdp() || machine_is_omap_ldp()) {
288 /* Disabling AC charger effect on sleep-active transitions */
4850f124
PU
289 err = twl_i2c_read_u8(TWL_MODULE_PM_MASTER, &data,
290 R_CFG_P1_TRANSITION);
ebf0bd36
AK
291 if (err)
292 goto out;
293 data &= ~(1<<1);
4850f124
PU
294 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, data,
295 R_CFG_P1_TRANSITION);
ebf0bd36
AK
296 if (err)
297 goto out;
298 }
299
300out:
301 if (err)
302 pr_err("TWL4030 wakeup sequence for P1 and P2" \
303 "config error\n");
304 return err;
305}
306
f791be49 307static int twl4030_config_sleep_sequence(u8 address)
ebf0bd36
AK
308{
309 int err;
310
311 /* Set ACTIVE to SLEEP SEQ address in T2 memory*/
4850f124 312 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, address, R_SEQ_ADD_A2S);
ebf0bd36
AK
313
314 if (err)
315 pr_err("TWL4030 sleep sequence config error\n");
316
317 return err;
318}
319
f791be49 320static int twl4030_config_warmreset_sequence(u8 address)
ebf0bd36
AK
321{
322 int err;
323 u8 rd_data;
324
325 /* Set WARM RESET SEQ address for P1 */
4850f124 326 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, address, R_SEQ_ADD_WARM);
ebf0bd36
AK
327 if (err)
328 goto out;
329
330 /* P1/P2/P3 enable WARMRESET */
4850f124 331 err = twl_i2c_read_u8(TWL_MODULE_PM_MASTER, &rd_data, R_P1_SW_EVENTS);
ebf0bd36
AK
332 if (err)
333 goto out;
334
32057281 335 rd_data |= PWR_ENABLE_WARMRESET;
4850f124 336 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, rd_data, R_P1_SW_EVENTS);
ebf0bd36
AK
337 if (err)
338 goto out;
339
4850f124 340 err = twl_i2c_read_u8(TWL_MODULE_PM_MASTER, &rd_data, R_P2_SW_EVENTS);
ebf0bd36
AK
341 if (err)
342 goto out;
343
32057281 344 rd_data |= PWR_ENABLE_WARMRESET;
4850f124 345 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, rd_data, R_P2_SW_EVENTS);
ebf0bd36
AK
346 if (err)
347 goto out;
348
4850f124 349 err = twl_i2c_read_u8(TWL_MODULE_PM_MASTER, &rd_data, R_P3_SW_EVENTS);
ebf0bd36
AK
350 if (err)
351 goto out;
352
32057281 353 rd_data |= PWR_ENABLE_WARMRESET;
4850f124 354 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, rd_data, R_P3_SW_EVENTS);
ebf0bd36
AK
355out:
356 if (err)
357 pr_err("TWL4030 warmreset seq config error\n");
358 return err;
359}
360
f791be49 361static int twl4030_configure_resource(struct twl4030_resconfig *rconfig)
ebf0bd36
AK
362{
363 int rconfig_addr;
364 int err;
365 u8 type;
366 u8 grp;
b4ead61e 367 u8 remap;
ebf0bd36
AK
368
369 if (rconfig->resource > TOTAL_RESOURCES) {
370 pr_err("TWL4030 Resource %d does not exist\n",
371 rconfig->resource);
372 return -EINVAL;
373 }
374
375 rconfig_addr = res_config_addrs[rconfig->resource];
376
377 /* Set resource group */
4850f124 378 err = twl_i2c_read_u8(TWL_MODULE_PM_RECEIVER, &grp,
fc7b92fc 379 rconfig_addr + DEV_GRP_OFFSET);
ebf0bd36
AK
380 if (err) {
381 pr_err("TWL4030 Resource %d group could not be read\n",
382 rconfig->resource);
383 return err;
384 }
385
56baa667 386 if (rconfig->devgroup != TWL4030_RESCONFIG_UNDEF) {
e97d1546
AK
387 grp &= ~DEV_GRP_MASK;
388 grp |= rconfig->devgroup << DEV_GRP_SHIFT;
4850f124 389 err = twl_i2c_write_u8(TWL_MODULE_PM_RECEIVER,
fc7b92fc 390 grp, rconfig_addr + DEV_GRP_OFFSET);
ebf0bd36
AK
391 if (err < 0) {
392 pr_err("TWL4030 failed to program devgroup\n");
393 return err;
394 }
395 }
396
397 /* Set resource types */
4850f124 398 err = twl_i2c_read_u8(TWL_MODULE_PM_RECEIVER, &type,
ebf0bd36
AK
399 rconfig_addr + TYPE_OFFSET);
400 if (err < 0) {
401 pr_err("TWL4030 Resource %d type could not be read\n",
402 rconfig->resource);
403 return err;
404 }
405
56baa667 406 if (rconfig->type != TWL4030_RESCONFIG_UNDEF) {
ebf0bd36
AK
407 type &= ~TYPE_MASK;
408 type |= rconfig->type << TYPE_SHIFT;
409 }
410
56baa667 411 if (rconfig->type2 != TWL4030_RESCONFIG_UNDEF) {
ebf0bd36
AK
412 type &= ~TYPE2_MASK;
413 type |= rconfig->type2 << TYPE2_SHIFT;
414 }
415
4850f124 416 err = twl_i2c_write_u8(TWL_MODULE_PM_RECEIVER,
ebf0bd36
AK
417 type, rconfig_addr + TYPE_OFFSET);
418 if (err < 0) {
419 pr_err("TWL4030 failed to program resource type\n");
420 return err;
421 }
422
b4ead61e 423 /* Set remap states */
4850f124 424 err = twl_i2c_read_u8(TWL_MODULE_PM_RECEIVER, &remap,
fc7b92fc 425 rconfig_addr + REMAP_OFFSET);
b4ead61e
AK
426 if (err < 0) {
427 pr_err("TWL4030 Resource %d remap could not be read\n",
428 rconfig->resource);
429 return err;
430 }
431
53cf9a60 432 if (rconfig->remap_off != TWL4030_RESCONFIG_UNDEF) {
b4ead61e
AK
433 remap &= ~OFF_STATE_MASK;
434 remap |= rconfig->remap_off << OFF_STATE_SHIFT;
435 }
436
53cf9a60 437 if (rconfig->remap_sleep != TWL4030_RESCONFIG_UNDEF) {
b4ead61e 438 remap &= ~SLEEP_STATE_MASK;
1ea933f4 439 remap |= rconfig->remap_sleep << SLEEP_STATE_SHIFT;
b4ead61e
AK
440 }
441
4850f124 442 err = twl_i2c_write_u8(TWL_MODULE_PM_RECEIVER,
fc7b92fc
B
443 remap,
444 rconfig_addr + REMAP_OFFSET);
b4ead61e
AK
445 if (err < 0) {
446 pr_err("TWL4030 failed to program remap\n");
447 return err;
448 }
449
ebf0bd36
AK
450 return 0;
451}
452
f791be49 453static int load_twl4030_script(struct twl4030_script *tscript,
ebf0bd36
AK
454 u8 address)
455{
456 int err;
75a74565 457 static int order;
ebf0bd36
AK
458
459 /* Make sure the script isn't going beyond last valid address (0x3f) */
460 if ((address + tscript->size) > END_OF_SCRIPT) {
461 pr_err("TWL4030 scripts too big error\n");
462 return -EINVAL;
463 }
464
465 err = twl4030_write_script(address, tscript->script, tscript->size);
466 if (err)
467 goto out;
468
469 if (tscript->flags & TWL4030_WRST_SCRIPT) {
470 err = twl4030_config_warmreset_sequence(address);
471 if (err)
472 goto out;
473 }
474 if (tscript->flags & TWL4030_WAKEUP12_SCRIPT) {
fc7d76e4
TL
475 /* Reset any existing sleep script to avoid hangs on reboot */
476 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, END_OF_SCRIPT,
477 R_SEQ_ADD_A2S);
478 if (err)
479 goto out;
480
ebf0bd36
AK
481 err = twl4030_config_wakeup12_sequence(address);
482 if (err)
483 goto out;
75a74565 484 order = 1;
ebf0bd36
AK
485 }
486 if (tscript->flags & TWL4030_WAKEUP3_SCRIPT) {
487 err = twl4030_config_wakeup3_sequence(address);
488 if (err)
489 goto out;
490 }
c62dd365 491 if (tscript->flags & TWL4030_SLEEP_SCRIPT) {
1f968ff6 492 if (!order)
75a74565
AK
493 pr_warning("TWL4030: Bad order of scripts (sleep "\
494 "script before wakeup) Leads to boot"\
495 "failure on some boards\n");
ebf0bd36 496 err = twl4030_config_sleep_sequence(address);
c62dd365 497 }
ebf0bd36
AK
498out:
499 return err;
500}
501
11a441ce
MT
502int twl4030_remove_script(u8 flags)
503{
504 int err = 0;
505
4850f124
PU
506 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, TWL4030_PM_MASTER_KEY_CFG1,
507 TWL4030_PM_MASTER_PROTECT_KEY);
11a441ce
MT
508 if (err) {
509 pr_err("twl4030: unable to unlock PROTECT_KEY\n");
510 return err;
511 }
512
4850f124
PU
513 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, TWL4030_PM_MASTER_KEY_CFG2,
514 TWL4030_PM_MASTER_PROTECT_KEY);
11a441ce
MT
515 if (err) {
516 pr_err("twl4030: unable to unlock PROTECT_KEY\n");
517 return err;
518 }
519
520 if (flags & TWL4030_WRST_SCRIPT) {
4850f124
PU
521 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, END_OF_SCRIPT,
522 R_SEQ_ADD_WARM);
11a441ce
MT
523 if (err)
524 return err;
525 }
526 if (flags & TWL4030_WAKEUP12_SCRIPT) {
4850f124
PU
527 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, END_OF_SCRIPT,
528 R_SEQ_ADD_S2A12);
eac78a21 529 if (err)
11a441ce
MT
530 return err;
531 }
532 if (flags & TWL4030_WAKEUP3_SCRIPT) {
4850f124
PU
533 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, END_OF_SCRIPT,
534 R_SEQ_ADD_S2A3);
11a441ce
MT
535 if (err)
536 return err;
537 }
538 if (flags & TWL4030_SLEEP_SCRIPT) {
4850f124
PU
539 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, END_OF_SCRIPT,
540 R_SEQ_ADD_A2S);
11a441ce
MT
541 if (err)
542 return err;
543 }
544
4850f124
PU
545 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, 0,
546 TWL4030_PM_MASTER_PROTECT_KEY);
11a441ce
MT
547 if (err)
548 pr_err("TWL4030 Unable to relock registers\n");
549
550 return err;
551}
552
e7cd1d1e
TL
553static int
554twl4030_power_configure_scripts(const struct twl4030_power_data *pdata)
f58cb407
FV
555{
556 int err;
557 int i;
558 u8 address = twl4030_start_script_address;
559
560 for (i = 0; i < pdata->num; i++) {
561 err = load_twl4030_script(pdata->scripts[i], address);
562 if (err)
563 return err;
564 address += pdata->scripts[i]->size;
565 }
566
567 return 0;
568}
569
e7cd1d1e
TL
570static int
571twl4030_power_configure_resources(const struct twl4030_power_data *pdata)
f58cb407
FV
572{
573 struct twl4030_resconfig *resconfig = pdata->resource_config;
574 int err;
575
576 if (resconfig) {
577 while (resconfig->resource) {
578 err = twl4030_configure_resource(resconfig);
579 if (err)
580 return err;
581 resconfig++;
582 }
583 }
584
585 return 0;
586}
587
26cc3ab9
IG
588/*
589 * In master mode, start the power off sequence.
590 * After a successful execution, TWL shuts down the power to the SoC
591 * and all peripherals connected to it.
592 */
593void twl4030_power_off(void)
594{
595 int err;
596
4850f124 597 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, PWR_DEVOFF,
26cc3ab9
IG
598 TWL4030_PM_MASTER_P1_SW_EVENTS);
599 if (err)
600 pr_err("TWL4030 Unable to power off\n");
601}
602
e7cd1d1e 603static bool twl4030_power_use_poweroff(const struct twl4030_power_data *pdata,
b0fc1da4
FV
604 struct device_node *node)
605{
606 if (pdata && pdata->use_poweroff)
607 return true;
608
609 if (of_property_read_bool(node, "ti,use_poweroff"))
610 return true;
611
612 return false;
613}
614
e7cd1d1e
TL
615#ifdef CONFIG_OF
616
617/* Generic warm reset configuration for omap3 */
618
619static struct twl4030_ins omap3_wrst_seq[] = {
620 TWL_RESOURCE_OFF(RES_NRES_PWRON),
621 TWL_RESOURCE_OFF(RES_RESET),
622 TWL_RESOURCE_RESET(RES_MAIN_REF),
623 TWL_RESOURCE_GROUP_RESET(RES_GRP_ALL, RES_TYPE_R0, RES_TYPE2_R2),
624 TWL_RESOURCE_RESET(RES_VUSB_3V1),
625 TWL_RESOURCE_GROUP_RESET(RES_GRP_ALL, RES_TYPE_R0, RES_TYPE2_R1),
626 TWL_RESOURCE_GROUP_RESET(RES_GRP_RC, RES_TYPE_ALL, RES_TYPE2_R0),
627 TWL_RESOURCE_ON(RES_RESET),
628 TWL_RESOURCE_ON(RES_NRES_PWRON),
629};
630
631static struct twl4030_script omap3_wrst_script = {
632 .script = omap3_wrst_seq,
633 .size = ARRAY_SIZE(omap3_wrst_seq),
634 .flags = TWL4030_WRST_SCRIPT,
635};
636
637static struct twl4030_script *omap3_reset_scripts[] = {
638 &omap3_wrst_script,
639};
640
641static struct twl4030_resconfig omap3_rconfig[] = {
642 TWL_REMAP_SLEEP(RES_HFCLKOUT, DEV_GRP_P3, -1, -1),
643 TWL_REMAP_SLEEP(RES_VDD1, DEV_GRP_P1, -1, -1),
644 TWL_REMAP_SLEEP(RES_VDD2, DEV_GRP_P1, -1, -1),
645 { 0, 0 },
646};
647
648static struct twl4030_power_data omap3_reset = {
649 .scripts = omap3_reset_scripts,
650 .num = ARRAY_SIZE(omap3_reset_scripts),
651 .resource_config = omap3_rconfig,
652};
653
76714d2c
TL
654/* Recommended generic default idle configuration for off-idle */
655
656/* Broadcast message to put res to sleep */
657static struct twl4030_ins omap3_idle_sleep_on_seq[] = {
658 TWL_RESOURCE_GROUP_SLEEP(RES_GRP_ALL, RES_TYPE_ALL, 0),
659};
660
661static struct twl4030_script omap3_idle_sleep_on_script = {
662 .script = omap3_idle_sleep_on_seq,
663 .size = ARRAY_SIZE(omap3_idle_sleep_on_seq),
664 .flags = TWL4030_SLEEP_SCRIPT,
665};
666
667/* Broadcast message to put res to active */
668static struct twl4030_ins omap3_idle_wakeup_p12_seq[] = {
669 TWL_RESOURCE_GROUP_ACTIVE(RES_GRP_ALL, RES_TYPE_ALL, 0),
670};
671
672static struct twl4030_script omap3_idle_wakeup_p12_script = {
673 .script = omap3_idle_wakeup_p12_seq,
674 .size = ARRAY_SIZE(omap3_idle_wakeup_p12_seq),
675 .flags = TWL4030_WAKEUP12_SCRIPT,
676};
677
678/* Broadcast message to put res to active */
679static struct twl4030_ins omap3_idle_wakeup_p3_seq[] = {
680 TWL_RESOURCE_SET_ACTIVE(RES_CLKEN, 0x37),
681 TWL_RESOURCE_GROUP_ACTIVE(RES_GRP_ALL, RES_TYPE_ALL, 0),
682};
683
684static struct twl4030_script omap3_idle_wakeup_p3_script = {
685 .script = omap3_idle_wakeup_p3_seq,
686 .size = ARRAY_SIZE(omap3_idle_wakeup_p3_seq),
687 .flags = TWL4030_WAKEUP3_SCRIPT,
688};
689
690static struct twl4030_script *omap3_idle_scripts[] = {
691 &omap3_idle_wakeup_p12_script,
692 &omap3_idle_wakeup_p3_script,
693 &omap3_wrst_script,
694 &omap3_idle_sleep_on_script,
695};
696
697/*
698 * Recommended configuration based on "Recommended Sleep
699 * Sequences for the Zoom Platform":
700 * http://omappedia.com/wiki/File:Recommended_Sleep_Sequences_Zoom.pdf
701 * Note that the type1 and type2 seem to be just the init order number
702 * for type1 and type2 groups as specified in the document mentioned
703 * above.
704 */
705static struct twl4030_resconfig omap3_idle_rconfig[] = {
706 TWL_REMAP_SLEEP(RES_VAUX1, DEV_GRP_NULL, 0, 0),
707 TWL_REMAP_SLEEP(RES_VAUX2, DEV_GRP_NULL, 0, 0),
708 TWL_REMAP_SLEEP(RES_VAUX3, DEV_GRP_NULL, 0, 0),
709 TWL_REMAP_SLEEP(RES_VAUX4, DEV_GRP_NULL, 0, 0),
710 TWL_REMAP_SLEEP(RES_VMMC1, DEV_GRP_NULL, 0, 0),
711 TWL_REMAP_SLEEP(RES_VMMC2, DEV_GRP_NULL, 0, 0),
712 TWL_REMAP_OFF(RES_VPLL1, DEV_GRP_P1, 3, 1),
713 TWL_REMAP_SLEEP(RES_VPLL2, DEV_GRP_P1, 0, 0),
714 TWL_REMAP_SLEEP(RES_VSIM, DEV_GRP_NULL, 0, 0),
715 TWL_REMAP_SLEEP(RES_VDAC, DEV_GRP_NULL, 0, 0),
716 TWL_REMAP_SLEEP(RES_VINTANA1, TWL_DEV_GRP_P123, 1, 2),
717 TWL_REMAP_SLEEP(RES_VINTANA2, TWL_DEV_GRP_P123, 0, 2),
718 TWL_REMAP_SLEEP(RES_VINTDIG, TWL_DEV_GRP_P123, 1, 2),
719 TWL_REMAP_SLEEP(RES_VIO, TWL_DEV_GRP_P123, 2, 2),
720 TWL_REMAP_OFF(RES_VDD1, DEV_GRP_P1, 4, 1),
721 TWL_REMAP_OFF(RES_VDD2, DEV_GRP_P1, 3, 1),
722 TWL_REMAP_SLEEP(RES_VUSB_1V5, DEV_GRP_NULL, 0, 0),
723 TWL_REMAP_SLEEP(RES_VUSB_1V8, DEV_GRP_NULL, 0, 0),
724 TWL_REMAP_SLEEP(RES_VUSB_3V1, TWL_DEV_GRP_P123, 0, 0),
725 /* Resource #20 USB charge pump skipped */
726 TWL_REMAP_SLEEP(RES_REGEN, TWL_DEV_GRP_P123, 2, 1),
727 TWL_REMAP_SLEEP(RES_NRES_PWRON, TWL_DEV_GRP_P123, 0, 1),
728 TWL_REMAP_SLEEP(RES_CLKEN, TWL_DEV_GRP_P123, 3, 2),
729 TWL_REMAP_SLEEP(RES_SYSEN, TWL_DEV_GRP_P123, 6, 1),
730 TWL_REMAP_SLEEP(RES_HFCLKOUT, DEV_GRP_P3, 0, 2),
731 TWL_REMAP_SLEEP(RES_32KCLKOUT, TWL_DEV_GRP_P123, 0, 0),
732 TWL_REMAP_SLEEP(RES_RESET, TWL_DEV_GRP_P123, 6, 0),
733 TWL_REMAP_SLEEP(RES_MAIN_REF, TWL_DEV_GRP_P123, 0, 0),
734 { /* Terminator */ },
735};
736
737static struct twl4030_power_data omap3_idle = {
738 .scripts = omap3_idle_scripts,
739 .num = ARRAY_SIZE(omap3_idle_scripts),
740 .resource_config = omap3_idle_rconfig,
741};
742
e7cd1d1e
TL
743static struct of_device_id twl4030_power_of_match[] = {
744 {
745 .compatible = "ti,twl4030-power-reset",
746 .data = &omap3_reset,
747 },
76714d2c
TL
748 {
749 .compatible = "ti,twl4030-power-idle",
750 .data = &omap3_idle,
751 },
e7cd1d1e
TL
752 { },
753};
754MODULE_DEVICE_TABLE(of, twl4030_power_of_match);
755#endif /* CONFIG_OF */
756
fae01582 757static int twl4030_power_probe(struct platform_device *pdev)
ebf0bd36 758{
e7cd1d1e 759 const struct twl4030_power_data *pdata = dev_get_platdata(&pdev->dev);
b0fc1da4 760 struct device_node *node = pdev->dev.of_node;
e7cd1d1e 761 const struct of_device_id *match;
ebf0bd36 762 int err = 0;
cb3cabd6 763 int err2 = 0;
f58cb407 764 u8 val;
ebf0bd36 765
b0fc1da4
FV
766 if (!pdata && !node) {
767 dev_err(&pdev->dev, "Platform data is missing\n");
768 return -EINVAL;
769 }
770
4850f124
PU
771 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, TWL4030_PM_MASTER_KEY_CFG1,
772 TWL4030_PM_MASTER_PROTECT_KEY);
e77a4c2f
FV
773 err |= twl_i2c_write_u8(TWL_MODULE_PM_MASTER,
774 TWL4030_PM_MASTER_KEY_CFG2,
4850f124 775 TWL4030_PM_MASTER_PROTECT_KEY);
e77a4c2f
FV
776
777 if (err) {
778 pr_err("TWL4030 Unable to unlock registers\n");
779 return err;
780 }
ebf0bd36 781
e7cd1d1e
TL
782 match = of_match_device(of_match_ptr(twl4030_power_of_match),
783 &pdev->dev);
784 if (match && match->data)
785 pdata = match->data;
786
b0fc1da4 787 if (pdata) {
b0fc1da4 788 err = twl4030_power_configure_scripts(pdata);
e77a4c2f
FV
789 if (err) {
790 pr_err("TWL4030 failed to load scripts\n");
cb3cabd6 791 goto relock;
e77a4c2f 792 }
b0fc1da4 793 err = twl4030_power_configure_resources(pdata);
e77a4c2f
FV
794 if (err) {
795 pr_err("TWL4030 failed to configure resource\n");
cb3cabd6 796 goto relock;
e77a4c2f 797 }
b0fc1da4 798 }
ebf0bd36 799
26cc3ab9 800 /* Board has to be wired properly to use this feature */
b0fc1da4 801 if (twl4030_power_use_poweroff(pdata, node) && !pm_power_off) {
26cc3ab9 802 /* Default for SEQ_OFFSYNC is set, lets ensure this */
4850f124 803 err = twl_i2c_read_u8(TWL_MODULE_PM_MASTER, &val,
26cc3ab9
IG
804 TWL4030_PM_MASTER_CFG_P123_TRANSITION);
805 if (err) {
806 pr_warning("TWL4030 Unable to read registers\n");
807
808 } else if (!(val & SEQ_OFFSYNC)) {
809 val |= SEQ_OFFSYNC;
4850f124 810 err = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, val,
26cc3ab9
IG
811 TWL4030_PM_MASTER_CFG_P123_TRANSITION);
812 if (err) {
813 pr_err("TWL4030 Unable to setup SEQ_OFFSYNC\n");
814 goto relock;
815 }
816 }
817
818 pm_power_off = twl4030_power_off;
819 }
820
821relock:
cb3cabd6 822 err2 = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, 0,
4850f124 823 TWL4030_PM_MASTER_PROTECT_KEY);
cb3cabd6 824 if (err2) {
ebf0bd36 825 pr_err("TWL4030 Unable to relock registers\n");
cb3cabd6
FV
826 return err2;
827 }
828
637d6895 829 return err;
637d6895
FV
830}
831
832static int twl4030_power_remove(struct platform_device *pdev)
833{
834 return 0;
ebf0bd36 835}
637d6895
FV
836
837static struct platform_driver twl4030_power_driver = {
838 .driver = {
839 .name = "twl4030_power",
840 .owner = THIS_MODULE,
b0fc1da4 841 .of_match_table = of_match_ptr(twl4030_power_of_match),
637d6895
FV
842 },
843 .probe = twl4030_power_probe,
844 .remove = twl4030_power_remove,
845};
846
847module_platform_driver(twl4030_power_driver);
848
849MODULE_AUTHOR("Nokia Corporation");
850MODULE_AUTHOR("Texas Instruments, Inc.");
851MODULE_DESCRIPTION("Power management for TWL4030");
852MODULE_LICENSE("GPL");
853MODULE_ALIAS("platform:twl4030_power");