Linux 2.6.34-rc3
[pohmelfs.git] / drivers / mfd / pcf50633-core.c
blob03dcc92007070605b2ec0e7f7a8164eeca00183a
1 /* NXP PCF50633 Power Management Unit (PMU) driver
3 * (C) 2006-2008 by Openmoko, Inc.
4 * Author: Harald Welte <laforge@openmoko.org>
5 * Balaji Rao <balajirrao@openmoko.org>
6 * All rights reserved.
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
15 #include <linux/kernel.h>
16 #include <linux/device.h>
17 #include <linux/sysfs.h>
18 #include <linux/module.h>
19 #include <linux/types.h>
20 #include <linux/interrupt.h>
21 #include <linux/workqueue.h>
22 #include <linux/platform_device.h>
23 #include <linux/i2c.h>
24 #include <linux/irq.h>
26 #include <linux/mfd/pcf50633/core.h>
28 /* Two MBCS registers used during cold start */
29 #define PCF50633_REG_MBCS1 0x4b
30 #define PCF50633_REG_MBCS2 0x4c
31 #define PCF50633_MBCS1_USBPRES 0x01
32 #define PCF50633_MBCS1_ADAPTPRES 0x01
34 static int __pcf50633_read(struct pcf50633 *pcf, u8 reg, int num, u8 *data)
36 int ret;
38 ret = i2c_smbus_read_i2c_block_data(pcf->i2c_client, reg,
39 num, data);
40 if (ret < 0)
41 dev_err(pcf->dev, "Error reading %d regs at %d\n", num, reg);
43 return ret;
46 static int __pcf50633_write(struct pcf50633 *pcf, u8 reg, int num, u8 *data)
48 int ret;
50 ret = i2c_smbus_write_i2c_block_data(pcf->i2c_client, reg,
51 num, data);
52 if (ret < 0)
53 dev_err(pcf->dev, "Error writing %d regs at %d\n", num, reg);
55 return ret;
59 /* Read a block of upto 32 regs */
60 int pcf50633_read_block(struct pcf50633 *pcf, u8 reg,
61 int nr_regs, u8 *data)
63 int ret;
65 mutex_lock(&pcf->lock);
66 ret = __pcf50633_read(pcf, reg, nr_regs, data);
67 mutex_unlock(&pcf->lock);
69 return ret;
71 EXPORT_SYMBOL_GPL(pcf50633_read_block);
73 /* Write a block of upto 32 regs */
74 int pcf50633_write_block(struct pcf50633 *pcf , u8 reg,
75 int nr_regs, u8 *data)
77 int ret;
79 mutex_lock(&pcf->lock);
80 ret = __pcf50633_write(pcf, reg, nr_regs, data);
81 mutex_unlock(&pcf->lock);
83 return ret;
85 EXPORT_SYMBOL_GPL(pcf50633_write_block);
87 u8 pcf50633_reg_read(struct pcf50633 *pcf, u8 reg)
89 u8 val;
91 mutex_lock(&pcf->lock);
92 __pcf50633_read(pcf, reg, 1, &val);
93 mutex_unlock(&pcf->lock);
95 return val;
97 EXPORT_SYMBOL_GPL(pcf50633_reg_read);
99 int pcf50633_reg_write(struct pcf50633 *pcf, u8 reg, u8 val)
101 int ret;
103 mutex_lock(&pcf->lock);
104 ret = __pcf50633_write(pcf, reg, 1, &val);
105 mutex_unlock(&pcf->lock);
107 return ret;
109 EXPORT_SYMBOL_GPL(pcf50633_reg_write);
111 int pcf50633_reg_set_bit_mask(struct pcf50633 *pcf, u8 reg, u8 mask, u8 val)
113 int ret;
114 u8 tmp;
116 val &= mask;
118 mutex_lock(&pcf->lock);
119 ret = __pcf50633_read(pcf, reg, 1, &tmp);
120 if (ret < 0)
121 goto out;
123 tmp &= ~mask;
124 tmp |= val;
125 ret = __pcf50633_write(pcf, reg, 1, &tmp);
127 out:
128 mutex_unlock(&pcf->lock);
130 return ret;
132 EXPORT_SYMBOL_GPL(pcf50633_reg_set_bit_mask);
134 int pcf50633_reg_clear_bits(struct pcf50633 *pcf, u8 reg, u8 val)
136 int ret;
137 u8 tmp;
139 mutex_lock(&pcf->lock);
140 ret = __pcf50633_read(pcf, reg, 1, &tmp);
141 if (ret < 0)
142 goto out;
144 tmp &= ~val;
145 ret = __pcf50633_write(pcf, reg, 1, &tmp);
147 out:
148 mutex_unlock(&pcf->lock);
150 return ret;
152 EXPORT_SYMBOL_GPL(pcf50633_reg_clear_bits);
154 /* sysfs attributes */
155 static ssize_t show_dump_regs(struct device *dev, struct device_attribute *attr,
156 char *buf)
158 struct pcf50633 *pcf = dev_get_drvdata(dev);
159 u8 dump[16];
160 int n, n1, idx = 0;
161 char *buf1 = buf;
162 static u8 address_no_read[] = { /* must be ascending */
163 PCF50633_REG_INT1,
164 PCF50633_REG_INT2,
165 PCF50633_REG_INT3,
166 PCF50633_REG_INT4,
167 PCF50633_REG_INT5,
168 0 /* terminator */
171 for (n = 0; n < 256; n += sizeof(dump)) {
172 for (n1 = 0; n1 < sizeof(dump); n1++)
173 if (n == address_no_read[idx]) {
174 idx++;
175 dump[n1] = 0x00;
176 } else
177 dump[n1] = pcf50633_reg_read(pcf, n + n1);
179 hex_dump_to_buffer(dump, sizeof(dump), 16, 1, buf1, 128, 0);
180 buf1 += strlen(buf1);
181 *buf1++ = '\n';
182 *buf1 = '\0';
185 return buf1 - buf;
187 static DEVICE_ATTR(dump_regs, 0400, show_dump_regs, NULL);
189 static ssize_t show_resume_reason(struct device *dev,
190 struct device_attribute *attr, char *buf)
192 struct pcf50633 *pcf = dev_get_drvdata(dev);
193 int n;
195 n = sprintf(buf, "%02x%02x%02x%02x%02x\n",
196 pcf->resume_reason[0],
197 pcf->resume_reason[1],
198 pcf->resume_reason[2],
199 pcf->resume_reason[3],
200 pcf->resume_reason[4]);
202 return n;
204 static DEVICE_ATTR(resume_reason, 0400, show_resume_reason, NULL);
206 static struct attribute *pcf_sysfs_entries[] = {
207 &dev_attr_dump_regs.attr,
208 &dev_attr_resume_reason.attr,
209 NULL,
212 static struct attribute_group pcf_attr_group = {
213 .name = NULL, /* put in device directory */
214 .attrs = pcf_sysfs_entries,
217 int pcf50633_register_irq(struct pcf50633 *pcf, int irq,
218 void (*handler) (int, void *), void *data)
220 if (irq < 0 || irq > PCF50633_NUM_IRQ || !handler)
221 return -EINVAL;
223 if (WARN_ON(pcf->irq_handler[irq].handler))
224 return -EBUSY;
226 mutex_lock(&pcf->lock);
227 pcf->irq_handler[irq].handler = handler;
228 pcf->irq_handler[irq].data = data;
229 mutex_unlock(&pcf->lock);
231 return 0;
233 EXPORT_SYMBOL_GPL(pcf50633_register_irq);
235 int pcf50633_free_irq(struct pcf50633 *pcf, int irq)
237 if (irq < 0 || irq > PCF50633_NUM_IRQ)
238 return -EINVAL;
240 mutex_lock(&pcf->lock);
241 pcf->irq_handler[irq].handler = NULL;
242 mutex_unlock(&pcf->lock);
244 return 0;
246 EXPORT_SYMBOL_GPL(pcf50633_free_irq);
248 static int __pcf50633_irq_mask_set(struct pcf50633 *pcf, int irq, u8 mask)
250 u8 reg, bits, tmp;
251 int ret = 0, idx;
253 idx = irq >> 3;
254 reg = PCF50633_REG_INT1M + idx;
255 bits = 1 << (irq & 0x07);
257 mutex_lock(&pcf->lock);
259 if (mask) {
260 ret = __pcf50633_read(pcf, reg, 1, &tmp);
261 if (ret < 0)
262 goto out;
264 tmp |= bits;
266 ret = __pcf50633_write(pcf, reg, 1, &tmp);
267 if (ret < 0)
268 goto out;
270 pcf->mask_regs[idx] &= ~bits;
271 pcf->mask_regs[idx] |= bits;
272 } else {
273 ret = __pcf50633_read(pcf, reg, 1, &tmp);
274 if (ret < 0)
275 goto out;
277 tmp &= ~bits;
279 ret = __pcf50633_write(pcf, reg, 1, &tmp);
280 if (ret < 0)
281 goto out;
283 pcf->mask_regs[idx] &= ~bits;
285 out:
286 mutex_unlock(&pcf->lock);
288 return ret;
291 int pcf50633_irq_mask(struct pcf50633 *pcf, int irq)
293 dev_dbg(pcf->dev, "Masking IRQ %d\n", irq);
295 return __pcf50633_irq_mask_set(pcf, irq, 1);
297 EXPORT_SYMBOL_GPL(pcf50633_irq_mask);
299 int pcf50633_irq_unmask(struct pcf50633 *pcf, int irq)
301 dev_dbg(pcf->dev, "Unmasking IRQ %d\n", irq);
303 return __pcf50633_irq_mask_set(pcf, irq, 0);
305 EXPORT_SYMBOL_GPL(pcf50633_irq_unmask);
307 int pcf50633_irq_mask_get(struct pcf50633 *pcf, int irq)
309 u8 reg, bits;
311 reg = irq >> 3;
312 bits = 1 << (irq & 0x07);
314 return pcf->mask_regs[reg] & bits;
316 EXPORT_SYMBOL_GPL(pcf50633_irq_mask_get);
318 static void pcf50633_irq_call_handler(struct pcf50633 *pcf, int irq)
320 if (pcf->irq_handler[irq].handler)
321 pcf->irq_handler[irq].handler(irq, pcf->irq_handler[irq].data);
324 /* Maximum amount of time ONKEY is held before emergency action is taken */
325 #define PCF50633_ONKEY1S_TIMEOUT 8
327 static void pcf50633_irq_worker(struct work_struct *work)
329 struct pcf50633 *pcf;
330 int ret, i, j;
331 u8 pcf_int[5], chgstat;
333 pcf = container_of(work, struct pcf50633, irq_work);
335 /* Read the 5 INT regs in one transaction */
336 ret = pcf50633_read_block(pcf, PCF50633_REG_INT1,
337 ARRAY_SIZE(pcf_int), pcf_int);
338 if (ret != ARRAY_SIZE(pcf_int)) {
339 dev_err(pcf->dev, "Error reading INT registers\n");
342 * If this doesn't ACK the interrupt to the chip, we'll be
343 * called once again as we're level triggered.
345 goto out;
348 /* defeat 8s death from lowsys on A5 */
349 pcf50633_reg_write(pcf, PCF50633_REG_OOCSHDWN, 0x04);
351 /* We immediately read the usb and adapter status. We thus make sure
352 * only of USBINS/USBREM IRQ handlers are called */
353 if (pcf_int[0] & (PCF50633_INT1_USBINS | PCF50633_INT1_USBREM)) {
354 chgstat = pcf50633_reg_read(pcf, PCF50633_REG_MBCS2);
355 if (chgstat & (0x3 << 4))
356 pcf_int[0] &= ~(1 << PCF50633_INT1_USBREM);
357 else
358 pcf_int[0] &= ~(1 << PCF50633_INT1_USBINS);
361 /* Make sure only one of ADPINS or ADPREM is set */
362 if (pcf_int[0] & (PCF50633_INT1_ADPINS | PCF50633_INT1_ADPREM)) {
363 chgstat = pcf50633_reg_read(pcf, PCF50633_REG_MBCS2);
364 if (chgstat & (0x3 << 4))
365 pcf_int[0] &= ~(1 << PCF50633_INT1_ADPREM);
366 else
367 pcf_int[0] &= ~(1 << PCF50633_INT1_ADPINS);
370 dev_dbg(pcf->dev, "INT1=0x%02x INT2=0x%02x INT3=0x%02x "
371 "INT4=0x%02x INT5=0x%02x\n", pcf_int[0],
372 pcf_int[1], pcf_int[2], pcf_int[3], pcf_int[4]);
374 /* Some revisions of the chip don't have a 8s standby mode on
375 * ONKEY1S press. We try to manually do it in such cases. */
376 if ((pcf_int[0] & PCF50633_INT1_SECOND) && pcf->onkey1s_held) {
377 dev_info(pcf->dev, "ONKEY1S held for %d secs\n",
378 pcf->onkey1s_held);
379 if (pcf->onkey1s_held++ == PCF50633_ONKEY1S_TIMEOUT)
380 if (pcf->pdata->force_shutdown)
381 pcf->pdata->force_shutdown(pcf);
384 if (pcf_int[2] & PCF50633_INT3_ONKEY1S) {
385 dev_info(pcf->dev, "ONKEY1S held\n");
386 pcf->onkey1s_held = 1 ;
388 /* Unmask IRQ_SECOND */
389 pcf50633_reg_clear_bits(pcf, PCF50633_REG_INT1M,
390 PCF50633_INT1_SECOND);
392 /* Unmask IRQ_ONKEYR */
393 pcf50633_reg_clear_bits(pcf, PCF50633_REG_INT2M,
394 PCF50633_INT2_ONKEYR);
397 if ((pcf_int[1] & PCF50633_INT2_ONKEYR) && pcf->onkey1s_held) {
398 pcf->onkey1s_held = 0;
400 /* Mask SECOND and ONKEYR interrupts */
401 if (pcf->mask_regs[0] & PCF50633_INT1_SECOND)
402 pcf50633_reg_set_bit_mask(pcf,
403 PCF50633_REG_INT1M,
404 PCF50633_INT1_SECOND,
405 PCF50633_INT1_SECOND);
407 if (pcf->mask_regs[1] & PCF50633_INT2_ONKEYR)
408 pcf50633_reg_set_bit_mask(pcf,
409 PCF50633_REG_INT2M,
410 PCF50633_INT2_ONKEYR,
411 PCF50633_INT2_ONKEYR);
414 /* Have we just resumed ? */
415 if (pcf->is_suspended) {
416 pcf->is_suspended = 0;
418 /* Set the resume reason filtering out non resumers */
419 for (i = 0; i < ARRAY_SIZE(pcf_int); i++)
420 pcf->resume_reason[i] = pcf_int[i] &
421 pcf->pdata->resumers[i];
423 /* Make sure we don't pass on any ONKEY events to
424 * userspace now */
425 pcf_int[1] &= ~(PCF50633_INT2_ONKEYR | PCF50633_INT2_ONKEYF);
428 for (i = 0; i < ARRAY_SIZE(pcf_int); i++) {
429 /* Unset masked interrupts */
430 pcf_int[i] &= ~pcf->mask_regs[i];
432 for (j = 0; j < 8 ; j++)
433 if (pcf_int[i] & (1 << j))
434 pcf50633_irq_call_handler(pcf, (i * 8) + j);
437 out:
438 put_device(pcf->dev);
439 enable_irq(pcf->irq);
442 static irqreturn_t pcf50633_irq(int irq, void *data)
444 struct pcf50633 *pcf = data;
446 dev_dbg(pcf->dev, "pcf50633_irq\n");
448 get_device(pcf->dev);
449 disable_irq_nosync(pcf->irq);
450 queue_work(pcf->work_queue, &pcf->irq_work);
452 return IRQ_HANDLED;
455 static void
456 pcf50633_client_dev_register(struct pcf50633 *pcf, const char *name,
457 struct platform_device **pdev)
459 int ret;
461 *pdev = platform_device_alloc(name, -1);
462 if (!*pdev) {
463 dev_err(pcf->dev, "Falied to allocate %s\n", name);
464 return;
467 (*pdev)->dev.parent = pcf->dev;
469 ret = platform_device_add(*pdev);
470 if (ret) {
471 dev_err(pcf->dev, "Failed to register %s: %d\n", name, ret);
472 platform_device_put(*pdev);
473 *pdev = NULL;
477 #ifdef CONFIG_PM
478 static int pcf50633_suspend(struct i2c_client *client, pm_message_t state)
480 struct pcf50633 *pcf;
481 int ret = 0, i;
482 u8 res[5];
484 pcf = i2c_get_clientdata(client);
486 /* Make sure our interrupt handlers are not called
487 * henceforth */
488 disable_irq(pcf->irq);
490 /* Make sure that any running IRQ worker has quit */
491 cancel_work_sync(&pcf->irq_work);
493 /* Save the masks */
494 ret = pcf50633_read_block(pcf, PCF50633_REG_INT1M,
495 ARRAY_SIZE(pcf->suspend_irq_masks),
496 pcf->suspend_irq_masks);
497 if (ret < 0) {
498 dev_err(pcf->dev, "error saving irq masks\n");
499 goto out;
502 /* Write wakeup irq masks */
503 for (i = 0; i < ARRAY_SIZE(res); i++)
504 res[i] = ~pcf->pdata->resumers[i];
506 ret = pcf50633_write_block(pcf, PCF50633_REG_INT1M,
507 ARRAY_SIZE(res), &res[0]);
508 if (ret < 0) {
509 dev_err(pcf->dev, "error writing wakeup irq masks\n");
510 goto out;
513 pcf->is_suspended = 1;
515 out:
516 return ret;
519 static int pcf50633_resume(struct i2c_client *client)
521 struct pcf50633 *pcf;
522 int ret;
524 pcf = i2c_get_clientdata(client);
526 /* Write the saved mask registers */
527 ret = pcf50633_write_block(pcf, PCF50633_REG_INT1M,
528 ARRAY_SIZE(pcf->suspend_irq_masks),
529 pcf->suspend_irq_masks);
530 if (ret < 0)
531 dev_err(pcf->dev, "Error restoring saved suspend masks\n");
533 /* Restore regulators' state */
536 get_device(pcf->dev);
539 * Clear any pending interrupts and set resume reason if any.
540 * This will leave with enable_irq()
542 pcf50633_irq_worker(&pcf->irq_work);
544 return 0;
546 #else
547 #define pcf50633_suspend NULL
548 #define pcf50633_resume NULL
549 #endif
551 static int __devinit pcf50633_probe(struct i2c_client *client,
552 const struct i2c_device_id *ids)
554 struct pcf50633 *pcf;
555 struct pcf50633_platform_data *pdata = client->dev.platform_data;
556 int i, ret;
557 int version, variant;
559 if (!client->irq) {
560 dev_err(&client->dev, "Missing IRQ\n");
561 return -ENOENT;
564 pcf = kzalloc(sizeof(*pcf), GFP_KERNEL);
565 if (!pcf)
566 return -ENOMEM;
568 pcf->pdata = pdata;
570 mutex_init(&pcf->lock);
572 i2c_set_clientdata(client, pcf);
573 pcf->dev = &client->dev;
574 pcf->i2c_client = client;
575 pcf->irq = client->irq;
576 pcf->work_queue = create_singlethread_workqueue("pcf50633");
578 if (!pcf->work_queue) {
579 dev_err(&client->dev, "Failed to alloc workqueue\n");
580 ret = -ENOMEM;
581 goto err_free;
584 INIT_WORK(&pcf->irq_work, pcf50633_irq_worker);
586 version = pcf50633_reg_read(pcf, 0);
587 variant = pcf50633_reg_read(pcf, 1);
588 if (version < 0 || variant < 0) {
589 dev_err(pcf->dev, "Unable to probe pcf50633\n");
590 ret = -ENODEV;
591 goto err_destroy_workqueue;
594 dev_info(pcf->dev, "Probed device version %d variant %d\n",
595 version, variant);
597 /* Enable all interrupts except RTC SECOND */
598 pcf->mask_regs[0] = 0x80;
599 pcf50633_reg_write(pcf, PCF50633_REG_INT1M, pcf->mask_regs[0]);
600 pcf50633_reg_write(pcf, PCF50633_REG_INT2M, 0x00);
601 pcf50633_reg_write(pcf, PCF50633_REG_INT3M, 0x00);
602 pcf50633_reg_write(pcf, PCF50633_REG_INT4M, 0x00);
603 pcf50633_reg_write(pcf, PCF50633_REG_INT5M, 0x00);
605 ret = request_irq(client->irq, pcf50633_irq,
606 IRQF_TRIGGER_LOW, "pcf50633", pcf);
608 if (ret) {
609 dev_err(pcf->dev, "Failed to request IRQ %d\n", ret);
610 goto err_destroy_workqueue;
613 /* Create sub devices */
614 pcf50633_client_dev_register(pcf, "pcf50633-input",
615 &pcf->input_pdev);
616 pcf50633_client_dev_register(pcf, "pcf50633-rtc",
617 &pcf->rtc_pdev);
618 pcf50633_client_dev_register(pcf, "pcf50633-mbc",
619 &pcf->mbc_pdev);
620 pcf50633_client_dev_register(pcf, "pcf50633-adc",
621 &pcf->adc_pdev);
623 for (i = 0; i < PCF50633_NUM_REGULATORS; i++) {
624 struct platform_device *pdev;
626 pdev = platform_device_alloc("pcf50633-regltr", i);
627 if (!pdev) {
628 dev_err(pcf->dev, "Cannot create regulator %d\n", i);
629 continue;
632 pdev->dev.parent = pcf->dev;
633 platform_device_add_data(pdev, &pdata->reg_init_data[i],
634 sizeof(pdata->reg_init_data[i]));
635 pcf->regulator_pdev[i] = pdev;
637 platform_device_add(pdev);
640 if (enable_irq_wake(client->irq) < 0)
641 dev_err(pcf->dev, "IRQ %u cannot be enabled as wake-up source"
642 "in this hardware revision", client->irq);
644 ret = sysfs_create_group(&client->dev.kobj, &pcf_attr_group);
645 if (ret)
646 dev_err(pcf->dev, "error creating sysfs entries\n");
648 if (pdata->probe_done)
649 pdata->probe_done(pcf);
651 return 0;
653 err_destroy_workqueue:
654 destroy_workqueue(pcf->work_queue);
655 err_free:
656 i2c_set_clientdata(client, NULL);
657 kfree(pcf);
659 return ret;
662 static int __devexit pcf50633_remove(struct i2c_client *client)
664 struct pcf50633 *pcf = i2c_get_clientdata(client);
665 int i;
667 free_irq(pcf->irq, pcf);
668 destroy_workqueue(pcf->work_queue);
670 platform_device_unregister(pcf->input_pdev);
671 platform_device_unregister(pcf->rtc_pdev);
672 platform_device_unregister(pcf->mbc_pdev);
673 platform_device_unregister(pcf->adc_pdev);
675 for (i = 0; i < PCF50633_NUM_REGULATORS; i++)
676 platform_device_unregister(pcf->regulator_pdev[i]);
678 kfree(pcf);
680 return 0;
683 static struct i2c_device_id pcf50633_id_table[] = {
684 {"pcf50633", 0x73},
685 {/* end of list */}
688 static struct i2c_driver pcf50633_driver = {
689 .driver = {
690 .name = "pcf50633",
692 .id_table = pcf50633_id_table,
693 .probe = pcf50633_probe,
694 .remove = __devexit_p(pcf50633_remove),
695 .suspend = pcf50633_suspend,
696 .resume = pcf50633_resume,
699 static int __init pcf50633_init(void)
701 return i2c_add_driver(&pcf50633_driver);
704 static void __exit pcf50633_exit(void)
706 i2c_del_driver(&pcf50633_driver);
709 MODULE_DESCRIPTION("I2C chip driver for NXP PCF50633 PMU");
710 MODULE_AUTHOR("Harald Welte <laforge@openmoko.org>");
711 MODULE_LICENSE("GPL");
713 subsys_initcall(pcf50633_init);
714 module_exit(pcf50633_exit);