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>
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/device.h>
19 #include <linux/module.h>
20 #include <linux/types.h>
21 #include <linux/interrupt.h>
22 #include <linux/workqueue.h>
23 #include <linux/platform_device.h>
24 #include <linux/i2c.h>
25 #include <linux/irq.h>
27 #include <linux/mfd/pcf50633/core.h>
29 /* Two MBCS registers used during cold start */
30 #define PCF50633_REG_MBCS1 0x4b
31 #define PCF50633_REG_MBCS2 0x4c
32 #define PCF50633_MBCS1_USBPRES 0x01
33 #define PCF50633_MBCS1_ADAPTPRES 0x01
35 static int __pcf50633_read(struct pcf50633
*pcf
, u8 reg
, int num
, u8
*data
)
39 ret
= i2c_smbus_read_i2c_block_data(pcf
->i2c_client
, reg
,
42 dev_err(pcf
->dev
, "Error reading %d regs at %d\n", num
, reg
);
47 static int __pcf50633_write(struct pcf50633
*pcf
, u8 reg
, int num
, u8
*data
)
51 ret
= i2c_smbus_write_i2c_block_data(pcf
->i2c_client
, reg
,
54 dev_err(pcf
->dev
, "Error writing %d regs at %d\n", num
, reg
);
60 /* Read a block of upto 32 regs */
61 int pcf50633_read_block(struct pcf50633
*pcf
, u8 reg
,
62 int nr_regs
, u8
*data
)
66 mutex_lock(&pcf
->lock
);
67 ret
= __pcf50633_read(pcf
, reg
, nr_regs
, data
);
68 mutex_unlock(&pcf
->lock
);
72 EXPORT_SYMBOL_GPL(pcf50633_read_block
);
74 /* Write a block of upto 32 regs */
75 int pcf50633_write_block(struct pcf50633
*pcf
, u8 reg
,
76 int nr_regs
, u8
*data
)
80 mutex_lock(&pcf
->lock
);
81 ret
= __pcf50633_write(pcf
, reg
, nr_regs
, data
);
82 mutex_unlock(&pcf
->lock
);
86 EXPORT_SYMBOL_GPL(pcf50633_write_block
);
88 u8
pcf50633_reg_read(struct pcf50633
*pcf
, u8 reg
)
92 mutex_lock(&pcf
->lock
);
93 __pcf50633_read(pcf
, reg
, 1, &val
);
94 mutex_unlock(&pcf
->lock
);
98 EXPORT_SYMBOL_GPL(pcf50633_reg_read
);
100 int pcf50633_reg_write(struct pcf50633
*pcf
, u8 reg
, u8 val
)
104 mutex_lock(&pcf
->lock
);
105 ret
= __pcf50633_write(pcf
, reg
, 1, &val
);
106 mutex_unlock(&pcf
->lock
);
110 EXPORT_SYMBOL_GPL(pcf50633_reg_write
);
112 int pcf50633_reg_set_bit_mask(struct pcf50633
*pcf
, u8 reg
, u8 mask
, u8 val
)
119 mutex_lock(&pcf
->lock
);
120 ret
= __pcf50633_read(pcf
, reg
, 1, &tmp
);
126 ret
= __pcf50633_write(pcf
, reg
, 1, &tmp
);
129 mutex_unlock(&pcf
->lock
);
133 EXPORT_SYMBOL_GPL(pcf50633_reg_set_bit_mask
);
135 int pcf50633_reg_clear_bits(struct pcf50633
*pcf
, u8 reg
, u8 val
)
140 mutex_lock(&pcf
->lock
);
141 ret
= __pcf50633_read(pcf
, reg
, 1, &tmp
);
146 ret
= __pcf50633_write(pcf
, reg
, 1, &tmp
);
149 mutex_unlock(&pcf
->lock
);
153 EXPORT_SYMBOL_GPL(pcf50633_reg_clear_bits
);
155 /* sysfs attributes */
156 static ssize_t
show_dump_regs(struct device
*dev
, struct device_attribute
*attr
,
159 struct pcf50633
*pcf
= dev_get_drvdata(dev
);
163 static u8 address_no_read
[] = { /* must be ascending */
172 for (n
= 0; n
< 256; n
+= sizeof(dump
)) {
173 for (n1
= 0; n1
< sizeof(dump
); n1
++)
174 if (n
== address_no_read
[idx
]) {
178 dump
[n1
] = pcf50633_reg_read(pcf
, n
+ n1
);
180 hex_dump_to_buffer(dump
, sizeof(dump
), 16, 1, buf1
, 128, 0);
181 buf1
+= strlen(buf1
);
188 static DEVICE_ATTR(dump_regs
, 0400, show_dump_regs
, NULL
);
190 static ssize_t
show_resume_reason(struct device
*dev
,
191 struct device_attribute
*attr
, char *buf
)
193 struct pcf50633
*pcf
= dev_get_drvdata(dev
);
196 n
= sprintf(buf
, "%02x%02x%02x%02x%02x\n",
197 pcf
->resume_reason
[0],
198 pcf
->resume_reason
[1],
199 pcf
->resume_reason
[2],
200 pcf
->resume_reason
[3],
201 pcf
->resume_reason
[4]);
205 static DEVICE_ATTR(resume_reason
, 0400, show_resume_reason
, NULL
);
207 static struct attribute
*pcf_sysfs_entries
[] = {
208 &dev_attr_dump_regs
.attr
,
209 &dev_attr_resume_reason
.attr
,
213 static struct attribute_group pcf_attr_group
= {
214 .name
= NULL
, /* put in device directory */
215 .attrs
= pcf_sysfs_entries
,
218 int pcf50633_register_irq(struct pcf50633
*pcf
, int irq
,
219 void (*handler
) (int, void *), void *data
)
221 if (irq
< 0 || irq
> PCF50633_NUM_IRQ
|| !handler
)
224 if (WARN_ON(pcf
->irq_handler
[irq
].handler
))
227 mutex_lock(&pcf
->lock
);
228 pcf
->irq_handler
[irq
].handler
= handler
;
229 pcf
->irq_handler
[irq
].data
= data
;
230 mutex_unlock(&pcf
->lock
);
234 EXPORT_SYMBOL_GPL(pcf50633_register_irq
);
236 int pcf50633_free_irq(struct pcf50633
*pcf
, int irq
)
238 if (irq
< 0 || irq
> PCF50633_NUM_IRQ
)
241 mutex_lock(&pcf
->lock
);
242 pcf
->irq_handler
[irq
].handler
= NULL
;
243 mutex_unlock(&pcf
->lock
);
247 EXPORT_SYMBOL_GPL(pcf50633_free_irq
);
249 static int __pcf50633_irq_mask_set(struct pcf50633
*pcf
, int irq
, u8 mask
)
255 reg
= PCF50633_REG_INT1M
+ idx
;
256 bits
= 1 << (irq
& 0x07);
258 mutex_lock(&pcf
->lock
);
261 ret
= __pcf50633_read(pcf
, reg
, 1, &tmp
);
267 ret
= __pcf50633_write(pcf
, reg
, 1, &tmp
);
271 pcf
->mask_regs
[idx
] &= ~bits
;
272 pcf
->mask_regs
[idx
] |= bits
;
274 ret
= __pcf50633_read(pcf
, reg
, 1, &tmp
);
280 ret
= __pcf50633_write(pcf
, reg
, 1, &tmp
);
284 pcf
->mask_regs
[idx
] &= ~bits
;
287 mutex_unlock(&pcf
->lock
);
292 int pcf50633_irq_mask(struct pcf50633
*pcf
, int irq
)
294 dev_info(pcf
->dev
, "Masking IRQ %d\n", irq
);
296 return __pcf50633_irq_mask_set(pcf
, irq
, 1);
298 EXPORT_SYMBOL_GPL(pcf50633_irq_mask
);
300 int pcf50633_irq_unmask(struct pcf50633
*pcf
, int irq
)
302 dev_info(pcf
->dev
, "Unmasking IRQ %d\n", irq
);
304 return __pcf50633_irq_mask_set(pcf
, irq
, 0);
306 EXPORT_SYMBOL_GPL(pcf50633_irq_unmask
);
308 int pcf50633_irq_mask_get(struct pcf50633
*pcf
, int irq
)
313 bits
= 1 << (irq
& 0x07);
315 return pcf
->mask_regs
[reg
] & bits
;
317 EXPORT_SYMBOL_GPL(pcf50633_irq_mask_get
);
319 static void pcf50633_irq_call_handler(struct pcf50633
*pcf
, int irq
)
321 if (pcf
->irq_handler
[irq
].handler
)
322 pcf
->irq_handler
[irq
].handler(irq
, pcf
->irq_handler
[irq
].data
);
325 /* Maximum amount of time ONKEY is held before emergency action is taken */
326 #define PCF50633_ONKEY1S_TIMEOUT 8
328 static void pcf50633_irq_worker(struct work_struct
*work
)
330 struct pcf50633
*pcf
;
332 u8 pcf_int
[5], chgstat
;
334 pcf
= container_of(work
, struct pcf50633
, irq_work
);
336 /* Read the 5 INT regs in one transaction */
337 ret
= pcf50633_read_block(pcf
, PCF50633_REG_INT1
,
338 ARRAY_SIZE(pcf_int
), pcf_int
);
339 if (ret
!= ARRAY_SIZE(pcf_int
)) {
340 dev_err(pcf
->dev
, "Error reading INT registers\n");
343 * If this doesn't ACK the interrupt to the chip, we'll be
344 * called once again as we're level triggered.
349 /* We immediately read the usb and adapter status. We thus make sure
350 * only of USBINS/USBREM IRQ handlers are called */
351 if (pcf_int
[0] & (PCF50633_INT1_USBINS
| PCF50633_INT1_USBREM
)) {
352 chgstat
= pcf50633_reg_read(pcf
, PCF50633_REG_MBCS2
);
353 if (chgstat
& (0x3 << 4))
354 pcf_int
[0] &= ~(1 << PCF50633_INT1_USBREM
);
356 pcf_int
[0] &= ~(1 << PCF50633_INT1_USBINS
);
359 /* Make sure only one of ADPINS or ADPREM is set */
360 if (pcf_int
[0] & (PCF50633_INT1_ADPINS
| PCF50633_INT1_ADPREM
)) {
361 chgstat
= pcf50633_reg_read(pcf
, PCF50633_REG_MBCS2
);
362 if (chgstat
& (0x3 << 4))
363 pcf_int
[0] &= ~(1 << PCF50633_INT1_ADPREM
);
365 pcf_int
[0] &= ~(1 << PCF50633_INT1_ADPINS
);
368 dev_dbg(pcf
->dev
, "INT1=0x%02x INT2=0x%02x INT3=0x%02x "
369 "INT4=0x%02x INT5=0x%02x\n", pcf_int
[0],
370 pcf_int
[1], pcf_int
[2], pcf_int
[3], pcf_int
[4]);
372 /* Some revisions of the chip don't have a 8s standby mode on
373 * ONKEY1S press. We try to manually do it in such cases. */
374 if ((pcf_int
[0] & PCF50633_INT1_SECOND
) && pcf
->onkey1s_held
) {
375 dev_info(pcf
->dev
, "ONKEY1S held for %d secs\n",
377 if (pcf
->onkey1s_held
++ == PCF50633_ONKEY1S_TIMEOUT
)
378 if (pcf
->pdata
->force_shutdown
)
379 pcf
->pdata
->force_shutdown(pcf
);
382 if (pcf_int
[2] & PCF50633_INT3_ONKEY1S
) {
383 dev_info(pcf
->dev
, "ONKEY1S held\n");
384 pcf
->onkey1s_held
= 1 ;
386 /* Unmask IRQ_SECOND */
387 pcf50633_reg_clear_bits(pcf
, PCF50633_REG_INT1M
,
388 PCF50633_INT1_SECOND
);
390 /* Unmask IRQ_ONKEYR */
391 pcf50633_reg_clear_bits(pcf
, PCF50633_REG_INT2M
,
392 PCF50633_INT2_ONKEYR
);
395 if ((pcf_int
[1] & PCF50633_INT2_ONKEYR
) && pcf
->onkey1s_held
) {
396 pcf
->onkey1s_held
= 0;
398 /* Mask SECOND and ONKEYR interrupts */
399 if (pcf
->mask_regs
[0] & PCF50633_INT1_SECOND
)
400 pcf50633_reg_set_bit_mask(pcf
,
402 PCF50633_INT1_SECOND
,
403 PCF50633_INT1_SECOND
);
405 if (pcf
->mask_regs
[1] & PCF50633_INT2_ONKEYR
)
406 pcf50633_reg_set_bit_mask(pcf
,
408 PCF50633_INT2_ONKEYR
,
409 PCF50633_INT2_ONKEYR
);
412 /* Have we just resumed ? */
413 if (pcf
->is_suspended
) {
414 pcf
->is_suspended
= 0;
416 /* Set the resume reason filtering out non resumers */
417 for (i
= 0; i
< ARRAY_SIZE(pcf_int
); i
++)
418 pcf
->resume_reason
[i
] = pcf_int
[i
] &
419 pcf
->pdata
->resumers
[i
];
421 /* Make sure we don't pass on any ONKEY events to
423 pcf_int
[1] &= ~(PCF50633_INT2_ONKEYR
| PCF50633_INT2_ONKEYF
);
426 for (i
= 0; i
< ARRAY_SIZE(pcf_int
); i
++) {
427 /* Unset masked interrupts */
428 pcf_int
[i
] &= ~pcf
->mask_regs
[i
];
430 for (j
= 0; j
< 8 ; j
++)
431 if (pcf_int
[i
] & (1 << j
))
432 pcf50633_irq_call_handler(pcf
, (i
* 8) + j
);
436 put_device(pcf
->dev
);
437 enable_irq(pcf
->irq
);
440 static irqreturn_t
pcf50633_irq(int irq
, void *data
)
442 struct pcf50633
*pcf
= data
;
444 dev_dbg(pcf
->dev
, "pcf50633_irq\n");
446 get_device(pcf
->dev
);
447 disable_irq(pcf
->irq
);
448 schedule_work(&pcf
->irq_work
);
454 pcf50633_client_dev_register(struct pcf50633
*pcf
, const char *name
,
455 struct platform_device
**pdev
)
457 struct pcf50633_subdev_pdata
*subdev_pdata
;
460 *pdev
= platform_device_alloc(name
, -1);
462 dev_err(pcf
->dev
, "Falied to allocate %s\n", name
);
466 subdev_pdata
= kmalloc(sizeof(*subdev_pdata
), GFP_KERNEL
);
468 dev_err(pcf
->dev
, "Error allocating subdev pdata\n");
469 platform_device_put(*pdev
);
472 subdev_pdata
->pcf
= pcf
;
473 platform_device_add_data(*pdev
, subdev_pdata
, sizeof(*subdev_pdata
));
475 (*pdev
)->dev
.parent
= pcf
->dev
;
477 ret
= platform_device_add(*pdev
);
479 dev_err(pcf
->dev
, "Failed to register %s: %d\n", name
, ret
);
480 platform_device_put(*pdev
);
486 static int pcf50633_suspend(struct device
*dev
, pm_message_t state
)
488 struct pcf50633
*pcf
;
492 pcf
= dev_get_drvdata(dev
);
494 /* Make sure our interrupt handlers are not called
496 disable_irq(pcf
->irq
);
498 /* Make sure that any running IRQ worker has quit */
499 cancel_work_sync(&pcf
->irq_work
);
502 ret
= pcf50633_read_block(pcf
, PCF50633_REG_INT1M
,
503 ARRAY_SIZE(pcf
->suspend_irq_masks
),
504 pcf
->suspend_irq_masks
);
506 dev_err(pcf
->dev
, "error saving irq masks\n");
510 /* Write wakeup irq masks */
511 for (i
= 0; i
< ARRAY_SIZE(res
); i
++)
512 res
[i
] = ~pcf
->pdata
->resumers
[i
];
514 ret
= pcf50633_write_block(pcf
, PCF50633_REG_INT1M
,
515 ARRAY_SIZE(res
), &res
[0]);
517 dev_err(pcf
->dev
, "error writing wakeup irq masks\n");
521 pcf
->is_suspended
= 1;
527 static int pcf50633_resume(struct device
*dev
)
529 struct pcf50633
*pcf
;
532 pcf
= dev_get_drvdata(dev
);
534 /* Write the saved mask registers */
535 ret
= pcf50633_write_block(pcf
, PCF50633_REG_INT1M
,
536 ARRAY_SIZE(pcf
->suspend_irq_masks
),
537 pcf
->suspend_irq_masks
);
539 dev_err(pcf
->dev
, "Error restoring saved suspend masks\n");
541 /* Restore regulators' state */
544 get_device(pcf
->dev
);
547 * Clear any pending interrupts and set resume reason if any.
548 * This will leave with enable_irq()
550 pcf50633_irq_worker(&pcf
->irq_work
);
555 #define pcf50633_suspend NULL
556 #define pcf50633_resume NULL
559 static int __devinit
pcf50633_probe(struct i2c_client
*client
,
560 const struct i2c_device_id
*ids
)
562 struct pcf50633
*pcf
;
563 struct pcf50633_platform_data
*pdata
= client
->dev
.platform_data
;
565 int version
, variant
;
567 pcf
= kzalloc(sizeof(*pcf
), GFP_KERNEL
);
573 mutex_init(&pcf
->lock
);
575 i2c_set_clientdata(client
, pcf
);
576 pcf
->dev
= &client
->dev
;
577 pcf
->i2c_client
= client
;
578 pcf
->irq
= client
->irq
;
580 INIT_WORK(&pcf
->irq_work
, pcf50633_irq_worker
);
582 version
= pcf50633_reg_read(pcf
, 0);
583 variant
= pcf50633_reg_read(pcf
, 1);
584 if (version
< 0 || variant
< 0) {
585 dev_err(pcf
->dev
, "Unable to probe pcf50633\n");
590 dev_info(pcf
->dev
, "Probed device version %d variant %d\n",
593 /* Enable all interrupts except RTC SECOND */
594 pcf
->mask_regs
[0] = 0x80;
595 pcf50633_reg_write(pcf
, PCF50633_REG_INT1M
, pcf
->mask_regs
[0]);
596 pcf50633_reg_write(pcf
, PCF50633_REG_INT2M
, 0x00);
597 pcf50633_reg_write(pcf
, PCF50633_REG_INT3M
, 0x00);
598 pcf50633_reg_write(pcf
, PCF50633_REG_INT4M
, 0x00);
599 pcf50633_reg_write(pcf
, PCF50633_REG_INT5M
, 0x00);
601 /* Create sub devices */
602 pcf50633_client_dev_register(pcf
, "pcf50633-input",
604 pcf50633_client_dev_register(pcf
, "pcf50633-rtc",
606 pcf50633_client_dev_register(pcf
, "pcf50633-mbc",
608 pcf50633_client_dev_register(pcf
, "pcf50633-adc",
611 for (i
= 0; i
< PCF50633_NUM_REGULATORS
; i
++) {
612 struct platform_device
*pdev
;
614 pdev
= platform_device_alloc("pcf50633-regltr", i
);
616 dev_err(pcf
->dev
, "Cannot create regulator\n");
620 pdev
->dev
.parent
= pcf
->dev
;
621 pdev
->dev
.platform_data
= &pdata
->reg_init_data
[i
];
622 pdev
->dev
.driver_data
= pcf
;
623 pcf
->regulator_pdev
[i
] = pdev
;
625 platform_device_add(pdev
);
629 ret
= request_irq(client
->irq
, pcf50633_irq
,
630 IRQF_TRIGGER_LOW
, "pcf50633", pcf
);
633 dev_err(pcf
->dev
, "Failed to request IRQ %d\n", ret
);
637 dev_err(pcf
->dev
, "No IRQ configured\n");
641 if (enable_irq_wake(client
->irq
) < 0)
642 dev_err(pcf
->dev
, "IRQ %u cannot be enabled as wake-up source"
643 "in this hardware revision", client
->irq
);
645 ret
= sysfs_create_group(&client
->dev
.kobj
, &pcf_attr_group
);
647 dev_err(pcf
->dev
, "error creating sysfs entries\n");
649 if (pdata
->probe_done
)
650 pdata
->probe_done(pcf
);
659 static int __devexit
pcf50633_remove(struct i2c_client
*client
)
661 struct pcf50633
*pcf
= i2c_get_clientdata(client
);
664 free_irq(pcf
->irq
, pcf
);
666 platform_device_unregister(pcf
->input_pdev
);
667 platform_device_unregister(pcf
->rtc_pdev
);
668 platform_device_unregister(pcf
->mbc_pdev
);
669 platform_device_unregister(pcf
->adc_pdev
);
671 for (i
= 0; i
< PCF50633_NUM_REGULATORS
; i
++)
672 platform_device_unregister(pcf
->regulator_pdev
[i
]);
679 static struct i2c_device_id pcf50633_id_table
[] = {
684 static struct i2c_driver pcf50633_driver
= {
687 .suspend
= pcf50633_suspend
,
688 .resume
= pcf50633_resume
,
690 .id_table
= pcf50633_id_table
,
691 .probe
= pcf50633_probe
,
692 .remove
= __devexit_p(pcf50633_remove
),
695 static int __init
pcf50633_init(void)
697 return i2c_add_driver(&pcf50633_driver
);
700 static void __exit
pcf50633_exit(void)
702 i2c_del_driver(&pcf50633_driver
);
705 MODULE_DESCRIPTION("I2C chip driver for NXP PCF50633 PMU");
706 MODULE_AUTHOR("Harald Welte <laforge@openmoko.org>");
707 MODULE_LICENSE("GPL");
709 module_init(pcf50633_init
);
710 module_exit(pcf50633_exit
);