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/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
)
38 ret
= i2c_smbus_read_i2c_block_data(pcf
->i2c_client
, reg
,
41 dev_err(pcf
->dev
, "Error reading %d regs at %d\n", num
, reg
);
46 static int __pcf50633_write(struct pcf50633
*pcf
, u8 reg
, int num
, u8
*data
)
50 ret
= i2c_smbus_write_i2c_block_data(pcf
->i2c_client
, reg
,
53 dev_err(pcf
->dev
, "Error writing %d regs at %d\n", num
, reg
);
59 /* Read a block of upto 32 regs */
60 int pcf50633_read_block(struct pcf50633
*pcf
, u8 reg
,
61 int nr_regs
, u8
*data
)
65 mutex_lock(&pcf
->lock
);
66 ret
= __pcf50633_read(pcf
, reg
, nr_regs
, data
);
67 mutex_unlock(&pcf
->lock
);
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
)
79 mutex_lock(&pcf
->lock
);
80 ret
= __pcf50633_write(pcf
, reg
, nr_regs
, data
);
81 mutex_unlock(&pcf
->lock
);
85 EXPORT_SYMBOL_GPL(pcf50633_write_block
);
87 u8
pcf50633_reg_read(struct pcf50633
*pcf
, u8 reg
)
91 mutex_lock(&pcf
->lock
);
92 __pcf50633_read(pcf
, reg
, 1, &val
);
93 mutex_unlock(&pcf
->lock
);
97 EXPORT_SYMBOL_GPL(pcf50633_reg_read
);
99 int pcf50633_reg_write(struct pcf50633
*pcf
, u8 reg
, u8 val
)
103 mutex_lock(&pcf
->lock
);
104 ret
= __pcf50633_write(pcf
, reg
, 1, &val
);
105 mutex_unlock(&pcf
->lock
);
109 EXPORT_SYMBOL_GPL(pcf50633_reg_write
);
111 int pcf50633_reg_set_bit_mask(struct pcf50633
*pcf
, u8 reg
, u8 mask
, u8 val
)
118 mutex_lock(&pcf
->lock
);
119 ret
= __pcf50633_read(pcf
, reg
, 1, &tmp
);
125 ret
= __pcf50633_write(pcf
, reg
, 1, &tmp
);
128 mutex_unlock(&pcf
->lock
);
132 EXPORT_SYMBOL_GPL(pcf50633_reg_set_bit_mask
);
134 int pcf50633_reg_clear_bits(struct pcf50633
*pcf
, u8 reg
, u8 val
)
139 mutex_lock(&pcf
->lock
);
140 ret
= __pcf50633_read(pcf
, reg
, 1, &tmp
);
145 ret
= __pcf50633_write(pcf
, reg
, 1, &tmp
);
148 mutex_unlock(&pcf
->lock
);
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
,
158 struct pcf50633
*pcf
= dev_get_drvdata(dev
);
162 static u8 address_no_read
[] = { /* must be ascending */
171 for (n
= 0; n
< 256; n
+= sizeof(dump
)) {
172 for (n1
= 0; n1
< sizeof(dump
); n1
++)
173 if (n
== address_no_read
[idx
]) {
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
);
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
);
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]);
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
,
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
)
223 if (WARN_ON(pcf
->irq_handler
[irq
].handler
))
226 mutex_lock(&pcf
->lock
);
227 pcf
->irq_handler
[irq
].handler
= handler
;
228 pcf
->irq_handler
[irq
].data
= data
;
229 mutex_unlock(&pcf
->lock
);
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
)
240 mutex_lock(&pcf
->lock
);
241 pcf
->irq_handler
[irq
].handler
= NULL
;
242 mutex_unlock(&pcf
->lock
);
246 EXPORT_SYMBOL_GPL(pcf50633_free_irq
);
248 static int __pcf50633_irq_mask_set(struct pcf50633
*pcf
, int irq
, u8 mask
)
254 reg
= PCF50633_REG_INT1M
+ idx
;
255 bits
= 1 << (irq
& 0x07);
257 mutex_lock(&pcf
->lock
);
260 ret
= __pcf50633_read(pcf
, reg
, 1, &tmp
);
266 ret
= __pcf50633_write(pcf
, reg
, 1, &tmp
);
270 pcf
->mask_regs
[idx
] &= ~bits
;
271 pcf
->mask_regs
[idx
] |= bits
;
273 ret
= __pcf50633_read(pcf
, reg
, 1, &tmp
);
279 ret
= __pcf50633_write(pcf
, reg
, 1, &tmp
);
283 pcf
->mask_regs
[idx
] &= ~bits
;
286 mutex_unlock(&pcf
->lock
);
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
)
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
;
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.
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
);
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
);
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",
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
,
404 PCF50633_INT1_SECOND
,
405 PCF50633_INT1_SECOND
);
407 if (pcf
->mask_regs
[1] & PCF50633_INT2_ONKEYR
)
408 pcf50633_reg_set_bit_mask(pcf
,
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
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
);
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
);
456 pcf50633_client_dev_register(struct pcf50633
*pcf
, const char *name
,
457 struct platform_device
**pdev
)
461 *pdev
= platform_device_alloc(name
, -1);
463 dev_err(pcf
->dev
, "Falied to allocate %s\n", name
);
467 (*pdev
)->dev
.parent
= pcf
->dev
;
469 ret
= platform_device_add(*pdev
);
471 dev_err(pcf
->dev
, "Failed to register %s: %d\n", name
, ret
);
472 platform_device_put(*pdev
);
478 static int pcf50633_suspend(struct i2c_client
*client
, pm_message_t state
)
480 struct pcf50633
*pcf
;
484 pcf
= i2c_get_clientdata(client
);
486 /* Make sure our interrupt handlers are not called
488 disable_irq(pcf
->irq
);
490 /* Make sure that any running IRQ worker has quit */
491 cancel_work_sync(&pcf
->irq_work
);
494 ret
= pcf50633_read_block(pcf
, PCF50633_REG_INT1M
,
495 ARRAY_SIZE(pcf
->suspend_irq_masks
),
496 pcf
->suspend_irq_masks
);
498 dev_err(pcf
->dev
, "error saving irq masks\n");
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]);
509 dev_err(pcf
->dev
, "error writing wakeup irq masks\n");
513 pcf
->is_suspended
= 1;
519 static int pcf50633_resume(struct i2c_client
*client
)
521 struct pcf50633
*pcf
;
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
);
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
);
547 #define pcf50633_suspend NULL
548 #define pcf50633_resume NULL
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
;
557 int version
, variant
;
560 dev_err(&client
->dev
, "Missing IRQ\n");
564 pcf
= kzalloc(sizeof(*pcf
), GFP_KERNEL
);
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");
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");
591 goto err_destroy_workqueue
;
594 dev_info(pcf
->dev
, "Probed device version %d variant %d\n",
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
);
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",
616 pcf50633_client_dev_register(pcf
, "pcf50633-rtc",
618 pcf50633_client_dev_register(pcf
, "pcf50633-mbc",
620 pcf50633_client_dev_register(pcf
, "pcf50633-adc",
623 for (i
= 0; i
< PCF50633_NUM_REGULATORS
; i
++) {
624 struct platform_device
*pdev
;
626 pdev
= platform_device_alloc("pcf50633-regltr", i
);
628 dev_err(pcf
->dev
, "Cannot create regulator %d\n", i
);
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
);
646 dev_err(pcf
->dev
, "error creating sysfs entries\n");
648 if (pdata
->probe_done
)
649 pdata
->probe_done(pcf
);
653 err_destroy_workqueue
:
654 destroy_workqueue(pcf
->work_queue
);
656 i2c_set_clientdata(client
, NULL
);
662 static int __devexit
pcf50633_remove(struct i2c_client
*client
)
664 struct pcf50633
*pcf
= i2c_get_clientdata(client
);
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
]);
683 static struct i2c_device_id pcf50633_id_table
[] = {
688 static struct i2c_driver pcf50633_driver
= {
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
);