2 * drivers/i2c/chips/menelaus.c
4 * Copyright (C) 2004 Texas Instruments, Inc.
6 * Some parts based tps65010.c:
7 * Copyright (C) 2004 Texas Instruments and
8 * Copyright (C) 2004-2005 David Brownell
10 * Some parts based on tlv320aic24.c:
11 * Copyright (C) by Kai Svahn <kai.svahn@nokia.com>
13 * Changes for interrupt handling and clean-up by
14 * Tony Lindgren <tony@atomide.com> and Imre Deak <imre.deak@nokia.com>
15 * Cleanup and generalized support for voltage setting by
17 * Copyright (C) 2005-2006 Nokia Corporation
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation; either version 2 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #include <linux/module.h>
35 #include <linux/i2c.h>
36 #include <linux/interrupt.h>
37 #include <linux/sched.h>
38 #include <linux/mutex.h>
39 #include <linux/workqueue.h>
41 #include <asm/mach-types.h>
42 #include <asm/mach/irq.h>
44 #include <asm/arch/mux.h>
45 #include <asm/arch/gpio.h>
46 #include <asm/arch/menelaus.h>
50 #define DRIVER_NAME "menelaus"
52 #define pr_err(fmt, arg...) printk(KERN_ERR DRIVER_NAME ": ", ## arg);
54 #define MENELAUS_I2C_ADDRESS 0x72
56 #define MENELAUS_REV 0x01
57 #define MENELAUS_VCORE_CTRL1 0x02
58 #define MENELAUS_VCORE_CTRL2 0x03
59 #define MENELAUS_VCORE_CTRL3 0x04
60 #define MENELAUS_VCORE_CTRL4 0x05
61 #define MENELAUS_VCORE_CTRL5 0x06
62 #define MENELAUS_DCDC_CTRL1 0x07
63 #define MENELAUS_DCDC_CTRL2 0x08
64 #define MENELAUS_DCDC_CTRL3 0x09
65 #define MENELAUS_LDO_CTRL1 0x0A
66 #define MENELAUS_LDO_CTRL2 0x0B
67 #define MENELAUS_LDO_CTRL3 0x0C
68 #define MENELAUS_LDO_CTRL4 0x0D
69 #define MENELAUS_LDO_CTRL5 0x0E
70 #define MENELAUS_LDO_CTRL6 0x0F
71 #define MENELAUS_LDO_CTRL7 0x10
72 #define MENELAUS_LDO_CTRL8 0x11
73 #define MENELAUS_SLEEP_CTRL1 0x12
74 #define MENELAUS_SLEEP_CTRL2 0x13
75 #define MENELAUS_DEVICE_OFF 0x14
76 #define MENELAUS_OSC_CTRL 0x15
77 #define MENELAUS_DETECT_CTRL 0x16
78 #define MENELAUS_INT_MASK1 0x17
79 #define MENELAUS_INT_MASK2 0x18
80 #define MENELAUS_INT_STATUS1 0x19
81 #define MENELAUS_INT_STATUS2 0x1A
82 #define MENELAUS_INT_ACK1 0x1B
83 #define MENELAUS_INT_ACK2 0x1C
84 #define MENELAUS_GPIO_CTRL 0x1D
85 #define MENELAUS_GPIO_IN 0x1E
86 #define MENELAUS_GPIO_OUT 0x1F
87 #define MENELAUS_BBSMS 0x20
88 #define MENELAUS_RTC_CTRL 0x21
89 #define MENELAUS_RTC_UPDATE 0x22
90 #define MENELAUS_RTC_SEC 0x23
91 #define MENELAUS_RTC_MIN 0x24
92 #define MENELAUS_RTC_HR 0x25
93 #define MENELAUS_RTC_DAY 0x26
94 #define MENELAUS_RTC_MON 0x27
95 #define MENELAUS_RTC_YR 0x28
96 #define MENELAUS_RTC_WKDAY 0x29
97 #define MENELAUS_RTC_AL_SEC 0x2A
98 #define MENELAUS_RTC_AL_MIN 0x2B
99 #define MENELAUS_RTC_AL_HR 0x2C
100 #define MENELAUS_RTC_AL_DAY 0x2D
101 #define MENELAUS_RTC_AL_MON 0x2E
102 #define MENELAUS_RTC_AL_YR 0x2F
103 #define MENELAUS_RTC_COMP_MSB 0x30
104 #define MENELAUS_RTC_COMP_LSB 0x31
105 #define MENELAUS_S1_PULL_EN 0x32
106 #define MENELAUS_S1_PULL_DIR 0x33
107 #define MENELAUS_S2_PULL_EN 0x34
108 #define MENELAUS_S2_PULL_DIR 0x35
109 #define MENELAUS_MCT_CTRL1 0x36
110 #define MENELAUS_MCT_CTRL2 0x37
111 #define MENELAUS_MCT_CTRL3 0x38
112 #define MENELAUS_MCT_PIN_ST 0x39
113 #define MENELAUS_DEBOUNCE1 0x3A
115 #define IH_MENELAUS_IRQS 12
116 #define MENELAUS_MMC_S1CD_IRQ 0 /* MMC slot 1 card change */
117 #define MENELAUS_MMC_S2CD_IRQ 1 /* MMC slot 2 card change */
118 #define MENELAUS_MMC_S1D1_IRQ 2 /* MMC DAT1 low in slot 1 */
119 #define MENELAUS_MMC_S2D1_IRQ 3 /* MMC DAT1 low in slot 2 */
120 #define MENELAUS_LOWBAT_IRQ 4 /* Low battery */
121 #define MENELAUS_HOTDIE_IRQ 5 /* Hot die detect */
122 #define MENELAUS_UVLO_IRQ 6 /* UVLO detect */
123 #define MENELAUS_TSHUT_IRQ 7 /* Thermal shutdown */
124 #define MENELAUS_RTCTMR_IRQ 8 /* RTC timer */
125 #define MENELAUS_RTCALM_IRQ 9 /* RTC alarm */
126 #define MENELAUS_RTCERR_IRQ 10 /* RTC error */
127 #define MENELAUS_PSHBTN_IRQ 11 /* Push button */
128 #define MENELAUS_RESERVED12_IRQ 12 /* Reserved */
129 #define MENELAUS_RESERVED13_IRQ 13 /* Reserved */
130 #define MENELAUS_RESERVED14_IRQ 14 /* Reserved */
131 #define MENELAUS_RESERVED15_IRQ 15 /* Reserved */
133 static void menelaus_work(struct work_struct *_menelaus);
135 /* Initialized by menelaus_init */
136 static unsigned short normal_i2c[] = { MENELAUS_I2C_ADDRESS, I2C_CLIENT_END };
140 struct menelaus_chip {
141 unsigned long initialized;
143 struct i2c_client client;
144 struct work_struct work;
147 void (*mmc_callback)(void *data, u8 mask);
148 void *mmc_callback_data;
151 static struct menelaus_chip menelaus;
153 static int menelaus_write_reg(int reg, u8 value)
155 int val = i2c_smbus_write_byte_data(&menelaus.client, reg, value);
158 pr_err("write error");
165 static int menelaus_read_reg(int reg)
167 int val = i2c_smbus_read_byte_data(&menelaus.client, reg);
170 pr_err("read error");
175 static int menelaus_enable_irq(int irq)
178 return menelaus_write_reg(MENELAUS_INT_MASK2,
179 menelaus_read_reg(MENELAUS_INT_MASK2)
180 & ~(1 << (irq - 8)));
182 return menelaus_write_reg(MENELAUS_INT_MASK1,
183 menelaus_read_reg(MENELAUS_INT_MASK1)
187 static int menelaus_disable_irq(int irq)
190 return menelaus_write_reg(menelaus_read_reg(MENELAUS_INT_MASK2)
194 return menelaus_write_reg(MENELAUS_INT_MASK1,
195 menelaus_read_reg(MENELAUS_INT_MASK1)
199 static int menelaus_ack_irq(int irq)
202 return menelaus_write_reg(MENELAUS_INT_ACK2, 1 << (irq - 8));
204 return menelaus_write_reg(MENELAUS_INT_ACK1, 1 << irq);
207 /* Adds a handler for an interrupt. Does not run in interrupt context */
208 static int menelaus_add_irq_work(int irq, void * handler)
212 mutex_lock(&menelaus.lock);
213 menelaus.handlers[irq] = handler;
214 ret = menelaus_enable_irq(irq);
215 mutex_unlock(&menelaus.lock);
220 /* Removes handler for an interrupt */
221 static int menelaus_remove_irq_work(int irq)
225 mutex_lock(&menelaus.lock);
226 ret = menelaus_disable_irq(irq);
227 menelaus.handlers[irq] = NULL;
228 mutex_unlock(&menelaus.lock);
234 * Gets scheduled when a card detect interrupt happens. Note that in some cases
235 * this line is wired to card cover switch rather than the card detect switch
236 * in each slot. In this case the cards are not seen by menelaus.
237 * FIXME: Add handling for D1 too
239 static int menelaus_mmc_cd_work(struct menelaus_chip * menelaus_hw)
242 unsigned char card_mask = 0;
244 reg = menelaus_read_reg(MENELAUS_MCT_PIN_ST);
249 card_mask |= (1 << 0);
252 card_mask |= (1 << 1);
254 if (menelaus_hw->mmc_callback)
255 menelaus_hw->mmc_callback(menelaus_hw->mmc_callback_data,
262 * Toggles the MMC slots between open-drain and push-pull mode.
264 int menelaus_set_mmc_opendrain(int slot, int enable)
268 if (slot != 1 && slot != 2)
270 mutex_lock(&menelaus.lock);
271 ret = menelaus_read_reg(MENELAUS_MCT_CTRL1);
273 mutex_unlock(&menelaus.lock);
288 ret = menelaus_write_reg(MENELAUS_MCT_CTRL1, val);
289 mutex_unlock(&menelaus.lock);
293 EXPORT_SYMBOL(menelaus_set_mmc_opendrain);
295 int menelaus_set_slot_sel(int enable)
299 mutex_lock(&menelaus.lock);
300 ret = menelaus_read_reg(MENELAUS_GPIO_CTRL);
308 ret = menelaus_write_reg(MENELAUS_GPIO_CTRL, ret);
310 mutex_unlock(&menelaus.lock);
313 EXPORT_SYMBOL(menelaus_set_slot_sel);
315 int menelaus_set_mmc_slot(int slot, int enable, int power, int cd_en)
319 if (slot != 1 && slot != 2)
324 mutex_lock(&menelaus.lock);
326 ret = menelaus_read_reg(MENELAUS_MCT_CTRL2);
332 val |= (1 << 4) | (1 << 6);
334 val &= ~((1 << 4) | (1 << 6));
337 val |= (1 << 5) | (1 << 7);
339 val &= ~((1 << 5) | (1 << 7));
341 ret = menelaus_write_reg(MENELAUS_MCT_CTRL2, val);
345 ret = menelaus_read_reg(MENELAUS_MCT_CTRL3);
361 b = menelaus_read_reg(MENELAUS_MCT_CTRL2);
364 ret = menelaus_write_reg(MENELAUS_MCT_CTRL2, b);
368 /* Disable autonomous shutdown */
370 ret = menelaus_write_reg(MENELAUS_MCT_CTRL3, val);
372 mutex_unlock(&menelaus.lock);
375 EXPORT_SYMBOL(menelaus_set_mmc_slot);
377 #include <linux/delay.h>
379 int menelaus_register_mmc_callback(void (*callback)(void *data, u8 card_mask),
384 menelaus.mmc_callback_data = data;
385 menelaus.mmc_callback = callback;
386 ret = menelaus_add_irq_work(MENELAUS_MMC_S1CD_IRQ,
387 menelaus_mmc_cd_work);
390 ret = menelaus_add_irq_work(MENELAUS_MMC_S2CD_IRQ,
391 menelaus_mmc_cd_work);
394 ret = menelaus_add_irq_work(MENELAUS_MMC_S1D1_IRQ,
395 menelaus_mmc_cd_work);
398 ret = menelaus_add_irq_work(MENELAUS_MMC_S2D1_IRQ,
399 menelaus_mmc_cd_work);
403 EXPORT_SYMBOL(menelaus_register_mmc_callback);
405 void menelaus_unregister_mmc_callback(void)
407 menelaus_remove_irq_work(MENELAUS_MMC_S1CD_IRQ);
408 menelaus_remove_irq_work(MENELAUS_MMC_S2CD_IRQ);
409 menelaus_remove_irq_work(MENELAUS_MMC_S1D1_IRQ);
410 menelaus_remove_irq_work(MENELAUS_MMC_S2D1_IRQ);
412 menelaus.mmc_callback = NULL;
413 menelaus.mmc_callback_data = 0;
415 EXPORT_SYMBOL(menelaus_unregister_mmc_callback);
417 struct menelaus_vtg {
425 struct menelaus_vtg_value {
430 static int menelaus_set_voltage(const struct menelaus_vtg *vtg, int mV,
431 int vtg_val, int mode)
435 mutex_lock(&menelaus.lock);
439 ret = menelaus_read_reg(vtg->vtg_reg);
442 val = ret & ~(((1 << vtg->vtg_bits) - 1) << vtg->vtg_shift);
443 val |= vtg_val << vtg->vtg_shift;
445 printk("menelaus: Setting voltage '%s' to %d mV (reg 0x%02x, val 0x%02x)\n",
446 vtg->name, mV, vtg->vtg_reg, val);
448 ret = menelaus_write_reg(vtg->vtg_reg, val);
452 ret = menelaus_write_reg(vtg->mode_reg, mode);
454 mutex_unlock(&menelaus.lock);
456 /* Wait for voltage to stabilize */
462 static int menelaus_get_vtg_value(int vtg, const struct menelaus_vtg_value *tbl,
467 for (i = 0; i < n; i++, tbl++)
473 static const struct menelaus_vtg vmem_vtg = {
475 .vtg_reg = MENELAUS_LDO_CTRL1,
478 .mode_reg = MENELAUS_LDO_CTRL3,
481 static const struct menelaus_vtg_value vmem_values[] = {
488 int menelaus_set_vmem(unsigned int mV)
493 return menelaus_set_voltage(&vmem_vtg, 0, 0, 0);
495 val = menelaus_get_vtg_value(mV, vmem_values, ARRAY_SIZE(vmem_values));
498 return menelaus_set_voltage(&vmem_vtg, mV, val, 0x02);
500 EXPORT_SYMBOL(menelaus_set_vmem);
502 static const struct menelaus_vtg vio_vtg = {
504 .vtg_reg = MENELAUS_LDO_CTRL1,
507 .mode_reg = MENELAUS_LDO_CTRL4,
510 static const struct menelaus_vtg_value vio_values[] = {
517 int menelaus_set_vio(unsigned int mV)
522 return menelaus_set_voltage(&vio_vtg, 0, 0, 0);
524 val = menelaus_get_vtg_value(mV, vio_values, ARRAY_SIZE(vio_values));
527 return menelaus_set_voltage(&vio_vtg, mV, val, 0x02);
529 EXPORT_SYMBOL(menelaus_set_vio);
531 static const struct menelaus_vtg_value vdcdc_values[] = {
542 static const struct menelaus_vtg vdcdc2_vtg = {
544 .vtg_reg = MENELAUS_DCDC_CTRL1,
547 .mode_reg = MENELAUS_DCDC_CTRL2,
550 static const struct menelaus_vtg vdcdc3_vtg = {
552 .vtg_reg = MENELAUS_DCDC_CTRL1,
555 .mode_reg = MENELAUS_DCDC_CTRL3,
558 int menelaus_set_vdcdc(int dcdc, unsigned int mV)
560 const struct menelaus_vtg *vtg;
563 if (dcdc != 2 && dcdc != 3)
571 return menelaus_set_voltage(vtg, 0, 0, 0);
573 val = menelaus_get_vtg_value(mV, vdcdc_values, ARRAY_SIZE(vdcdc_values));
576 return menelaus_set_voltage(vtg, mV, val, 0x03);
579 static const struct menelaus_vtg_value vmmc_values[] = {
586 static const struct menelaus_vtg vmmc_vtg = {
588 .vtg_reg = MENELAUS_LDO_CTRL1,
591 .mode_reg = MENELAUS_LDO_CTRL7,
594 int menelaus_set_vmmc(unsigned int mV)
599 return menelaus_set_voltage(&vmmc_vtg, 0, 0, 0);
601 val = menelaus_get_vtg_value(mV, vmmc_values, ARRAY_SIZE(vmmc_values));
604 return menelaus_set_voltage(&vmmc_vtg, mV, val, 0x02);
606 EXPORT_SYMBOL(menelaus_set_vmmc);
609 static const struct menelaus_vtg_value vaux_values[] = {
616 static const struct menelaus_vtg vaux_vtg = {
618 .vtg_reg = MENELAUS_LDO_CTRL1,
621 .mode_reg = MENELAUS_LDO_CTRL6,
624 int menelaus_set_vaux(unsigned int mV)
629 return menelaus_set_voltage(&vaux_vtg, 0, 0, 0);
631 val = menelaus_get_vtg_value(mV, vaux_values, ARRAY_SIZE(vaux_values));
634 return menelaus_set_voltage(&vaux_vtg, mV, val, 0x02);
636 EXPORT_SYMBOL(menelaus_set_vaux);
638 int menelaus_get_slot_pin_states(void)
640 return menelaus_read_reg(MENELAUS_MCT_PIN_ST);
642 EXPORT_SYMBOL(menelaus_get_slot_pin_states);
644 /*-----------------------------------------------------------------------*/
646 /* Handles Menelaus interrupts. Does not run in interrupt context */
647 static void menelaus_work(struct work_struct *_menelaus)
649 struct menelaus_chip *menelaus =
650 container_of(_menelaus, struct menelaus_chip, work);
651 int (*handler)(struct menelaus_chip *menelaus);
657 isr = menelaus_read_reg(MENELAUS_INT_STATUS1) |
658 (menelaus_read_reg(MENELAUS_INT_STATUS2) << 8);
663 for (i = 0; i < IH_MENELAUS_IRQS; i++) {
664 if (isr & (1 << i)) {
665 mutex_lock(&menelaus->lock);
666 menelaus_disable_irq(i);
668 if (menelaus->handlers[i]) {
669 handler = menelaus->handlers[i];
672 menelaus_enable_irq(i);
673 mutex_unlock(&menelaus->lock);
677 enable_irq(menelaus->irq);
681 * We cannot use I2C in interrupt context, so we just schedule work.
683 static irqreturn_t menelaus_irq(int irq, void *_menelaus)
685 struct menelaus_chip *menelaus = _menelaus;
687 disable_irq_nosync(irq);
688 (void)schedule_work(&menelaus->work);
693 static struct i2c_driver menelaus_i2c_driver;
695 static int menelaus_probe(struct i2c_adapter *adapter, int address, int kind)
697 struct i2c_client *c;
701 if (test_and_set_bit(0, &menelaus.initialized))
704 c = &menelaus.client;
705 strncpy(c->name, DRIVER_NAME, sizeof(c->name));
707 c->adapter = adapter;
708 c->driver = &menelaus_i2c_driver;
711 if ((err = i2c_attach_client(c)) < 0) {
712 pr_err("couldn't attach\n");
716 /* If a true probe check the device */
717 if (kind < 0 && (rev = menelaus_read_reg(MENELAUS_REV)) < 0) {
718 pr_err("device not found");
723 /* Most likely Menelaus interrupt is at SYS_NIRQ */
724 omap_cfg_reg(W19_24XX_SYS_NIRQ);
725 menelaus.irq = INT_24XX_SYS_NIRQ;
727 /* Ack and disable all Menelaus interrupts */
728 menelaus_write_reg(MENELAUS_INT_ACK1, 0xff);
729 menelaus_write_reg(MENELAUS_INT_ACK2, 0xff);
730 menelaus_write_reg(MENELAUS_INT_MASK1, 0xff);
731 menelaus_write_reg(MENELAUS_INT_MASK2, 0xff);
733 /* Set output buffer strengths */
734 menelaus_write_reg(MENELAUS_MCT_CTRL1, 0x73);
736 err = request_irq(menelaus.irq, menelaus_irq, SA_INTERRUPT,
737 DRIVER_NAME, &menelaus);
739 printk(KERN_ERR "Could not get Menelaus IRQ\n");
743 mutex_init(&menelaus.lock);
744 INIT_WORK(&menelaus.work, menelaus_work);
747 pr_info("Menelaus rev %d.%d\n", rev >> 4, rev & 0x0f);
752 i2c_detach_client(c);
754 clear_bit(0, &menelaus.initialized);
758 static int menelaus_remove(struct i2c_client *client)
762 free_irq(menelaus.irq, &menelaus);
764 if ((err = i2c_detach_client(client))) {
765 pr_err("client deregistration failed\n");
769 clear_bit(0, &menelaus.initialized);
774 /*-----------------------------------------------------------------------*/
776 static int menelaus_scan_bus(struct i2c_adapter *bus)
778 if (!i2c_check_functionality(bus, I2C_FUNC_SMBUS_BYTE_DATA |
779 I2C_FUNC_SMBUS_WRITE_BYTE)) {
780 pr_err("invalid i2c bus functionality\n");
784 return i2c_probe(bus, &addr_data, menelaus_probe);
787 static struct i2c_driver menelaus_i2c_driver = {
791 .id = I2C_DRIVERID_MISC, /*FIXME:accroding to i2c-ids.h */
792 .class = I2C_CLASS_HWMON,
793 .attach_adapter = menelaus_scan_bus,
794 .detach_client = menelaus_remove,
797 static int __init menelaus_init(void)
801 if ((res = i2c_add_driver(&menelaus_i2c_driver)) < 0) {
802 pr_err("driver registration failed\n");
809 static void __exit menelaus_exit(void)
811 if (i2c_del_driver(&menelaus_i2c_driver) < 0)
812 pr_err("driver remove failed\n");
814 /* FIXME: Shutdown menelaus parts that can be shut down */
817 MODULE_AUTHOR("Texas Instruments, Inc.");
818 MODULE_DESCRIPTION("I2C interface for Menelaus.");
819 MODULE_LICENSE("GPL");
821 module_init(menelaus_init);
822 module_exit(menelaus_exit);