2 * Copyright (C) 2007-2010 ST-Ericsson
3 * License terms: GNU General Public License (GPL) version 2
4 * Low-level core for exclusive access to the AB3100 IC on the I2C bus
5 * and some basic chip-configuration.
6 * Author: Linus Walleij <linus.walleij@stericsson.com>
10 #include <linux/mutex.h>
11 #include <linux/list.h>
12 #include <linux/notifier.h>
13 #include <linux/err.h>
14 #include <linux/platform_device.h>
15 #include <linux/device.h>
16 #include <linux/interrupt.h>
17 #include <linux/random.h>
18 #include <linux/debugfs.h>
19 #include <linux/seq_file.h>
20 #include <linux/uaccess.h>
21 #include <linux/mfd/ab3100.h>
23 /* These are the only registers inside AB3100 used in this main file */
25 /* Interrupt event registers */
26 #define AB3100_EVENTA1 0x21
27 #define AB3100_EVENTA2 0x22
28 #define AB3100_EVENTA3 0x23
30 /* AB3100 DAC converter registers */
31 #define AB3100_DIS 0x00
32 #define AB3100_D0C 0x01
33 #define AB3100_D1C 0x02
34 #define AB3100_D2C 0x03
35 #define AB3100_D3C 0x04
37 /* Chip ID register */
38 #define AB3100_CID 0x20
40 /* AB3100 interrupt registers */
41 #define AB3100_IMRA1 0x24
42 #define AB3100_IMRA2 0x25
43 #define AB3100_IMRA3 0x26
44 #define AB3100_IMRB1 0x2B
45 #define AB3100_IMRB2 0x2C
46 #define AB3100_IMRB3 0x2D
48 /* System Power Monitoring and control registers */
49 #define AB3100_MCA 0x2E
50 #define AB3100_MCB 0x2F
53 #define AB3100_SUP 0x50
58 * The AB3100 is usually assigned address 0x48 (7-bit)
59 * The chip is defined in the platform i2c_board_data section.
62 u8
ab3100_get_chip_type(struct ab3100
*ab3100
)
66 switch (ab3100
->chip_id
& 0xf0) {
76 EXPORT_SYMBOL(ab3100_get_chip_type
);
78 int ab3100_set_register_interruptible(struct ab3100
*ab3100
, u8 reg
, u8 regval
)
80 u8 regandval
[2] = {reg
, regval
};
83 err
= mutex_lock_interruptible(&ab3100
->access_mutex
);
88 * A two-byte write message with the first byte containing the register
89 * number and the second byte containing the value to be written
90 * effectively sets a register in the AB3100.
92 err
= i2c_master_send(ab3100
->i2c_client
, regandval
, 2);
95 "write error (write register): %d\n",
97 } else if (err
!= 2) {
99 "write error (write register) "
100 "%d bytes transferred (expected 2)\n",
107 mutex_unlock(&ab3100
->access_mutex
);
110 EXPORT_SYMBOL(ab3100_set_register_interruptible
);
114 * The test registers exist at an I2C bus address up one
115 * from the ordinary base. They are not supposed to be used
116 * in production code, but sometimes you have to do that
117 * anyway. It's currently only used from this file so declare
118 * it static and do not export.
120 static int ab3100_set_test_register_interruptible(struct ab3100
*ab3100
,
123 u8 regandval
[2] = {reg
, regval
};
126 err
= mutex_lock_interruptible(&ab3100
->access_mutex
);
130 err
= i2c_master_send(ab3100
->testreg_client
, regandval
, 2);
133 "write error (write test register): %d\n",
135 } else if (err
!= 2) {
137 "write error (write test register) "
138 "%d bytes transferred (expected 2)\n",
145 mutex_unlock(&ab3100
->access_mutex
);
151 int ab3100_get_register_interruptible(struct ab3100
*ab3100
, u8 reg
, u8
*regval
)
155 err
= mutex_lock_interruptible(&ab3100
->access_mutex
);
160 * AB3100 require an I2C "stop" command between each message, else
161 * it will not work. The only way of achieveing this with the
162 * message transport layer is to send the read and write messages
165 err
= i2c_master_send(ab3100
->i2c_client
, ®
, 1);
168 "write error (send register address): %d\n",
170 goto get_reg_out_unlock
;
171 } else if (err
!= 1) {
173 "write error (send register address) "
174 "%d bytes transferred (expected 1)\n",
177 goto get_reg_out_unlock
;
183 err
= i2c_master_recv(ab3100
->i2c_client
, regval
, 1);
186 "write error (read register): %d\n",
188 goto get_reg_out_unlock
;
189 } else if (err
!= 1) {
191 "write error (read register) "
192 "%d bytes transferred (expected 1)\n",
195 goto get_reg_out_unlock
;
202 mutex_unlock(&ab3100
->access_mutex
);
205 EXPORT_SYMBOL(ab3100_get_register_interruptible
);
208 int ab3100_get_register_page_interruptible(struct ab3100
*ab3100
,
209 u8 first_reg
, u8
*regvals
, u8 numregs
)
213 if (ab3100
->chip_id
== 0xa0 ||
214 ab3100
->chip_id
== 0xa1)
215 /* These don't support paged reads */
218 err
= mutex_lock_interruptible(&ab3100
->access_mutex
);
223 * Paged read also require an I2C "stop" command.
225 err
= i2c_master_send(ab3100
->i2c_client
, &first_reg
, 1);
228 "write error (send first register address): %d\n",
230 goto get_reg_page_out_unlock
;
231 } else if (err
!= 1) {
233 "write error (send first register address) "
234 "%d bytes transferred (expected 1)\n",
237 goto get_reg_page_out_unlock
;
240 err
= i2c_master_recv(ab3100
->i2c_client
, regvals
, numregs
);
243 "write error (read register page): %d\n",
245 goto get_reg_page_out_unlock
;
246 } else if (err
!= numregs
) {
248 "write error (read register page) "
249 "%d bytes transferred (expected %d)\n",
252 goto get_reg_page_out_unlock
;
258 get_reg_page_out_unlock
:
259 mutex_unlock(&ab3100
->access_mutex
);
262 EXPORT_SYMBOL(ab3100_get_register_page_interruptible
);
265 int ab3100_mask_and_set_register_interruptible(struct ab3100
*ab3100
,
266 u8 reg
, u8 andmask
, u8 ormask
)
268 u8 regandval
[2] = {reg
, 0};
271 err
= mutex_lock_interruptible(&ab3100
->access_mutex
);
275 /* First read out the target register */
276 err
= i2c_master_send(ab3100
->i2c_client
, ®
, 1);
279 "write error (maskset send address): %d\n",
281 goto get_maskset_unlock
;
282 } else if (err
!= 1) {
284 "write error (maskset send address) "
285 "%d bytes transferred (expected 1)\n",
288 goto get_maskset_unlock
;
291 err
= i2c_master_recv(ab3100
->i2c_client
, ®andval
[1], 1);
294 "write error (maskset read register): %d\n",
296 goto get_maskset_unlock
;
297 } else if (err
!= 1) {
299 "write error (maskset read register) "
300 "%d bytes transferred (expected 1)\n",
303 goto get_maskset_unlock
;
306 /* Modify the register */
307 regandval
[1] &= andmask
;
308 regandval
[1] |= ormask
;
310 /* Write the register */
311 err
= i2c_master_send(ab3100
->i2c_client
, regandval
, 2);
314 "write error (write register): %d\n",
316 goto get_maskset_unlock
;
317 } else if (err
!= 2) {
319 "write error (write register) "
320 "%d bytes transferred (expected 2)\n",
323 goto get_maskset_unlock
;
330 mutex_unlock(&ab3100
->access_mutex
);
333 EXPORT_SYMBOL(ab3100_mask_and_set_register_interruptible
);
337 * Register a simple callback for handling any AB3100 events.
339 int ab3100_event_register(struct ab3100
*ab3100
,
340 struct notifier_block
*nb
)
342 return blocking_notifier_chain_register(&ab3100
->event_subscribers
,
345 EXPORT_SYMBOL(ab3100_event_register
);
348 * Remove a previously registered callback.
350 int ab3100_event_unregister(struct ab3100
*ab3100
,
351 struct notifier_block
*nb
)
353 return blocking_notifier_chain_unregister(&ab3100
->event_subscribers
,
356 EXPORT_SYMBOL(ab3100_event_unregister
);
359 int ab3100_event_registers_startup_state_get(struct ab3100
*ab3100
,
362 if (!ab3100
->startup_events_read
)
363 return -EAGAIN
; /* Try again later */
364 *fatevent
= ab3100
->startup_events
;
367 EXPORT_SYMBOL(ab3100_event_registers_startup_state_get
);
370 * This is a threaded interrupt handler so we can make some
373 static irqreturn_t
ab3100_irq_handler(int irq
, void *data
)
375 struct ab3100
*ab3100
= data
;
380 add_interrupt_randomness(irq
);
382 err
= ab3100_get_register_page_interruptible(ab3100
, AB3100_EVENTA1
,
387 fatevent
= (event_regs
[0] << 16) |
388 (event_regs
[1] << 8) |
391 if (!ab3100
->startup_events_read
) {
392 ab3100
->startup_events
= fatevent
;
393 ab3100
->startup_events_read
= true;
396 * The notified parties will have to mask out the events
397 * they're interested in and react to them. They will be
398 * notified on all events, then they use the fatevent value
399 * to determine if they're interested.
401 blocking_notifier_call_chain(&ab3100
->event_subscribers
,
405 "IRQ Event: 0x%08x\n", fatevent
);
411 "error reading event status\n");
415 #ifdef CONFIG_DEBUG_FS
417 * Some debugfs entries only exposed if we're using debug
419 static int ab3100_registers_print(struct seq_file
*s
, void *p
)
421 struct ab3100
*ab3100
= s
->private;
425 seq_printf(s
, "AB3100 registers:\n");
427 for (reg
= 0; reg
< 0xff; reg
++) {
428 ab3100_get_register_interruptible(ab3100
, reg
, &value
);
429 seq_printf(s
, "[0x%x]: 0x%x\n", reg
, value
);
434 static int ab3100_registers_open(struct inode
*inode
, struct file
*file
)
436 return single_open(file
, ab3100_registers_print
, inode
->i_private
);
439 static const struct file_operations ab3100_registers_fops
= {
440 .open
= ab3100_registers_open
,
443 .release
= single_release
,
444 .owner
= THIS_MODULE
,
447 struct ab3100_get_set_reg_priv
{
448 struct ab3100
*ab3100
;
452 static int ab3100_get_set_reg_open_file(struct inode
*inode
, struct file
*file
)
454 file
->private_data
= inode
->i_private
;
458 static ssize_t
ab3100_get_set_reg(struct file
*file
,
459 const char __user
*user_buf
,
460 size_t count
, loff_t
*ppos
)
462 struct ab3100_get_set_reg_priv
*priv
= file
->private_data
;
463 struct ab3100
*ab3100
= priv
->ab3100
;
467 unsigned long user_reg
;
471 /* Get userspace string and assure termination */
472 buf_size
= min(count
, (sizeof(buf
)-1));
473 if (copy_from_user(buf
, user_buf
, buf_size
))
478 * The idea is here to parse a string which is either
479 * "0xnn" for reading a register, or "0xaa 0xbb" for
480 * writing 0xbb to the register 0xaa. First move past
481 * whitespace and then begin to parse the register.
483 while ((i
< buf_size
) && (buf
[i
] == ' '))
488 * Advance pointer to end of string then terminate
489 * the register string. This is needed to satisfy
490 * the strict_strtoul() function.
492 while ((i
< buf_size
) && (buf
[i
] != ' '))
496 err
= strict_strtoul(&buf
[regp
], 16, &user_reg
);
502 /* Either we read or we write a register here */
505 u8 reg
= (u8
) user_reg
;
508 ab3100_get_register_interruptible(ab3100
, reg
, ®value
);
510 dev_info(ab3100
->dev
,
511 "debug read AB3100 reg[0x%02x]: 0x%02x\n",
515 unsigned long user_value
;
516 u8 reg
= (u8
) user_reg
;
521 * Writing, we need some value to write to
522 * the register so keep parsing the string
526 while ((i
< buf_size
) && (buf
[i
] == ' '))
529 while ((i
< buf_size
) && (buf
[i
] != ' '))
533 err
= strict_strtoul(&buf
[valp
], 16, &user_value
);
539 value
= (u8
) user_value
;
540 ab3100_set_register_interruptible(ab3100
, reg
, value
);
541 ab3100_get_register_interruptible(ab3100
, reg
, ®value
);
543 dev_info(ab3100
->dev
,
544 "debug write reg[0x%02x] with 0x%02x, "
545 "after readback: 0x%02x\n",
546 reg
, value
, regvalue
);
551 static const struct file_operations ab3100_get_set_reg_fops
= {
552 .open
= ab3100_get_set_reg_open_file
,
553 .write
= ab3100_get_set_reg
,
556 static struct dentry
*ab3100_dir
;
557 static struct dentry
*ab3100_reg_file
;
558 static struct ab3100_get_set_reg_priv ab3100_get_priv
;
559 static struct dentry
*ab3100_get_reg_file
;
560 static struct ab3100_get_set_reg_priv ab3100_set_priv
;
561 static struct dentry
*ab3100_set_reg_file
;
563 static void ab3100_setup_debugfs(struct ab3100
*ab3100
)
567 ab3100_dir
= debugfs_create_dir("ab3100", NULL
);
569 goto exit_no_debugfs
;
571 ab3100_reg_file
= debugfs_create_file("registers",
572 S_IRUGO
, ab3100_dir
, ab3100
,
573 &ab3100_registers_fops
);
574 if (!ab3100_reg_file
) {
576 goto exit_destroy_dir
;
579 ab3100_get_priv
.ab3100
= ab3100
;
580 ab3100_get_priv
.mode
= false;
581 ab3100_get_reg_file
= debugfs_create_file("get_reg",
582 S_IWUGO
, ab3100_dir
, &ab3100_get_priv
,
583 &ab3100_get_set_reg_fops
);
584 if (!ab3100_get_reg_file
) {
586 goto exit_destroy_reg
;
589 ab3100_set_priv
.ab3100
= ab3100
;
590 ab3100_set_priv
.mode
= true;
591 ab3100_set_reg_file
= debugfs_create_file("set_reg",
592 S_IWUGO
, ab3100_dir
, &ab3100_set_priv
,
593 &ab3100_get_set_reg_fops
);
594 if (!ab3100_set_reg_file
) {
596 goto exit_destroy_get_reg
;
600 exit_destroy_get_reg
:
601 debugfs_remove(ab3100_get_reg_file
);
603 debugfs_remove(ab3100_reg_file
);
605 debugfs_remove(ab3100_dir
);
609 static inline void ab3100_remove_debugfs(void)
611 debugfs_remove(ab3100_set_reg_file
);
612 debugfs_remove(ab3100_get_reg_file
);
613 debugfs_remove(ab3100_reg_file
);
614 debugfs_remove(ab3100_dir
);
617 static inline void ab3100_setup_debugfs(struct ab3100
*ab3100
)
620 static inline void ab3100_remove_debugfs(void)
626 * Basic set-up, datastructure creation/destruction and I2C interface.
627 * This sets up a default config in the AB3100 chip so that it
628 * will work as expected.
631 struct ab3100_init_setting
{
636 static const struct ab3100_init_setting __initconst
637 ab3100_init_settings
[] = {
645 .abreg
= AB3100_IMRA1
,
648 .abreg
= AB3100_IMRA2
,
651 .abreg
= AB3100_IMRA3
,
654 .abreg
= AB3100_IMRB1
,
657 .abreg
= AB3100_IMRB2
,
660 .abreg
= AB3100_IMRB3
,
683 static int __init
ab3100_setup(struct ab3100
*ab3100
)
688 for (i
= 0; i
< ARRAY_SIZE(ab3100_init_settings
); i
++) {
689 err
= ab3100_set_register_interruptible(ab3100
,
690 ab3100_init_settings
[i
].abreg
,
691 ab3100_init_settings
[i
].setting
);
697 * Special trick to make the AB3100 use the 32kHz clock (RTC)
698 * bit 3 in test register 0x02 is a special, undocumented test
699 * register bit that only exist in AB3100 P1E
701 if (ab3100
->chip_id
== 0xc4) {
702 dev_warn(ab3100
->dev
,
703 "AB3100 P1E variant detected, "
704 "forcing chip to 32KHz\n");
705 err
= ab3100_set_test_register_interruptible(ab3100
, 0x02, 0x08);
713 * Here we define all the platform devices that appear
714 * as children of the AB3100. These are regular platform
715 * devices with the IORESOURCE_IO .start and .end set
716 * to correspond to the internal AB3100 register range
717 * mapping to the corresponding subdevice.
720 #define AB3100_DEVICE(devname, devid) \
721 static struct platform_device ab3100_##devname##_device = { \
726 /* This lists all the subdevices */
727 AB3100_DEVICE(dac
, "ab3100-dac");
728 AB3100_DEVICE(leds
, "ab3100-leds");
729 AB3100_DEVICE(power
, "ab3100-power");
730 AB3100_DEVICE(regulators
, "ab3100-regulators");
731 AB3100_DEVICE(sim
, "ab3100-sim");
732 AB3100_DEVICE(uart
, "ab3100-uart");
733 AB3100_DEVICE(rtc
, "ab3100-rtc");
734 AB3100_DEVICE(charger
, "ab3100-charger");
735 AB3100_DEVICE(boost
, "ab3100-boost");
736 AB3100_DEVICE(adc
, "ab3100-adc");
737 AB3100_DEVICE(fuelgauge
, "ab3100-fuelgauge");
738 AB3100_DEVICE(vibrator
, "ab3100-vibrator");
739 AB3100_DEVICE(otp
, "ab3100-otp");
740 AB3100_DEVICE(codec
, "ab3100-codec");
742 static struct platform_device
*
743 ab3100_platform_devs
[] = {
746 &ab3100_power_device
,
747 &ab3100_regulators_device
,
751 &ab3100_charger_device
,
752 &ab3100_boost_device
,
754 &ab3100_fuelgauge_device
,
755 &ab3100_vibrator_device
,
757 &ab3100_codec_device
,
760 struct ab_family_id
{
765 static const struct ab_family_id ids
[] __initdata
= {
795 /* AB3000 variants, not supported */
819 static int __init
ab3100_probe(struct i2c_client
*client
,
820 const struct i2c_device_id
*id
)
822 struct ab3100
*ab3100
;
823 struct ab3100_platform_data
*ab3100_plf_data
=
824 client
->dev
.platform_data
;
828 ab3100
= kzalloc(sizeof(struct ab3100
), GFP_KERNEL
);
830 dev_err(&client
->dev
, "could not allocate AB3100 device\n");
834 /* Initialize data structure */
835 mutex_init(&ab3100
->access_mutex
);
836 BLOCKING_INIT_NOTIFIER_HEAD(&ab3100
->event_subscribers
);
838 ab3100
->i2c_client
= client
;
839 ab3100
->dev
= &ab3100
->i2c_client
->dev
;
841 i2c_set_clientdata(client
, ab3100
);
843 /* Read chip ID register */
844 err
= ab3100_get_register_interruptible(ab3100
, AB3100_CID
,
847 dev_err(&client
->dev
,
848 "could not communicate with the AB3100 analog "
853 for (i
= 0; ids
[i
].id
!= 0x0; i
++) {
854 if (ids
[i
].id
== ab3100
->chip_id
) {
855 if (ids
[i
].name
!= NULL
) {
856 snprintf(&ab3100
->chip_name
[0],
857 sizeof(ab3100
->chip_name
) - 1,
862 dev_err(&client
->dev
,
863 "AB3000 is not supported\n");
869 if (ids
[i
].id
== 0x0) {
870 dev_err(&client
->dev
, "unknown analog baseband chip id: 0x%x\n",
872 dev_err(&client
->dev
, "accepting it anyway. Please update "
877 dev_info(&client
->dev
, "Detected chip: %s\n",
878 &ab3100
->chip_name
[0]);
880 /* Attach a second dummy i2c_client to the test register address */
881 ab3100
->testreg_client
= i2c_new_dummy(client
->adapter
,
883 if (!ab3100
->testreg_client
) {
885 goto exit_no_testreg_client
;
888 err
= ab3100_setup(ab3100
);
892 err
= request_threaded_irq(client
->irq
, NULL
, ab3100_irq_handler
,
893 IRQF_ONESHOT
, "ab3100-core", ab3100
);
894 /* This real unpredictable IRQ is of course sampled for entropy */
895 rand_initialize_irq(client
->irq
);
900 /* Set parent and a pointer back to the container in device data */
901 for (i
= 0; i
< ARRAY_SIZE(ab3100_platform_devs
); i
++) {
902 ab3100_platform_devs
[i
]->dev
.parent
=
904 ab3100_platform_devs
[i
]->dev
.platform_data
=
906 platform_set_drvdata(ab3100_platform_devs
[i
], ab3100
);
909 /* Register the platform devices */
910 platform_add_devices(ab3100_platform_devs
,
911 ARRAY_SIZE(ab3100_platform_devs
));
913 ab3100_setup_debugfs(ab3100
);
919 i2c_unregister_device(ab3100
->testreg_client
);
920 exit_no_testreg_client
:
926 static int __exit
ab3100_remove(struct i2c_client
*client
)
928 struct ab3100
*ab3100
= i2c_get_clientdata(client
);
931 /* Unregister subdevices */
932 for (i
= 0; i
< ARRAY_SIZE(ab3100_platform_devs
); i
++)
933 platform_device_unregister(ab3100_platform_devs
[i
]);
935 ab3100_remove_debugfs();
936 i2c_unregister_device(ab3100
->testreg_client
);
939 * At this point, all subscribers should have unregistered
940 * their notifiers so deactivate IRQ
942 free_irq(client
->irq
, ab3100
);
947 static const struct i2c_device_id ab3100_id
[] = {
951 MODULE_DEVICE_TABLE(i2c
, ab3100_id
);
953 static struct i2c_driver ab3100_driver
= {
956 .owner
= THIS_MODULE
,
958 .id_table
= ab3100_id
,
959 .probe
= ab3100_probe
,
960 .remove
= __exit_p(ab3100_remove
),
963 static int __init
ab3100_i2c_init(void)
965 return i2c_add_driver(&ab3100_driver
);
968 static void __exit
ab3100_i2c_exit(void)
970 i2c_del_driver(&ab3100_driver
);
973 subsys_initcall(ab3100_i2c_init
);
974 module_exit(ab3100_i2c_exit
);
976 MODULE_AUTHOR("Linus Walleij <linus.walleij@stericsson.com>");
977 MODULE_DESCRIPTION("AB3100 core driver");
978 MODULE_LICENSE("GPL");