blob: e0eb4ca0102e613130702757b7add12dd99bd05a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * i2c-pca-isa.c driver for PCA9564 on ISA boards
3 * Copyright (C) 2004 Arcom Control Systems
Wolfram Sangc01b0832008-04-22 22:16:46 +02004 * Copyright (C) 2008 Pengutronix
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 */
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/kernel.h>
18#include <linux/ioport.h>
19#include <linux/module.h>
20#include <linux/moduleparam.h>
21#include <linux/delay.h>
Wolfram Sang2378bc02009-03-28 21:34:45 +010022#include <linux/jiffies.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/init.h>
24#include <linux/interrupt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/wait.h>
Jean Delvare5cedb052007-05-01 23:26:30 +020026#include <linux/isa.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/i2c.h>
28#include <linux/i2c-algo-pca.h>
H Hartley Sweeten21782182010-05-21 18:41:01 +020029#include <linux/io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <asm/irq.h>
32
Wolfram Sangc01b0832008-04-22 22:16:46 +020033#define DRIVER "i2c-pca-isa"
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#define IO_SIZE 4
35
Rene Hermance564032008-10-14 17:30:03 +020036static unsigned long base;
37static int irq = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39/* Data sheet recommends 59kHz for 100kHz operation due to variation
40 * in the actual clock rate */
Marco Aurelio da Costaeff9ec92009-03-28 21:34:44 +010041static int clock = 59000;
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Wolfram Sang2378bc02009-03-28 21:34:45 +010043static struct i2c_adapter pca_isa_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044static wait_queue_head_t pca_wait;
45
Wolfram Sangc01b0832008-04-22 22:16:46 +020046static void pca_isa_writebyte(void *pd, int reg, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -070047{
48#ifdef DEBUG_IO
49 static char *names[] = { "T/O", "DAT", "ADR", "CON" };
Frank Seidel154d22b2009-03-28 21:34:42 +010050 printk(KERN_DEBUG "*** write %s at %#lx <= %#04x\n", names[reg],
51 base+reg, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#endif
53 outb(val, base+reg);
54}
55
Wolfram Sangc01b0832008-04-22 22:16:46 +020056static int pca_isa_readbyte(void *pd, int reg)
Linus Torvalds1da177e2005-04-16 15:20:36 -070057{
58 int res = inb(base+reg);
59#ifdef DEBUG_IO
60 {
Wolfram Sang3d438292008-04-22 22:16:46 +020061 static char *names[] = { "STA", "DAT", "ADR", "CON" };
Frank Seidel154d22b2009-03-28 21:34:42 +010062 printk(KERN_DEBUG "*** read %s => %#04x\n", names[reg], res);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 }
64#endif
65 return res;
66}
67
Wolfram Sangc01b0832008-04-22 22:16:46 +020068static int pca_isa_waitforcompletion(void *pd)
Linus Torvalds1da177e2005-04-16 15:20:36 -070069{
Wolfram Sang2378bc02009-03-28 21:34:45 +010070 unsigned long timeout;
Yegor Yefremov6abb9302010-09-30 14:14:22 +020071 long ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
73 if (irq > -1) {
Wolfram Sang22f8b262010-01-16 20:43:13 +010074 ret = wait_event_timeout(pca_wait,
Wolfram Sang2378bc02009-03-28 21:34:45 +010075 pca_isa_readbyte(pd, I2C_PCA_CON)
76 & I2C_PCA_CON_SI, pca_isa_ops.timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 } else {
Wolfram Sang2378bc02009-03-28 21:34:45 +010078 /* Do polling */
79 timeout = jiffies + pca_isa_ops.timeout;
Yegor Yefremov6abb9302010-09-30 14:14:22 +020080 do {
81 ret = time_before(jiffies, timeout);
82 if (pca_isa_readbyte(pd, I2C_PCA_CON)
83 & I2C_PCA_CON_SI)
84 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 udelay(100);
Yegor Yefremov6abb9302010-09-30 14:14:22 +020086 } while (ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 }
Yegor Yefremov6abb9302010-09-30 14:14:22 +020088
Wolfram Sang2378bc02009-03-28 21:34:45 +010089 return ret > 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090}
91
Wolfram Sangc01b0832008-04-22 22:16:46 +020092static void pca_isa_resetchip(void *pd)
93{
94 /* apparently only an external reset will do it. not a lot can be done */
95 printk(KERN_WARNING DRIVER ": Haven't figured out how to do a reset yet\n");
96}
97
David Howells7d12e782006-10-05 14:55:46 +010098static irqreturn_t pca_handler(int this_irq, void *dev_id) {
Wolfram Sang22f8b262010-01-16 20:43:13 +010099 wake_up(&pca_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 return IRQ_HANDLED;
101}
102
103static struct i2c_algo_pca_data pca_isa_data = {
Wolfram Sangc01b0832008-04-22 22:16:46 +0200104 /* .data intentionally left NULL, not needed with ISA */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 .write_byte = pca_isa_writebyte,
106 .read_byte = pca_isa_readbyte,
Wolfram Sangc01b0832008-04-22 22:16:46 +0200107 .wait_for_completion = pca_isa_waitforcompletion,
108 .reset_chip = pca_isa_resetchip,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109};
110
111static struct i2c_adapter pca_isa_ops = {
112 .owner = THIS_MODULE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 .algo_data = &pca_isa_data,
Marco Aurelio da Costaeff9ec92009-03-28 21:34:44 +0100114 .name = "PCA9564/PCA9665 ISA Adapter",
Wolfram Sang8e99ada2009-03-28 21:34:45 +0100115 .timeout = HZ,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116};
117
Bill Pemberton0b255e92012-11-27 15:59:38 -0500118static int pca_isa_match(struct device *dev, unsigned int id)
Rene Hermance564032008-10-14 17:30:03 +0200119{
120 int match = base != 0;
121
122 if (match) {
123 if (irq <= -1)
124 dev_warn(dev, "Using polling mode (specify irq)\n");
125 } else
126 dev_err(dev, "Please specify I/O base\n");
127
128 return match;
129}
130
Bill Pemberton0b255e92012-11-27 15:59:38 -0500131static int pca_isa_probe(struct device *dev, unsigned int id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 init_waitqueue_head(&pca_wait);
134
Jean Delvare5cedb052007-05-01 23:26:30 +0200135 dev_info(dev, "i/o base %#08lx. irq %d\n", base, irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Kumar Gala68e1ee62008-09-22 14:41:31 -0700137#ifdef CONFIG_PPC
Christian Krafft104cb572008-02-24 20:03:42 +0100138 if (check_legacy_ioport(base)) {
139 dev_err(dev, "I/O address %#08lx is not available\n", base);
140 goto out;
141 }
142#endif
143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 if (!request_region(base, IO_SIZE, "i2c-pca-isa")) {
Jean Delvare5cedb052007-05-01 23:26:30 +0200145 dev_err(dev, "I/O address %#08lx is in use\n", base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 goto out;
147 }
148
149 if (irq > -1) {
150 if (request_irq(irq, pca_handler, 0, "i2c-pca-isa", &pca_isa_ops) < 0) {
Jean Delvare5cedb052007-05-01 23:26:30 +0200151 dev_err(dev, "Request irq%d failed\n", irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 goto out_region;
153 }
154 }
155
Wolfram Sangc01b0832008-04-22 22:16:46 +0200156 pca_isa_data.i2c_clock = clock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 if (i2c_pca_add_bus(&pca_isa_ops) < 0) {
Jean Delvare5cedb052007-05-01 23:26:30 +0200158 dev_err(dev, "Failed to add i2c bus\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 goto out_irq;
160 }
161
162 return 0;
163
164 out_irq:
165 if (irq > -1)
166 free_irq(irq, &pca_isa_ops);
167 out_region:
168 release_region(base, IO_SIZE);
169 out:
170 return -ENODEV;
171}
172
Bill Pemberton0b255e92012-11-27 15:59:38 -0500173static int pca_isa_remove(struct device *dev, unsigned int id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174{
Jean Delvare32697112006-12-10 21:21:33 +0100175 i2c_del_adapter(&pca_isa_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Rene Hermance564032008-10-14 17:30:03 +0200177 if (irq > -1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 disable_irq(irq);
179 free_irq(irq, &pca_isa_ops);
180 }
181 release_region(base, IO_SIZE);
Jean Delvare5cedb052007-05-01 23:26:30 +0200182
183 return 0;
184}
185
186static struct isa_driver pca_isa_driver = {
Rene Hermance564032008-10-14 17:30:03 +0200187 .match = pca_isa_match,
Jean Delvare5cedb052007-05-01 23:26:30 +0200188 .probe = pca_isa_probe,
Bill Pemberton0b255e92012-11-27 15:59:38 -0500189 .remove = pca_isa_remove,
Jean Delvare5cedb052007-05-01 23:26:30 +0200190 .driver = {
191 .owner = THIS_MODULE,
Wolfram Sangc01b0832008-04-22 22:16:46 +0200192 .name = DRIVER,
Jean Delvare5cedb052007-05-01 23:26:30 +0200193 }
194};
195
196static int __init pca_isa_init(void)
197{
198 return isa_register_driver(&pca_isa_driver, 1);
199}
200
201static void __exit pca_isa_exit(void)
202{
203 isa_unregister_driver(&pca_isa_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204}
205
206MODULE_AUTHOR("Ian Campbell <icampbell@arcom.com>");
Marco Aurelio da Costaeff9ec92009-03-28 21:34:44 +0100207MODULE_DESCRIPTION("ISA base PCA9564/PCA9665 driver");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208MODULE_LICENSE("GPL");
209
210module_param(base, ulong, 0);
211MODULE_PARM_DESC(base, "I/O base address");
212
213module_param(irq, int, 0);
214MODULE_PARM_DESC(irq, "IRQ");
215module_param(clock, int, 0);
Marco Aurelio da Costaeff9ec92009-03-28 21:34:44 +0100216MODULE_PARM_DESC(clock, "Clock rate in hertz.\n\t\t"
217 "For PCA9564: 330000,288000,217000,146000,"
218 "88000,59000,44000,36000\n"
219 "\t\tFor PCA9665:\tStandard: 60300 - 100099\n"
220 "\t\t\t\tFast: 100100 - 400099\n"
221 "\t\t\t\tFast+: 400100 - 10000099\n"
222 "\t\t\t\tTurbo: Up to 1265800");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224module_init(pca_isa_init);
225module_exit(pca_isa_exit);