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>
40 #include <asm/mach-types.h>
41 #include <asm/mach/irq.h>
43 #include <asm/arch/mux.h>
44 #include <asm/arch/gpio.h>
45 #include <asm/arch/menelaus.h>
49 #define DRIVER_NAME "menelaus"
51 #define pr_err(fmt, arg...) printk(KERN_ERR DRIVER_NAME ": ", ## arg);
53 #define MENELAUS_I2C_ADDRESS 0x72
55 #define MENELAUS_REV 0x01
56 #define MENELAUS_VCORE_CTRL1 0x02
57 #define MENELAUS_VCORE_CTRL2 0x03
58 #define MENELAUS_VCORE_CTRL3 0x04
59 #define MENELAUS_VCORE_CTRL4 0x05
60 #define MENELAUS_VCORE_CTRL5 0x06
61 #define MENELAUS_DCDC_CTRL1 0x07
62 #define MENELAUS_DCDC_CTRL2 0x08
63 #define MENELAUS_DCDC_CTRL3 0x09
64 #define MENELAUS_LDO_CTRL1 0x0A
65 #define MENELAUS_LDO_CTRL2 0x0B
66 #define MENELAUS_LDO_CTRL3 0x0C
67 #define MENELAUS_LDO_CTRL4 0x0D
68 #define MENELAUS_LDO_CTRL5 0x0E
69 #define MENELAUS_LDO_CTRL6 0x0F
70 #define MENELAUS_LDO_CTRL7 0x10
71 #define MENELAUS_LDO_CTRL8 0x11
72 #define MENELAUS_SLEEP_CTRL1 0x12
73 #define MENELAUS_SLEEP_CTRL2 0x13
74 #define MENELAUS_DEVICE_OFF 0x14
75 #define MENELAUS_OSC_CTRL 0x15
76 #define MENELAUS_DETECT_CTRL 0x16
77 #define MENELAUS_INT_MASK1 0x17
78 #define MENELAUS_INT_MASK2 0x18
79 #define MENELAUS_INT_STATUS1 0x19
80 #define MENELAUS_INT_STATUS2 0x1A
81 #define MENELAUS_INT_ACK1 0x1B
82 #define MENELAUS_INT_ACK2 0x1C
83 #define MENELAUS_GPIO_CTRL 0x1D
84 #define MENELAUS_GPIO_IN 0x1E
85 #define MENELAUS_GPIO_OUT 0x1F
86 #define MENELAUS_BBSMS 0x20
87 #define MENELAUS_RTC_CTRL 0x21
88 #define MENELAUS_RTC_UPDATE 0x22
89 #define MENELAUS_RTC_SEC 0x23
90 #define MENELAUS_RTC_MIN 0x24
91 #define MENELAUS_RTC_HR 0x25
92 #define MENELAUS_RTC_DAY 0x26
93 #define MENELAUS_RTC_MON 0x27
94 #define MENELAUS_RTC_YR 0x28
95 #define MENELAUS_RTC_WKDAY 0x29
96 #define MENELAUS_RTC_AL_SEC 0x2A
97 #define MENELAUS_RTC_AL_MIN 0x2B
98 #define MENELAUS_RTC_AL_HR 0x2C
99 #define MENELAUS_RTC_AL_DAY 0x2D
100 #define MENELAUS_RTC_AL_MON 0x2E
101 #define MENELAUS_RTC_AL_YR 0x2F
102 #define MENELAUS_RTC_COMP_MSB 0x30
103 #define MENELAUS_RTC_COMP_LSB 0x31
104 #define MENELAUS_S1_PULL_EN 0x32
105 #define MENELAUS_S1_PULL_DIR 0x33
106 #define MENELAUS_S2_PULL_EN 0x34
107 #define MENELAUS_S2_PULL_DIR 0x35
108 #define MENELAUS_MCT_CTRL1 0x36
109 #define MENELAUS_MCT_CTRL2 0x37
110 #define MENELAUS_MCT_CTRL3 0x38
111 #define MENELAUS_MCT_PIN_ST 0x39
112 #define MENELAUS_DEBOUNCE1 0x3A
114 #define IH_MENELAUS_IRQS 12
115 #define MENELAUS_MMC_S1CD_IRQ 0 /* MMC slot 1 card change */
116 #define MENELAUS_MMC_S2CD_IRQ 1 /* MMC slot 2 card change */
117 #define MENELAUS_MMC_S1D1_IRQ 2 /* MMC DAT1 low in slot 1 */
118 #define MENELAUS_MMC_S2D1_IRQ 3 /* MMC DAT1 low in slot 2 */
119 #define MENELAUS_LOWBAT_IRQ 4 /* Low battery */
120 #define MENELAUS_HOTDIE_IRQ 5 /* Hot die detect */
121 #define MENELAUS_UVLO_IRQ 6 /* UVLO detect */
122 #define MENELAUS_TSHUT_IRQ 7 /* Thermal shutdown */
123 #define MENELAUS_RTCTMR_IRQ 8 /* RTC timer */
124 #define MENELAUS_RTCALM_IRQ 9 /* RTC alarm */
125 #define MENELAUS_RTCERR_IRQ 10 /* RTC error */
126 #define MENELAUS_PSHBTN_IRQ 11 /* Push button */
127 #define MENELAUS_RESERVED12_IRQ 12 /* Reserved */
128 #define MENELAUS_RESERVED13_IRQ 13 /* Reserved */
129 #define MENELAUS_RESERVED14_IRQ 14 /* Reserved */
130 #define MENELAUS_RESERVED15_IRQ 15 /* Reserved */
132 static void menelaus_work(void * _menelaus);
134 /* Initialized by menelaus_init */
135 static unsigned short normal_i2c[] = { MENELAUS_I2C_ADDRESS, I2C_CLIENT_END };
139 struct menelaus_chip {
140 unsigned long initialized;
142 struct i2c_client client;
143 struct work_struct work;
146 void (*mmc_callback)(void *data, u8 mask);
147 void *mmc_callback_data;
150 static struct menelaus_chip menelaus;
152 static int menelaus_write_reg(int reg, u8 value)
154 int val = i2c_smbus_write_byte_data(&menelaus.client, reg, value);
157 pr_err("write error");
164 static int menelaus_read_reg(int reg)
166 int val = i2c_smbus_read_byte_data(&menelaus.client, reg);
169 pr_err("read error");
174 static int menelaus_enable_irq(int irq)
177 return menelaus_write_reg(MENELAUS_INT_MASK2,
178 menelaus_read_reg(MENELAUS_INT_MASK2)
179 & ~(1 << (irq - 8)));
181 return menelaus_write_reg(MENELAUS_INT_MASK1,
182 menelaus_read_reg(MENELAUS_INT_MASK1)
186 static int menelaus_disable_irq(int irq)
189 return menelaus_write_reg(menelaus_read_reg(MENELAUS_INT_MASK2)
193 return menelaus_write_reg(MENELAUS_INT_MASK1,
194 menelaus_read_reg(MENELAUS_INT_MASK1)
198 static int menelaus_ack_irq(int irq)
201 return menelaus_write_reg(MENELAUS_INT_ACK2, 1 << (irq - 8));
203 return menelaus_write_reg(MENELAUS_INT_ACK1, 1 << irq);
206 /* Adds a handler for an interrupt. Does not run in interrupt context */
207 static int menelaus_add_irq_work(int irq, void * handler)
211 mutex_lock(&menelaus.lock);
212 menelaus.handlers[irq] = handler;
213 ret = menelaus_enable_irq(irq);
214 mutex_unlock(&menelaus.lock);
219 /* Removes handler for an interrupt */
220 static int menelaus_remove_irq_work(int irq)
224 mutex_lock(&menelaus.lock);
225 ret = menelaus_disable_irq(irq);
226 menelaus.handlers[irq] = NULL;
227 mutex_unlock(&menelaus.lock);
233 * Gets scheduled when a card detect interrupt happens. Note that in some cases
234 * this line is wired to card cover switch rather than the card detect switch
235 * in each slot. In this case the cards are not seen by menelaus.
236 * FIXME: Add handling for D1 too
238 static int menelaus_mmc_cd_work(struct menelaus_chip * menelaus_hw)
241 unsigned char card_mask = 0;
243 reg = menelaus_read_reg(MENELAUS_MCT_PIN_ST);
248 card_mask |= (1 << 0);
251 card_mask |= (1 << 1);
253 if (menelaus_hw->mmc_callback)
254 menelaus_hw->mmc_callback(menelaus_hw->mmc_callback_data,
261 * Toggles the MMC slots between open-drain and push-pull mode.
263 int menelaus_set_mmc_opendrain(int slot, int enable)
267 if (slot != 1 && slot != 2)
269 mutex_lock(&menelaus.lock);
270 ret = menelaus_read_reg(MENELAUS_MCT_CTRL1);
272 mutex_unlock(&menelaus.lock);
287 ret = menelaus_write_reg(MENELAUS_MCT_CTRL1, val);
288 mutex_unlock(&menelaus.lock);
292 EXPORT_SYMBOL(menelaus_set_mmc_opendrain);
294 int menelaus_set_slot_sel(int enable)
298 mutex_lock(&menelaus.lock);
299 ret = menelaus_read_reg(MENELAUS_GPIO_CTRL);
307 ret = menelaus_write_reg(MENELAUS_GPIO_CTRL, ret);
309 mutex_unlock(&menelaus.lock);
312 EXPORT_SYMBOL(menelaus_set_slot_sel);
314 int menelaus_set_mmc_slot(int slot, int enable, int power, int cd_en)
318 if (slot != 1 && slot != 2)
323 mutex_lock(&menelaus.lock);
325 ret = menelaus_read_reg(MENELAUS_MCT_CTRL2);
331 val |= (1 << 4) | (1 << 6);
333 val &= ~((1 << 4) | (1 << 6));
336 val |= (1 << 5) | (1 << 7);
338 val &= ~((1 << 5) | (1 << 7));
340 ret = menelaus_write_reg(MENELAUS_MCT_CTRL2, val);
344 ret = menelaus_read_reg(MENELAUS_MCT_CTRL3);
360 b = menelaus_read_reg(MENELAUS_MCT_CTRL2);
363 ret = menelaus_write_reg(MENELAUS_MCT_CTRL2, b);
367 /* Disable autonomous shutdown */
369 ret = menelaus_write_reg(MENELAUS_MCT_CTRL3, val);
371 mutex_unlock(&menelaus.lock);
374 EXPORT_SYMBOL(menelaus_set_mmc_slot);
376 #include <linux/delay.h>
378 int menelaus_register_mmc_callback(void (*callback)(void *data, u8 card_mask),
383 menelaus.mmc_callback_data = data;
384 menelaus.mmc_callback = callback;
385 ret = menelaus_add_irq_work(MENELAUS_MMC_S1CD_IRQ,
386 menelaus_mmc_cd_work);
389 ret = menelaus_add_irq_work(MENELAUS_MMC_S2CD_IRQ,
390 menelaus_mmc_cd_work);
393 ret = menelaus_add_irq_work(MENELAUS_MMC_S1D1_IRQ,
394 menelaus_mmc_cd_work);
397 ret = menelaus_add_irq_work(MENELAUS_MMC_S2D1_IRQ,
398 menelaus_mmc_cd_work);
402 EXPORT_SYMBOL(menelaus_register_mmc_callback);
404 void menelaus_unregister_mmc_callback(void)
406 menelaus_remove_irq_work(MENELAUS_MMC_S1CD_IRQ);
407 menelaus_remove_irq_work(MENELAUS_MMC_S2CD_IRQ);
408 menelaus_remove_irq_work(MENELAUS_MMC_S1D1_IRQ);
409 menelaus_remove_irq_work(MENELAUS_MMC_S2D1_IRQ);
411 menelaus.mmc_callback = NULL;
412 menelaus.mmc_callback_data = 0;
414 EXPORT_SYMBOL(menelaus_unregister_mmc_callback);
416 struct menelaus_vtg {
424 struct menelaus_vtg_value {
429 static int menelaus_set_voltage(const struct menelaus_vtg *vtg, int mV,
430 int vtg_val, int mode)
434 mutex_lock(&menelaus.lock);
438 ret = menelaus_read_reg(vtg->vtg_reg);
441 val = ret & ~(((1 << vtg->vtg_bits) - 1) << vtg->vtg_shift);
442 val |= vtg_val << vtg->vtg_shift;
444 printk("menelaus: Setting voltage '%s' to %d mV (reg 0x%02x, val 0x%02x)\n",
445 vtg->name, mV, vtg->vtg_reg, val);
447 ret = menelaus_write_reg(vtg->vtg_reg, val);
451 ret = menelaus_write_reg(vtg->mode_reg, mode);
453 mutex_unlock(&menelaus.lock);
455 /* Wait for voltage to stabilize */
461 static int menelaus_get_vtg_value(int vtg, const struct menelaus_vtg_value *tbl,
466 for (i = 0; i < n; i++, tbl++)
472 static const struct menelaus_vtg vmem_vtg = {
474 .vtg_reg = MENELAUS_LDO_CTRL1,
477 .mode_reg = MENELAUS_LDO_CTRL3,
480 static const struct menelaus_vtg_value vmem_values[] = {
487 int menelaus_set_vmem(unsigned int mV)
492 return menelaus_set_voltage(&vmem_vtg, 0, 0, 0);
494 val = menelaus_get_vtg_value(mV, vmem_values, ARRAY_SIZE(vmem_values));
497 return menelaus_set_voltage(&vmem_vtg, mV, val, 0x02);
499 EXPORT_SYMBOL(menelaus_set_vmem);
501 static const struct menelaus_vtg vio_vtg = {
503 .vtg_reg = MENELAUS_LDO_CTRL1,
506 .mode_reg = MENELAUS_LDO_CTRL4,
509 static const struct menelaus_vtg_value vio_values[] = {
516 int menelaus_set_vio(unsigned int mV)
521 return menelaus_set_voltage(&vio_vtg, 0, 0, 0);
523 val = menelaus_get_vtg_value(mV, vio_values, ARRAY_SIZE(vio_values));
526 return menelaus_set_voltage(&vio_vtg, mV, val, 0x02);
528 EXPORT_SYMBOL(menelaus_set_vio);
530 static const struct menelaus_vtg_value vdcdc_values[] = {
541 static const struct menelaus_vtg vdcdc2_vtg = {
543 .vtg_reg = MENELAUS_DCDC_CTRL1,
546 .mode_reg = MENELAUS_DCDC_CTRL2,
549 static const struct menelaus_vtg vdcdc3_vtg = {
551 .vtg_reg = MENELAUS_DCDC_CTRL1,
554 .mode_reg = MENELAUS_DCDC_CTRL3,
557 int menelaus_set_vdcdc(int dcdc, unsigned int mV)
559 const struct menelaus_vtg *vtg;
562 if (dcdc != 2 && dcdc != 3)
570 return menelaus_set_voltage(vtg, 0, 0, 0);
572 val = menelaus_get_vtg_value(mV, vdcdc_values, ARRAY_SIZE(vdcdc_values));
575 return menelaus_set_voltage(vtg, mV, val, 0x03);
578 static const struct menelaus_vtg_value vmmc_values[] = {
585 static const struct menelaus_vtg vmmc_vtg = {
587 .vtg_reg = MENELAUS_LDO_CTRL1,
590 .mode_reg = MENELAUS_LDO_CTRL7,
593 int menelaus_set_vmmc(unsigned int mV)
598 return menelaus_set_voltage(&vmmc_vtg, 0, 0, 0);
600 val = menelaus_get_vtg_value(mV, vmmc_values, ARRAY_SIZE(vmmc_values));
603 return menelaus_set_voltage(&vmmc_vtg, mV, val, 0x02);
605 EXPORT_SYMBOL(menelaus_set_vmmc);
608 static const struct menelaus_vtg_value vaux_values[] = {
615 static const struct menelaus_vtg vaux_vtg = {
617 .vtg_reg = MENELAUS_LDO_CTRL1,
620 .mode_reg = MENELAUS_LDO_CTRL6,
623 int menelaus_set_vaux(unsigned int mV)
628 return menelaus_set_voltage(&vaux_vtg, 0, 0, 0);
630 val = menelaus_get_vtg_value(mV, vaux_values, ARRAY_SIZE(vaux_values));
633 return menelaus_set_voltage(&vaux_vtg, mV, val, 0x02);
635 EXPORT_SYMBOL(menelaus_set_vaux);
637 int menelaus_get_slot_pin_states(void)
639 return menelaus_read_reg(MENELAUS_MCT_PIN_ST);
641 EXPORT_SYMBOL(menelaus_get_slot_pin_states);
643 /*-----------------------------------------------------------------------*/
645 /* Handles Menelaus interrupts. Does not run in interrupt context */
646 static void menelaus_work(void * _menelaus)
648 struct menelaus_chip *menelaus = _menelaus;
649 int (*handler)(struct menelaus_chip *menelaus);
655 isr = menelaus_read_reg(MENELAUS_INT_STATUS1) |
656 (menelaus_read_reg(MENELAUS_INT_STATUS2) << 8);
661 for (i = 0; i < IH_MENELAUS_IRQS; i++) {
662 if (isr & (1 << i)) {
663 mutex_lock(&menelaus->lock);
664 menelaus_disable_irq(i);
666 if (menelaus->handlers[i]) {
667 handler = menelaus->handlers[i];
670 menelaus_enable_irq(i);
671 mutex_unlock(&menelaus->lock);
675 enable_irq(menelaus->irq);
679 * We cannot use I2C in interrupt context, so we just schedule work.
681 static irqreturn_t menelaus_irq(int irq, void *_menelaus, struct pt_regs *regs)
683 struct menelaus_chip *menelaus = _menelaus;
685 disable_irq_nosync(irq);
686 (void)schedule_work(&menelaus->work);
691 static struct i2c_driver menelaus_i2c_driver;
693 static int menelaus_probe(struct i2c_adapter *adapter, int address, int kind)
695 struct i2c_client *c;
699 if (test_and_set_bit(0, &menelaus.initialized))
702 c = &menelaus.client;
703 strncpy(c->name, DRIVER_NAME, sizeof(c->name));
705 c->adapter = adapter;
706 c->driver = &menelaus_i2c_driver;
709 if ((err = i2c_attach_client(c)) < 0) {
710 pr_err("couldn't attach\n");
714 /* If a true probe check the device */
715 if (kind < 0 && (rev = menelaus_read_reg(MENELAUS_REV)) < 0) {
716 pr_err("device not found");
721 /* Most likely Menelaus interrupt is at SYS_NIRQ */
722 omap_cfg_reg(W19_24XX_SYS_NIRQ);
723 menelaus.irq = INT_24XX_SYS_NIRQ;
725 /* Ack and disable all Menelaus interrupts */
726 menelaus_write_reg(MENELAUS_INT_ACK1, 0xff);
727 menelaus_write_reg(MENELAUS_INT_ACK2, 0xff);
728 menelaus_write_reg(MENELAUS_INT_MASK1, 0xff);
729 menelaus_write_reg(MENELAUS_INT_MASK2, 0xff);
731 /* Set output buffer strengths */
732 menelaus_write_reg(MENELAUS_MCT_CTRL1, 0x73);
734 err = request_irq(menelaus.irq, menelaus_irq, SA_INTERRUPT,
735 DRIVER_NAME, &menelaus);
737 printk(KERN_ERR "Could not get Menelaus IRQ\n");
741 mutex_init(&menelaus.lock);
742 INIT_WORK(&menelaus.work, menelaus_work, &menelaus);
745 pr_info("Menelaus rev %d.%d\n", rev >> 4, rev & 0x0f);
750 i2c_detach_client(c);
752 clear_bit(0, &menelaus.initialized);
756 static int menelaus_remove(struct i2c_client *client)
760 free_irq(menelaus.irq, &menelaus);
762 if ((err = i2c_detach_client(client))) {
763 pr_err("client deregistration failed\n");
767 clear_bit(0, &menelaus.initialized);
772 /*-----------------------------------------------------------------------*/
774 static int menelaus_scan_bus(struct i2c_adapter *bus)
776 if (!i2c_check_functionality(bus, I2C_FUNC_SMBUS_BYTE_DATA |
777 I2C_FUNC_SMBUS_WRITE_BYTE)) {
778 pr_err("invalid i2c bus functionality\n");
782 return i2c_probe(bus, &addr_data, menelaus_probe);
785 static struct i2c_driver menelaus_i2c_driver = {
789 .id = I2C_DRIVERID_MISC, /*FIXME:accroding to i2c-ids.h */
790 .class = I2C_CLASS_HWMON,
791 .attach_adapter = menelaus_scan_bus,
792 .detach_client = menelaus_remove,
795 static int __init menelaus_init(void)
799 if ((res = i2c_add_driver(&menelaus_i2c_driver)) < 0) {
800 pr_err("driver registration failed\n");
807 static void __exit menelaus_exit(void)
809 if (i2c_del_driver(&menelaus_i2c_driver) < 0)
810 pr_err("driver remove failed\n");
812 /* FIXME: Shutdown menelaus parts that can be shut down */
815 MODULE_AUTHOR("Texas Instruments, Inc.");
816 MODULE_DESCRIPTION("I2C interface for Menelaus.");
817 MODULE_LICENSE("GPL");
819 module_init(menelaus_init);
820 module_exit(menelaus_exit);